阅读 290

使用husky7.x + commitlint 来规范代码的commit提交

为了规范git提交规范,制定本规范。地址:commitlint.js.org/#/guides-lo… 具体步骤如下:

第一步:安装插件

npm install --save-dev @commitlint/{cli,config-conventional}
或
yarn add @commitlint/{cli,config-conventional} -D
复制代码

第二步:在根目录创建commitlint.config.js文件,配置相关规则,或者Alternatively the configuration can be defined in a commitlint.config.js.commitlintrc.js.commitlintrc.commitlintrc.json.commitlintrc.yml file or a commitlint field in package.json.内容如下:

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    // 'subject-case': [0, 'never'],
    'type-enum': [
      2,            //代表必须输入
      'always', 
      [
        "docs",     // Adds or alters documentation. 仅仅修改了文档,比如README, CHANGELOG, CONTRIBUTE等等
        "chore",    // Other changes that don't modify src or test files. 改变构建流程、或者增加依赖库、工具等
        "feat",     // Adds a new feature. 新增feature
        "fix",      // Solves a bug. 修复bug
        "merge",    // 仅进行分支合并.
        "improvement",    // 用于对当前实现进行改进而没有添加新功能或修复错误的提交.
        "perf",     // Improves performance. 优化相关,比如提升性能、体验
        "refactor", // Rewrites code without feature, performance or bug changes. 代码重构,没有加新功能或者修复bug
        "revert",    // Reverts a previous commit. 回滚到上一个版本                
        "style",    // Improves formatting, white-space. 仅仅修改了空格、格式缩进、逗号等等,不改变代码逻辑                
        "test",     // Adds or modifies tests. 测试用例,包括单元测试、集成测试等   
        "ci",     //主要目的是修改项目继续集成流程(例如 Travis,Jenkins,GitLab CI,Circle等)的提交
        "build",  //主要目的是修改项目构建系统(例如 glup,webpack,rollup 的配置等)的提交
      ]
    ]
  }
}
复制代码

第三步:安装husky

npm install husky --save-dev 
或
yarn add husky --dev 
复制代码

第四步:生成husky目录及相关文件

npx husky install
或
yarn husky install

#生成文件
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'
或
yarn husky add .husky/commit-msg 'yarn commitlint --edit $1'
复制代码

第五步:在package.json文件中添加以下配置,这样其他开发小伙伴就不需要再次执行以上步骤来使用了

 "scripts": {
     "postinstall": "husky install"
 }
复制代码
文章分类
前端
文章标签