- commitlint
⚙️ Easy to integrate with your CI To get the most out of commitlint you'll want to automate it in your project lifecycle
- Getting started | commitlint
Node v24 changes the way that modules are loaded, and this includes the commitlint config file If your project does not contain a package json, commitlint may fail to load the config, resulting in a Please add rules to your commitlint config js error message
- Configuration | commitlint
Every commitlint configuration can extend other commitlint configurations Specify configurations to extend via the extends key, using ids that can be resolved by the node resolve algorithm
- Guide: Local setup | commitlint
Since v8 0 0 commitlint won't output anything if there are no problems with your commit (You can use the --verbose flag to get positive output)
- Guide: CI Setup | commitlint
Enforce commit conventions with confidence by linting on your CI servers with commitlint This guide assumes you have already configured commitlint for local usage
- CLI | commitlint
npx commitlint --help @commitlint cli@19 8 1 - Lint your commit messages [input] reads from stdin if --edit, --env, --from and --to are omitted Options: -c, --color toggle colored output [boolean] [default: true] -g, --config path to the config file; result code 9 if config is missing [string] --print-config print resolved config [string
- Examples | commitlint
Examples These examples show common usages of how commitlint can be configured Validate for issue ticket numbers package json jsonc { "commitlint": { "rules": { "references-empty": [2, "never"], }, "parserPreset": { "parserOpts": { "issuePrefixes": ["PROJ-"], }, }, }, }
- Rules | commitlint
Rules body-full-stop condition: body ends with value rule: never value
|