npm-gitver

npm-gitver is an NPM library for managing versioning in your Node.js projects using Git tags.

Installation

Install the library using npm:

npm install npm-gitver --save-dev

Usage

Running via npm script

1. Ensure you are using the correct Node.js version specified in the .nvmrc file:

   nvm use

2. Add a script in your package.json to run npm-gitver:

   "scripts": {
     "version": "npm-gitver"
   }

3. Run the versioning script:

   npm run version

   This will automatically update your project version based on Git tags.

Running directly via CLI

You can also run npm-gitver directly using npx without adding it to your package.json:

npx npm-gitver

This will execute the package directly from the command line, creating or updating the version based on Git tags.

Specifying a Custom package.json File Path

If your package.json file is located in a custom directory, you can use the --file or -f flag to specify its path:

npx npm-gitver --file ./path/to/package.json

or

npx npm-gitver -f ./path/to/package.json

This will use the specified package.json file to determine the base version and update it accordingly.

Including the Git Branch in the Version

You can use the --branch flag to include the current Git branch name in the generated version. This is useful for identifying builds from different branches.

npx npm-gitver --branch

or

npx npm-gitver -b

When using this flag, the generated version will include the branch name as a prefix to the Git SHA, formatted as <branch>.<sha>. For example, if the branch is feature/new-feature and the Git SHA is abc123, the version will look like:

1.0.0-feature-new-feature.abc123

Note: Slashes (/) in branch names will be replaced with dashes (-), and any unsafe characters will be removed.

Linting

Follow best practices for linting your code. Refer to the ESLint documentation for setup and configuration:

ESLint Documentation

Additional Information

For more details on how npm-gitver works, refer to the GitHub repository.