semver-sync

Utility that keeps version numbers in sync between package.json, component.json and an optional source file.

npm install semver-sync
13 downloads in the last week
116 downloads in the last month

semver-sync

semver-sync is a node.js module that enables you to synchronize version numbers accross package.json, component.json and other source files of your choosing.

Build Status

Installation

You can install it via npm:

npm install -g semver-sync

How to use it

This utility uses package.json as the reference by which all other version numbers in the package are checked. If you don't have a package.json in the folder where you run it, it will give an error and break.

The utility automatically checks package.json and component.json. If you have other JavaScript sources or JSON files that hold your version number first edit the package.json, adding the versionedSources property:

{
  "name": "mypackage",
  "version": "1.2.3",
  "versionedSources": "mypackage.js"
}

Once that's done, you can check that everything's ok:

semver-sync -v
[OK] Everything is in sync, with version number 1.2.3

If you accidentaly change the version number in one of the sources, or forget to update it, you'll see an error:

semver-sync -v
[ERROR] Version number is out of sync in component.json, mypackage.js.

If you want to update the version number automatically in all the files, you can do:

semver-sync -b
[OK] Version number was updated to 1.2.4 in package.json, component.json, mypackage.js.
semver-sync -b patch
[OK] Version number was updated to 1.2.5 in package.json, component.json, mypackage.js.
semver-sync -b minor
[OK] Version number was updated to 1.3.0 in package.json, component.json, mypackage.js.
semver-sync -b major
[OK] Version number was updated to 2.0.0 in package.json, component.json, mypackage.js.
semver-sync -b 3.0.0-alpha1
[OK] Version number was updated to 3.0.1-alpha1 in package.json, component.json, mypackage.js.
semver-sync -b 3.0.0-beta2
[OK] Version number was updated to 3.0.1-beta2 in package.json, component.json, mypackage.js.
semver-sync -b 3.0.0-rc1
[OK] Version number was updated to 3.0.1-rc1 in package.json, component.json, mypackage.js.

If you want to update the version number automatically in all the files, commit the changes and create a new git tag, you can do:

semver-sync -t
[OK] Version number was updated to 1.2.4 in package.json, component.json, mypackage.js.
[OK] Files have been commited and tag v1.2.4 was created.

How it works

The module uses UglifyJS 2 to create an AST of the JavaScript and JSON sources passed in. This approach is more flexible than matching strings or trying to find version numbers in source files.

The AST patterns used to find the nodes which hold the version properties are in the patterns.js source file. It should work on most types of structures, if you find one that doesn't please log an issue. The module has automated tests for this pattern matching, using some real-life libraries and it seems to work pretty well.

To check and bump the version number, the module uses the node-semver package.

The binary uses node-optimist to parse the input options. Unfortunately, there are no automated tests for it yet, so please log any issues that you encounter.

Console help

Usage: semver-sync -s [source list] -b [release type].

Options:

  • -b, --bump Bump the version number in package.json, component.json and all other specified source files. It can take one of the following values: major, minor, patch. Alternatively you can specify a custom version that is higher than the current one. If no value is specified, it defaults to patch.
  • -v, --verify Verifies that package.json, component.json and all other source files have the same version number and checks if it conforms to the semver specification.
  • -s, --sources Declare additional files in which the version number will be updated or checked. If not explicitly specified, it is read from the package.json "versionedSources" property. If it's not present in the package.json and not explicitly specified, only component.json and package.json will be synced.
  • -t, --tag Bump the version number, commit the changes to package.json, component.json and all other specified source files and create a git tag with the current version. It can take one of the following values: major, minor, patch. Alternatively you can specify a custom version that is higher than the current one. If no value is specified, it defaults to patch.

License

This package is released under the MIT License.

npm loves you