commitlint

commitlint is a widely adopted Git tool that lints commit messages and helps your team adhere to a commit convention.

Installation

You have to install commitlint-cli first. Currently commitlint-cli v19 is supported.

npm

npm install @commitlint/cli -D

yarn

yarn add @commitlint/cli -D

pnpm

pnpm install @commitlint/cli -D

Configuration

Create commitlint.config.mjs in your project root:

// commitlint.config.mjs
import { commitlint } from "@modyqyw/fabric/commitlint";

export default commitlint();

Customization

Parameters

Passing parameters to the exported commitlint method can customize, and the commitlint method takes two parameters.

The first parameter is used for basic customization; you can pass no or empty objects to indicate the use of default values. To explicitly enable or disable a plugin, you need to explicitly set the boolean value in the passed object.

The following is the default configuration:

// commitlint.config.mjs
import { hasLerna, hasNx, hasPnpmWorkspace, hasRush } from "@modyqyw/fabric";
import { commitlint } from "@modyqyw/fabric/commitlint";

export default commitlint({
  // Support monorepo
  // Default true (enabled)
  // Optional false (disabled), 'learn', 'nx', 'pnpm-workspace', 'rush'
  monorepo: true,
  // Commit message style
  // Default 'conventional', conventional commits
  // Optional 'angular'
  style: "conventional",
});

Writing a commit message

Writing a commit message is not an easy task for the uninitiated. Fortunately, there are many ways to simplify the process.

You can install the VSC Plugin and WebStorm plugin to assist in writing commit messages.

For the command line, you can use commitizen and implement integration with commitlint using @commitlint/prompt. See Commitlint Guide: Using prompt for details on the latter.

The second parameter is used for further customization, you can pass an object to override the generated configuration.

// commitlint.config.mjs
import { commitlint } from "@modyqyw/fabric/commitlint";

export default commitlint(
  {},
  {
    // configs that require customization
  },
);

FAQ

Integration of simple-git-hooks?

If you are using the simple-git-hooks configuration provided by the package, see the simple-git-hooks chapter.

If you are not, you can refer to the following configuration.

// simple-git-hooks.cjs
module.exports = {
  "commit-msg": "npx commitlint --edit ${1}",
};