@dwmt/commitlint-plugin-numbered-type

1.0.0 • Public • Published

Commitlint Numbered Type | Plugin

Commitlint plugin to check if your commit messages start with an issue number and a type.

Accepts commit messages like:

#1/feat: implemented a new message handler
#729/fix: removed erroneous handling of a key

Getting Started

If you want to lint your commits with numbered-type, follow along:

  1. Install Commitlint, Husky and the numbered-type dependencies
    npm i @commitlint/cli husky @dwmt/commitlint-plugin-numbered-type @dwmt/commitlint-config-numbered-type -D
    
  2. Configure commitlint
    // commitlint.config.js
    module.exports = {
      plugins: ['@dwmt/commitlint-plugin-numbered-type'],
      extends: ['@dwmt/commitlint-config-numbered-type'],
    }
  3. Setup Husky: to lint commits before they are created you can use Husky's commit-msg hook
    mkdir .husky
    npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"
    

You can find detailed instructions regarding the local setup of Commitlint and Husky at Commitlint Local Setup.

Further Information

Please see the README of the parent monorepo.

Package Sidebar

Install

npm i @dwmt/commitlint-plugin-numbered-type

Weekly Downloads

2

Version

1.0.0

License

MIT

Unpacked Size

15.3 kB

Total Files

20

Last publish

Collaborators

  • lajoskvcs
  • baximus
  • battila7