@tomjs/commitlint

!npm !node-current (scoped) !NPM

English | 中文

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

使用

- 安装依赖

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

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

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

- 结合其他库

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

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

package.json 的 scripts 增加 prepare

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

制作配置

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

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