Support major version zero incrementing alongside existing
When using the standard
semver package, a major version zero is treated the same as a any other value for the major version. For example, incrementing a
0.0.0 will increment the middle number by one, just as it would if the initial version had been
shifted-semver-increment, incrementing the
major version will increment what is traditionally the
minor number in the semantic version string, while incrementing the
patch version will increment the
patch number in the semantic version string.
Table of Contents
To install the
shifted-semver-increment tool for use in your project please run the following command:
yarn add [--dev] shifted-semver-increment
const shiftedSemver = ;// When using a version with the major version set to zero.; // `0.0.1`; // `0.0.1`; // `0.1.0`// When using a version with the major version greater than zero.; // `1.0.1`; // `1.1.0`; // `2.0.0`
By shifting the use of each number developers can continue to use semantic concepts such as releasing breaking changes in a
major release, but remain in a pre-
1.0.0 release stage (The pre-release stage means the project does not have a stable, publicly consumable, API according to Semantic Versioning 2.0.0).
shifted-semver-increment also supports Prerelease Identifiers for major version zero releases.
const shiftedSemver = ;// When using version with the major version set to zero.; // `0.0.1-beta.0`; // `0.0.1-beta.0`; // `0.0.1-beta.0`; // `0.1.0-beta.0`; // `0.1.0-beta.1`; // `0.1.1-beta.0`; // `0.1.1-beta.0`; // `0.2.0-beta.0`// When using a version with the major version greater than zero.; // `1.0.1-beta.0`; // `1.0.1-beta.0`; // `1.1.0-beta.`; // `2.0.0-beta.0`
To assist users of
shifted-semver-increment with debugging the behavior of this module we use the debug utility package to print information to the console. To enable debug message printing, the environment variable
DEBUG, which is the variable used by the
debug package, must be set to a value configured by the package containing the debug messages to be printed.
To print debug messages on a unix system set the environment variable
DEBUG with the name of this package prior to executing a tool that invokes this module:
DEBUG=shifted-semver-increment [CONSUMING TOOL]
On the Windows command line you may do:
set DEBUG=shifted-semver-increment[CONSUMING TOOL]
Node Support Policy
We only support Long-Term Support versions of Node.
We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but because we have a limited amount of time, and supporting LTS offers the greatest return on that investment.
It's possible this package will work correctly on newer versions of Node. It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.
As each Node LTS version reaches its end-of-life we will remove that version from the
engines property of our package's
package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node. Any merge requests or issues supporting an end-of-life version of Node will be closed.
We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.
engines property. If you encounter issues installing this package, please report the issue to your package manager.
Please read our contributing guide to see how you may contribute to this project.