Skip to content

Check if your commit messages start with an issue number and a type.

License

Notifications You must be signed in to change notification settings

dwmt/commitlint-numbered-type

Repository files navigation

Commitlint Numbered Type

Continuous Integration npm LICENSE

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 the 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.

Configurable Rules

numbered-type offers the following configurable rules. By customizing these rules, you can define which messages should be accepted and rejected.

numbered-type-type-enum

An enumeration of accepted types. If the type within the message is not included, then the message is rejected. By default, the value of this setting is undefined, which means that every type is accepted.

If you want to accept feat and fix only:

// commitlint.config.js
module.exports = {
  plugins: ['@dwmt/commitlint-plugin-numbered-type'],
  extends: ['@dwmt/commitlint-config-numbered-type'],
  rules: {
     // 2 sets the level of this rule to error.
     // always means that this rule should be applied as is
     // (the other value is "never", which inverts the rule) 
     'numbered-type-type-enum': [2, 'always', ['feat', 'fix']] 
  }
}

Packages

This is a monorepo containing the following packages:

About

Check if your commit messages start with an issue number and a type.

Resources

License

Stars

Watchers

Forks

Packages

No packages published