commit 提交规范校验--精简版（ts）

最新推荐文章于 2024-07-26 13:31:32 发布

DarkerSU

最新推荐文章于 2024-07-26 13:31:32 发布

阅读量160

点赞数 1

分类专栏： git 文章标签： git 前端

本文链接：https://blog.csdn.net/DarkerSP/article/details/134414351

版权

git 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

Husky

什么是 Husky

Husky就是让原生 git 钩子变得简单好操作的依赖包而已，你可以使用它来检查提交消息，运行测试，lint代码等…当你提交或推送时。Husky支持所有 Git 钩子。

使用 Husky

npm install husky --save-dev
# 或
pnpm add husky --save-dev

在package.json 文件的scripts配置项添加一行代码

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

在命令行运行husky

npm run prepare
# 或
pnpm run prepare

commitlint

什么是 commitlint

就是对你 git commit提交的消息做一个校验的插件，主要还是配合Git Hooks的钩commit-msg一起使用的。

使用 commitlint

安装相关依赖

# npm
npm install @commitlint/cli @commitlint/config-conventional @commitlint/types -D                      

# yarn
yarn add @commitlint/cli @commitlint/config-conventional @commitlint/types -D   

# pnpm        
pnpm add @commitlint/cli @commitlint/config-conventional @commitlint/types -D

根目录下新建commitlint.config.ts 用来配置commitlint

import type { UserConfig } from "@commitlint/types";        

const CommitlintConfig: UserConfig = {
  extends: ["@commitlint/config-conventional"],
  // 校验规则
  rules: {
    "type-enum": [
      2,
      "always",
      [
        "init" /* 初始化 */,
        "feat" /* 添加新特性 */,
        "fix" /* 修改Bug */,
        "perf" /* 优化相关，比如提升性能，体验等  */,
        "style" /* 格式（非正常业务逻辑变动） */,
        "docs" /* 文档修改 */,
        "merge" /* 合并分支 */,
        "update" /* 更新 */,
        "refactor" /* 重构（即不是新增功能，也不是修改bug的代码变动） */,
        "test" /* 增加测试 */,
        "chore" /* 构建过程或辅助工具的变动 */,
        "revert" /* 代码版本回滚 */,
        "workflow" /* 添加工作流 */,
      ],
    ],
  },
};

export default CommitlintConfig;

在package.json 中配置命令

"scripts": {
    ...
    "commitlint": "commitlint --config commitlint.config.ts -e -V",                                 
 }

启用commit

执行如下命令

npx husky add .husky/commit-msg "npm run commitlint"

会在根目录的.husky文件夹下多了一个 commit-msg 文件，其内容如下：

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

npm run commitlint

这样，commit-msg 这个钩子就开始生效了，再次提交代码就会开始检测你的提交消息了

完结撒花