A configurable commitizen adapter
npm install cz-ghostwriter
You want to leverage commitizen 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:**
- commitlint-config-ghostwriter
- conventional-changelog-ghostwriter
npm
``sh`
npm install --save-dev cz-ghostwriter
pnpm
`sh`
pnpm install --save-dev cz-ghostwriter
yarn
`sh`
yarn add --dev cz-ghostwriter
1. Create and configure a .changelogrc.js file in the root of your repositorycz-ghostwriter
2. Update commitizen to leverage
`json
{
...
"path": "./node_modules/cz-ghostwriter"
...
}
`
3. Run commitizen
---
The array of prefixes used to detect references to issues.
---
The prefix to use before listing issues that a commit refers to. Defaults to "for".
---
The configuration preset to use which will set other configuration properties. If this property is
set the following configuration properties are overwritten, i.e., nullable:
- issuePrefixes
---
The array of scopes that are available for selection when commiting. If left undefined, then any
scope may be entered when committing.
`ts`
type Scope = { description: string; type: string };
---
The array of type objects representing the explicitly supported commit message types, and whether
they should show up in generated CHANGELOGs.
`ts
type CommitType = { description: string; type: string };
type HiddenType = CommitType & { hidden: true; section: undefined };
type VisibleType = CommitType & { hidden: undefined; section: string };
``