@tomjs/commitlint

English | 中文

Front-end project commitlint Code submission specification configuration, node>=18 is recommended.

Usage

• Install dependencies

pnpm add -D @commitlint/cli @tomjs/commitlint

• Modify .commitlintrc.{js,cjs} configuration

module.exports = {
  extends: [require.resolve('@tomjs/commitlint')],
};

• Combine with other libraries

Used in conjunction with husky and lint-staged.

pnpm add -D husky lint-staged

scripts of package.json added prepare

{
  "scripts": {
    "prepare": "husky install"
  }
}

Make configuration

pnpm add --save-peer @commitlint/cli
pnpm add @commitlint/config-conventional

• @commitlint/config-conventional: commitlint rule configuration