commitlint-config-ants

ants Git 提交规范

支持配套的 commitlint 配置，用于对 git commit message 进行校验。

安装

使用时，需要安装 @commitlint/cli：

npm install commitlint-config-ants @commitlint/cli --save-dev

pnpm add commitlint-config-ants @commitlint/cli -D

使用

在 commitlint.config.js 中集成本包:

module.exports = {
  extends: ["commitlint-config-ants"],
};

设置 git hook

可通过 husky 设置在 git commit 时触发 commitlint。

首先安装 husky：

pnpm add --save-dev husky

husky init

pnpm exec husky init

然后在 .husky 目录下 创建 commit-msg 文件

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no -- commitlint --edit $1

更多信息可参考 commitlint 文档。