narcissus-fe-commitlint-config v1.0.0

narcissus-fe-commitlint-config

纳西索斯 Git 规范

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

安装

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

npm install narcissus-fe-commitlint-config @commitlint/cli --save-dev

使用

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

module.exports = {
  extends: ['narcissus-fe-commitlint-config'],
};

设置 git hook

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

首先安装 husky：

npm install husky --save-dev

然后在 package.json 中增加：

{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}

注意：当前使用的husky版本为 V3 版本，由于升级带来的 break change 过大，有兴趣可以自行升级。

更多信息可参考 commitlint 文档。