@tomjs/commitlint

English | 中文

前端项目 commitlint 代码提交规范配置，推荐 node>=18。

使用

• 安装依赖

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

• 修改 commitlint.config.{js,mjs,ts,mts} 配置

export default {
  extends: ['@tomjs/commitlint'],
};

• 结合其他库

结合 simple-git-hooks 和 lint-staged 使用。

pnpm add -D simple-git-hooks lint-staged

package.json 的 scripts 增加 prepare

{
  "scripts": {
    "prepare": "simple-git-hooks"
  }
}

制作配置

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

• @commitlint/config-conventional：commitlint 规则配置