@lcooper/commitlint-config v2.0.0

@lcooper/commitlint-config

A sharable commitlint config to enforce conventional commits. Use with @commitlint/cli.

Installation

Install with npm:

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

Install with yarn:

yarn add -D @commitlint/cli @lcooper/commitlint-config

Usage

Add the commitlint field to your package.json file:

"commitlint": {
  "extends": [
    "@lcooper",
  ]
}

Or create a commitlint config file type of your choice in the root folder of your project:

.commitlintrc

{
  "extends": [
    "@lcooper"
  ],
}

.commitlintrc.js

module.exports = {
    extends: [
      '@lcooper',
    ],
};

Check out the commitlint docs for more details about sharable configs.

Usage with Husky

You can configure a git commit message hook using husky, just add it as a devDependency.

If you are using husky@v9, follow the instructions on commitlints local setup documentation page.

To configure a husky commit message hook with husky@v4, add the following field to your package.json:

"husky": {
  "hooks": {
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }
}

Rules

This config extends @commitlint/config-conventional, and defines the following types:

Additionally, the max line length of commit message headers, bodies and footers is 72 characters to enforce wrapping.

License

MIT