Commitlint

Prerequisites:

The styleguide needs to be installed as a development dependency:

pnpm i -D @kurocado-studio/styleguide

Install Commitlint

pnpm i -D commitlint

To use our Commitlint configuration, add the following .commitlintrc.js file at the root of your project.

export { commitLintConfig as default } from '@kurocado-studio/styleguide';

To simplify the linting process, add scripts to your package.json. Open package.json and add the following under the "scripts" section:

{
  "scripts": {
    "commitlint": "pnpm exec commitlint --edit .git/COMMIT_EDITMSG"
  }
}

Last modified: 25 March 2025