commitlint

Appearance

Getting started ​

Install ​

Install @commitlint/cli and a @commitlint/config-* / commitlint-config-* of your choice as devDependency and configure commitlint to use it.

sh
npm install -D @commitlint/cli @commitlint/config-conventional
sh
yarn add -D @commitlint/cli @commitlint/config-conventional
sh
pnpm add -D @commitlint/cli @commitlint/config-conventional
sh
bun add -d @commitlint/cli @commitlint/config-conventional
sh
deno add -D npm:@commitlint/cli npm:@commitlint/config-conventional

Configuration ​

Configure commitlint to use conventional config

sh
echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

NOTE

Windows users: The echo command in PowerShell and cmd.exe may create the config file with a non-UTF-8 encoding (e.g. UTF-16LE or the system's default ANSI code page), which can cause commitlint to fail to read the configuration. To avoid this, create commitlint.config.js manually in your editor, or use PowerShell with explicit encoding:

powershell
"export default { extends: ['@commitlint/config-conventional'] };" | Out-File -Encoding utf8 commitlint.config.js

WARNING

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. This can be fixed by doing either of the following:

  • Add a package.json file, declaring your project as an ES6 module. This can be done easily by running npm init es6.
  • Rename the config file from commitlint.config.js to commitlint.config.mjs.

Refer to configuration documentation for more information.