Repository navigation
feat: Clarify semantic versioning usage example in package.json - #2068
Open
tazokuetep24 wants to merge 1 commit into
Open
tazokuetep24 wants to merge 1 commit into
tazokuetep24 wants to merge 1 commit into
Conversation
Updated the explanation of specifying acceptable version ranges for dependencies in the package.json file.
|
/ |
This branch has not been deployed
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
2 participants
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.
Updated the explanation of specifying acceptable version ranges for dependencies in the package.json file.
The request aims to clarify the choosing of version ranges using semver in the packag.json. In the current example, it ambiguously says that it defines version ranges up to 1.0.4 and then goes on to list version ranges that start from 1.0.4. A reader (like me) might then think that a Minor release version range such as ^1.0.4 shoul only take versions below 1.0.4 up to this version. Which is not the case.
In the reformulated text, I attempt to make this distinciton clearer, by adding examples of the versions that are to be expected when a particular version range is used. I believe it helps reconcile with the results delivered be the npm semver calculator which is linked following the example
References