You want to leverage commitlint to enforce a consistent commit messages that can be parsed to
generate a CHANGELOG.md
but none of the available presets support your commit types or tools,
e.g., Bitbucket, JIRA, Trello. This preset supports configuration via a .changelogrc.js
file.
This package is best used alongside the other ghostwriter
tools. Each tool can be configured
using the same .changelogrc.js
file:
npm
npm install --save-dev commitlint-config-ghostwriter
pnpm
pnpm install --save-dev commitlint-config-ghostwriter
yarn
yarn add --dev commitlint-config-ghostwriter
-
Create and configure a
.changelogrc.js
file in the root of your repository -
Update commitlint to leverage
commitlint-config-ghostwriter
module.exports = { extends: ['ghostwriter'], };
-
Run commitlint
The array of scopes that are available for selection when commiting. If left undefined
, then any
scope may be entered when committing.
type Scope = { description: string; type: string };
types
: Array<HiddenType | VisibleType>
The array of type objects representing the explicitly supported commit message types, and whether they should show up in generated CHANGELOGs.
type CommitType = { description: string; type: string };
type HiddenType = CommitType & { hidden: true; section: undefined };
type VisibleType = CommitType & { hidden: undefined; section: string };