@cordada/commitlint-config-cordada

Shareable commitlint configuration enforcing conventional commits, with some customizations. Use with @commitlint/cli and @commitlint/prompt-cli.

Getting started

npm install --save-dev @cordada/commitlint-config-cordada @commitlint/cli
echo "module.exports = {extends: ['@cordada/commitlint-config-cordada']};" > commitlint.config.js

Rules

Problems

The following rules are considered problems for @cordada/commitlint-config-cordada and will yield a non-zero exit code when not met.

Consult docs/rules or docs/rules (2) for a list of available rules.

TODO

TODO 🚧

Ignored Commits

Besides the default ignores of commitlint, such as merge and revert commits, the commits created by Dependabot are not linted. Dependabot writes their titles itself, and those of its grouped updates, such as chore(deps): Bump the <group> group across 1 directory with <N> updates, can exceed the maximum length of the title. They are recognized by the trailer Signed-off-by: dependabot[bot] <[email protected]>, which Dependabot adds to every commit it creates. A commit pushed by a person to a pull request of Dependabot does not carry it, and is linted as usual.

A configuration that extends this one and sets ignores of its own replaces this list instead of adding to it, so it has to repeat this ignore to keep it.

Publishing Node.js Package

npm config set @cordada:registry='https://registry.npmjs.org' --location project
npm publish

npm config set @cordada:registry='https://npm.pkg.github.com' --location project
npm publish

npm config delete @cordada:registry --location project