cz-ghostwriter

A configurable commitizen adapter

Usage no npm install needed!

<script type="module">
  import czGhostwriter from 'https://cdn.skypack.dev/cz-ghostwriter';
</script>

README

cz-ghostwriter

CI Status Code Style: Prettier Commitizen Friendly NPM Package Version Semantic Release


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:


Installation

npm i cz-ghostwriter

Usage

  1. Create and configure a .changelogrc.js file in the root of your repository

  2. Update commitizen to leverage cz-ghostwriter

    {
 ...

 "path": "./node_modules/cz-ghostwriter"

 ...
}

  3. Run commitizen


Configuration

issuePrefixes : string[]

The array of prefixes used to detect references to issues.


issueReferencesPrefix : string = "for"

The prefix to use before listing issues that a commit refers to. Defaults to "for".


preset : "github" | undefined

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

scopes : Scope[] | undefined

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 };