Getting started | commitlint (original) (raw)

Install ​

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

npmyarnpnpmbundeno

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

Refer to configuration documentation for more information.