feat: preserve pre-release and build parts of a version on coerce (#592)

[madtisa]

What / Why

Introduces the new coerce option includePrerelease, if set, allowing to preserve pre-release and build parts of a version.

References

Fixes #592
Fixes #357

[wraithgar]

Should this be using includePrerelease instead?

[madtisa]

Should this be using includePrerelease instead?

Isn't that option have different meaning: to compare without taking prerelease versions into account? I can change it, if it won't cause confusion

[madtisa]

It also includes build part

[wraithgar]

No it's the opposite. If true, includePrerelease means to include the prereelase portion when doing comparisons. The default is false.

It seems to make sense to extend this boolean to also include the coercion function. What we want to avoid is adding a new single-use boolean with an extremely generic name like "full".

[madtisa]

No it's the opposite. If true, includePrerelease means to include the prereelase portion when doing comparisons. The default is false.

It seems to make sense to extend this boolean to also include the coercion function. What we want to avoid is adding a new single-use boolean with an extremely generic name like "full".

Yeah, I meant the opposite (despite what I wrote). I understand the point about name is too generic 👌

[wraithgar]

This is looking really good, heading in the right direction. Just some regex cleanup and an erroneous comment change. The actual implementation in functions/coerce.js is really good, much easier to read with the parts broken up like that.

[madtisa]

It's done, should I squash (rebase) everything into one commit at the end?

[wraithgar]

It's done, should I squash (rebase) everything into one commit at the end?

You don't have to, I will squash this when I merge it.

[wraithgar]

Thanks for your patience and responses getting this PR ready. This module is one of the most highly downloaded packages on the entire registry and we try to be careful and purposeful when making changes. We're definitely on the right track here and I think this is something that will be able to land soon.

[madtisa]

Okay, linted and tested locally, so everything should be alright.

I'm still nervous about option name includePrerelease, since it passed all the way to SemVer instance, and it has different meaning there: https://github.com/madtisa/node-semver/blob/5c8efbcb3c6c125af10746d054faff13e8c33fbd/classes/semver.js#L31C1-L32C59.
I would also elevate this change as breaking due to probability this option had been already used with intent that doesn't include parsing prerelease and build parts of a version

[wraithgar]

We have been the lack of including includePrerelease in a function as a bug, fixing it is not a breaking change. We can leave this PR open for a bit to see if others agree or disagree.

There is still the one odd assertion in test/functions/coerce.js that asserts two different things joined by an || that seems off to me.

[madtisa]

We have been the lack of including includePrerelease in a function as a bug, fixing it is not a breaking change. We can leave this PR open for a bit to see if others agree or disagree.

There is still the one odd assertion in test/functions/coerce.js that asserts two different things joined by an || that seems off to me.

Addressed this in conversation above: #671 (comment)