Repository navigation
[QUESTION] Inconsistent definition of version prefix #690
Description
Is there an existing issue for this?
- I have searched the existing issues
Current Behavior
The readme contains the following about "Versions":
"A leading "=" or "v" character is stripped off and ignored."
Currently, 1.2.3 and v1.2.3 are valid versions. However, =1.2.3 is not a valid version (it is a valid equal-range).
Lines 115 to 117 in ac9b357
Expected Behavior
"=" should be added as a valid prefix for versions.
Versions inside a range allow "=", "v", and "v=" as prefixes (see #689). It therefore makes sense to allow the same for individual versions.
Suggested change (after #689):
createToken('FULLPLAIN', `v?${src[t.MAINVERSION]}${src[t.PRERELEASE]}?${src[t.BUILD]}?`) // old
createToken('FULLPLAIN', `${src[t.PREFIX]}${src[t.MAINVERSION]}${src[t.PRERELEASE]}?${src[t.BUILD]}?`) // newSteps To Reproduce
valid('1.2.3') // 1.2.3
valid('v1.2.3') // 1.2.3
valid('=1.2.3') // null
valid('v=1.2.3') // nullEnvironment
- node-semver: 7.6.0
Activity
wraithgar commentedon Mar 20, 2024
The reason
vis removed has more to do w/ how this module grew up alongside npm itself than anything else. Folks would include that in theirpackage.jsonfor theversionfield. This was mostly due to the fact that npm added thevwhen outputting the version to the console, and also because it was added to the git tag for a given version.=/v=does not have that same history so there is no need to support it. We are trying to move away from "helpfully" altering user data, and instead erroring and having them fix it. Guessing what the user wanted leads to unforeseen bugs.mbtools commentedon Mar 20, 2024
I fully agree with supporting just
vBut a) The readme says otherwise, and b) with a range it support
=/v=(and crap likevv==v) as well.I'm happy to update the docs and #689 to allow only a single, optional
vin ranges but that's probably a breaking-change. Just comment on #689.wraithgar commentedon Mar 20, 2024
Oh by all means let's make the docs reflect reality! Thanks for all the recent PRs.