conventional-recommended-bump

Get a recommended version bump based on conventional commits.

Got the idea from https://github.com/conventional-changelog/conventional-changelog/pull/29

Install

 # pnpm
pnpm add conventional-recommended-bump
# yarn
yarn add conventional-recommended-bump
# npm
npm i conventional-recommended-bump

Usage

 import { Bumper } from 'conventional-recommended-bump'

const bumper = new Bumper(process.cwd()).loadPreset('angular')
const recommendation = await bumper.bump()

console.log(recommendation.releaseType) // 'major'

API

new Bumper(cwdOrGitClient: string | ConventionalGitClient = process.cwd())

Create a new Bumper instance. cwdOrGitClient is the current working directory or a ConventionalGitClient instance.

bumper.tag(paramsOrTag: GetSemverTagsParams & Params | string): this

Set params to get the last semver tag or set the tag directly.

bumper.commits(params: GetCommitsParams & Params, parserOptions?: ParserStreamOptions): this

Set params to get the commits.

bumper.commits(commits: Iterable<Commit> | AsyncIterable<Commit>): this

Set the commits directly.

bumper.loadPreset(preset: PresetParams): this

Load and set necessary params from a preset.

bumper.bump(whatBump?: (commits: Commit[]) => Promise<BumperRecommendation | null | undefined>): Promise<BumperRecommendation>

Get a recommended version bump based on conventional commits. whatBump function is required if preset is not loaded.

CLI

 $ conventional-recommended-bump --help

License

MIT © Steve Mao