[ENHANCMENT] Add explicit "release" identifier to inc function to strip prerelease suffix from the version.

[deej-io]

I have been building a release process for one of my projects using npm-version and wanted to promote a prerelease version to a full version and it wasn't immediately obvious how to do that.

After delving into the code, I found that patch effectively does what I want, however I think this is confusing and potentially error-prone when running the command in a context where we don't know whether the current version is a pre-release or not - e.g. in a CI job.

I think it would be beneficial to have a release increment identifier that strips the prerelease suffix from the version. This is different from the patch identifier in that it does not bump the patch version in the case where there is no prerelease suffix.

Instead, this identifier could either:

• Emit an error that the the current version is not a pre-release; or
• Return the version unmodified

I would personally prefer it to return an error, however I am open to reasons why a no-op would be better.

I am happy to implement this and propagate the change up to npm-version.

[wraithgar]

This seems very discrete and user-friendly. So the idea is that npm could then support npm version release?

One of the biggest lessons I've learned in maintaining npm is that it's always best to be explicit and never guess user intent. With that in mind I'd lean towards throwing if the version does not have a pre-release portion.

[mbtools]

Like this?

      case 'release':
        if (!this.prerelease.length) {
          throw new Error('version is not a pre-release')          
        }
        this.prerelease = []
        break

LGTM 👍

[deej-io]

This seems very discrete and user-friendly. So the idea is that npm could then support npm version release?

That's the overall intention, yeah.

One of the biggest lessons I've learned in maintaining npm is that it's always best to be explicit and never guess user intent. With that in mind I'd lean towards throwing if the version does not have a pre-release portion.

Agreed! Thank you for the feedback :)

Like this?

      case 'release':
        if (this.prerelease.length) {
          throw new Error('version is not a pre-release')          
        }
        this.prerelease = []
        break

LGTM 👍

Great! I'll get on this when I'm out from work.

[wraithgar]

if (!this.prerelease.length) { I should hope, right?

[mbtools]

yes, ! of course 😄 (fixed above)

[wraithgar]

> (new (require('.').SemVer)('1.0.0')).inc('release')
Uncaught Error: version 1.0.0 is not a prerelease
    at SemVer.inc (classes/semver.js:181:17)
> require('.').inc('1.0.0', 'release')
null

please remember that semver.inc catches errors, only the semver object will throw.

[wraithgar]

Draft PR at #752