前言

大家在开发中是不是习惯了git commit -m '代码更新'这种提交？

作为一个对自身有要求的开发人员并且团队合作的时候方便查看提交记录可以使用以下提交

git commit -m "feat: 新增微信自定义分享"

概括

如果你想保持良好的习惯去提交代码，接下来我们直接了解并使用commit

commitlint使用

接下来教大家怎么在git commit命令或者vscode工具中同样规范的提交代码

一、安装插件

npm install --save-dev husky 
npm install --save-dev @commitlint/cli 
npm install --save-dev @commitlint/config-conventional

二、配置

• 初始化husky

npx husky install

• 添加hooks

npx husky add .husky/commit-msg 'npx --no -- commitlint --edit \$1'

• 在项目根目录下创建commitlint.config.js，并配置如下

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-case': [2, 'always', ['lower-case', 'upper-case']],
    'type-enum': [2, 'always',[
        'feat', // 增加新功能
        'fix', // 修复问题/BUG
        'style', // 代码风格相关无影响运行结果的
        'perf', // 优化/性能提升
        'refactor', // 重构
        'revert', // 撤销修改
        'test', // 测试相关
        'docs', // 文档/注释
        'chore', // 依赖更新/脚手架配置修改等
        'workflow', // 工作流改进
        'ci', // 持续集成
        'types', // 类型定义文件更改
        'wip', // 开发中
        'undef' // 不确定的分类
      ]
    ]
  }
}

三、验证

• 没配置前提交示例

• 配置之后不规范提交示例

• 配置之后规范提交示例

总结

几个步骤下来就可以配置好，希望大家都能养成一个开发好习惯~