Get a recommended version bump based on conventional commits.
Got the idea from https://github.com/conventional-changelog/conventional-changelog/pull/29
Install • Usage • API • CLI
# pnpm
pnpm add conventional-recommended-bump
# yarn
yarn add conventional-recommended-bump
# npm
npm i conventional-recommended-bumpimport { Bumper } from 'conventional-recommended-bump'
const bumper = new Bumper(process.cwd()).loadPreset('angular')
const recommendation = await bumper.bump()
console.log(recommendation.releaseType) // 'major'Create a new Bumper instance. cwdOrGitClient is the current working directory or a ConventionalGitClient instance.
Set params to get the last semver tag or set the tag directly.
Set params to get the commits.
Set the commits directly.
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.
$ conventional-recommended-bump --helpMIT © Steve Mao