docs: clarify npm version behavior with prerelease versions #8735
+1
−1
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.
Summary
This PR clarifies the documentation for
npm versionto explicitly describe its behavior when the current version is a prerelease version.Problem
The current documentation states that when using
patch,minor, ormajorarguments, "the existing version will be incremented by 1 in the specified field." However, this is incomplete and misleading when the current version is a prerelease.When the current version is a prerelease (e.g.,
1.2.0-5), runningnpm version patch(orminor/major) will simply remove the prerelease suffix without incrementing the version number. The result would be1.2.0, not1.2.1.This undocumented behavior has led to:
Solution
Added a note immediately after the existing sentence to clarify this behavior:
Testing
The documentation change is straightforward and doesn't affect code behavior. The example provided matches the actual behavior of the
semver.incfunction from the node-semver package.Fixes #8637