Repository navigation
docs: clarify prerelease precedence in comparisons - #947
Open
Doomguy-BFG9000 wants to merge 1 commit into
Open
Doomguy-BFG9000 wants to merge 1 commit into
Doomguy-BFG9000 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The comparison documentation did not explicitly say whether
includePrerelease: falsediscards prerelease identifiers. This led to the expectation in #483 thatlt('0.2.0-1', '0.2.0', { includePrerelease: false })should return false.Explain that comparisons use full SemVer precedence regardless of this option, show the reported example, and direct readers to range-matching functions for controlling prerelease admission. This documents existing behavior.
Refs #483.
Validation on Windows with Node.js 25.2.1:
npm test -- --jobs=2passes, including coverage, ESLint andtemplate-oss-check.lt,compareandeqwith both option values, plus the range-matching distinction.git diff --checkpasses.