代码提交规范 husky + commitlint + lint-staged

Posted 2023-04-23

参考技术A 依次在项目根目录执行如下两条命令

此时 husky 安装完成 ，根目录下生成了 .husky 文件夹

npm install -g @commitlint/cli @commitlint/config-conventional
至此，依赖安装完成

2在 .husky 文件夹下找到刚刚安装依赖生成好的 pre-commit 文件，添加 npx lint-staged

如果没有pre-commit 文件可以执行

3.在 .husky 文件夹下新建 commit-msg 文件，填入如下信息

如果没有commit-msg 文件可以执行

4.在项目根目录下新建 commitlint.config.js 文件 ，写入如下内容

至此，所有配置完成

新建一个不符合 Eslint 规则的文件，在进行 commit 提交时，会拒绝本次 commit
执行 npm run lint --fix 修复文件后 ，执行一条不符合规范的提交 git commit -m 'cesssss' ，同样会被拒绝提交，终端会显示错误信息

项目git commit时卡主不良代码：husky让Git检查代码规范化工作

防止将存在潜在问题的代码带到线上环境，最好的办法是在本地提交代码时就能够扫描出潜在的错误，并强制将其修改后才能提交，这样就不会将问题代码携带到线上，就能保证线上代码至少不会存在低级的程序错误。

防止将存在潜在问题的代码带到线上环境，最好的办法是在本地提交代码时就能够扫描出潜在的错误，并强制将其修改后才能提交，这样就不会将问题代码携带到线上，就能保证线上代码至少不会存在低级的程序错误。