commitlint-config

W5S Commitlint configuration (@w5s/commitlint-config)

Commitlint configuration presets

Installation

npm install --save-dev @w5s/commitlint-config @commitlint/cli

Usage

In the package.json of your project

{
  "commitlint": {
    "extends": ["@w5s/commitlint-config"]
  }
}

Extra rules

{
  "commitlint": {
    "rules": {
      // Rule to validate gitmoji unicode (🐛) or emoji (:bug:)
      "type-gitmoji-style": ["error", "always", "unicode" /* | 'emoji' */],
      // Rule to validate a gitmoji in the list
      "type-valid-gitmoji": ["error", "always"]
    }
  }
}

Ensure the commitlint is setup on husky commit message hook (default .husky/commit-msg)

npm exec -- commitlint --edit $1

License

MIT © Julien Polo julien.polo@gmail.com