Skip to content

Latest commit

 

History

History
190 lines (137 loc) · 7.93 KB

README.md

File metadata and controls

190 lines (137 loc) · 7.93 KB
Raw

Next Standard Version

Get the next Standard Version of a project.

npm version npm downloads Node.js version support Renovate enabled semantic-release Code coverage License

Table of contents

Install

Install next-standard-version locally in a project or globally.

$ npm install --save-dev next-standard-version
# Or install it globally.
$ npm install --global next-standard-version

Usage

next-standard-version has two methods of using Standard Version (standard-version) to get the next version.

  1. Using the standard-version of the project to get the next Standard Version from (default; see CLI).
  2. Using the packaged standard-version.

While this project aims to always have the latest version of standard-version, the first option guarantees that the standard-version used to get the next version is the exact same as the standard-version used to make the actual release. Using the second option, there might be a mismatch between the versions of standard-version and is could result in a different release version in case of a difference in the major version of standard-version.

CLI

$ next-standard-version --help
Get the next Standard Version of a project.

Options:
  --help, -h                                                           [boolean]
  --version, -v                                                        [boolean]
  --modulePath, -m  Path to standard-version module.
                           [string] [default: "./node_modules/standard-version"]
  --packaged, -p    Use the packaged standard-version.
                    Note that this silently overrules the modulePath option.
                                                                       [boolean]
  --releaseAs, -r   Specify the release type manually.
                                   [string] [choices: "major", "minor", "patch"]

Examples:
  next-standard-version                     Print the next Standard Version.
  next-standard-version --modulePath        Print the next Standard Version
  ./node_modules/standard-version           using the standard-version package
                                            specified to by the module path.
  next-standard-version --packaged          Print the next Standard Version
                                            using the packaged standard-version.
  next-standard-version --releaseAs minor   Print the next Standard Version with
                                            a specific release type.
Examples using different installation and execution methods.

  • Run from global installation.

    $ next-standard-version  # From project root
1.0.1

  • Run from local installation.

    $ npx --no-install next-standard-version  # From project root
1.0.1

  • Run from local installation as npm script with the following in package.json.

    {
  "scripts": {
    "next-version": "next-standard-version"
  }
}

    And run.

    $ npm run next-version  # From project root
1.0.1

API

next-standard-version has one function: nextStandardVersion.

The function takes an object of the Options interface, shown below, as argument. One of the modulePath and packaged options MUST be configured. If both are configured, the packaged option will silently overrule the modulePath option.

export interface Options {
  modulePath?: string; // Path to standard-version module.
  packaged?: boolean; // Use the packaged standard-version.
  releaseAs?: 'major' | 'minor' | 'patch'; // Specify the release type manually.
}

The function returns a promise, which will resolve to a string containing the next Standard Version. The promise will be rejected with an error message if an error occurs.

Example.

The example below shows how next-standard-version can be used in TypeScript. This example simply prints the next Standard Version to the console.

import { nextStandardVersion } from 'next-standard-version';

nextStandardVersion({
  modulePath: './node_modules/standard-version',
})
  .then((version: string) => {
    console.log(version);
  })
  .catch((error) => {
    console.error(error);
  });

Contributing

Please create an issue if you have a bug report, feature proposal or question that does not yet exist.

Please give this project a star ⭐ if you like it and consider becoming a sponsor to support this project.

Refer to the contributing guide detailed information about other contributions, like pull requests.

Conventional Commits: 1.0.0 Code style Linting Lint commit messages Build

Security policy

Please refer to the Security Policy on GitHub for the security policy.

License

This project is licensed under the GPLv3 license.

Copyright © 2019-2022 Jeroen de Bruijn

License details.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

The full text of the license is available in the LICENSE file in this repository and online.