代码增加commitlint约束

这又来一个坑了哦,在git提交的时候需要按照规范才能提交,接下来是commitlint的配置

首先安装commitlint脚手架啥的

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

接下来新建commitlint.config.js文件,然后在里面输入这段话规范提交时候的hooks约束

module.exports = {extends: ['@commitlint/config-conventional']}

注意:不能使用

echo " module.exports = {extends: ['@commitlint/config-conventional']} " > commitlint.config.js

因为vs code的power shell会造成无法识别的乱码。。。有毒,坑在这里

接下来安装husky

npm install husky --save-dev

激活提交前的hooks

npx husky install

添加hooks

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

这样就完成提交前约束了,完美配合Prettier,提交格式为

类型 描述

build 编译相关的修改,例如发布版本、对项目构建或者依赖的改动

chore 其他修改, 比如改变构建流程、或者增加依赖库、工具等

ci 持续集成修改

docs 文档修改

feat 新特性、新功能

fix 修改bug

perf 优化相关,比如提升性能、体验

refactor 代码重构

revert 回滚到上一个版本

style 代码格式修改, 注意不是 css 修改

test 测试用例修改

比如:

refactor: 重构整个项目

fix(account): 修复xxx的bug

这个坑也踩完了,有毒

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容