commitlint-config-ghostwriter

1.1.1 • Public • Published

commitlint-config-ghostwriter

NPM Package Version


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:


Installation

npm
npm install --save-dev commitlint-config-ghostwriter

pnpm
pnpm install --save-dev commitlint-config-ghostwriter

yarn
yarn add --dev commitlint-config-ghostwriter

Usage

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

  2. Update commitlint to leverage commitlint-config-ghostwriter

    module.exports = {
      extends: ['ghostwriter'],
    };
  3. Run commitlint


Configuration

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

Package Sidebar

Install

npm i commitlint-config-ghostwriter

Weekly Downloads

84

Version

1.1.1

License

MIT

Unpacked Size

7.46 kB

Total Files

5

Last publish

Collaborators

  • jsanchezio