使用husky给项目添加git提交前的代码格式化,使团队代码格式统一

绝地灬酷狼 2023-02-14 13:23 5阅读 0赞

## 首先我们先了解一下husky ##

> husky 其实就是一个为 git 客户端增加 hook 的工具。将其安装到所在仓库的过程中它会自动在 .git/ 目录下增加相应的钩子实现在 pre-commit 阶段就执行一系列流程保证每一个 commit 的正确性。部分在 cd commit stage 执行的命令可以挪动到本地执行，比如 lint 检查、比如单元测试。当然，pre-commit 阶段执行的命令当然要保证其速度不要太慢，每次 commit 都等很久也不是什么好的体验。

## 安装插件 ##

yarn add husky pretty-quick prettier vcm-cli --save	
    	|| cnpm i husky pretty-quick prettier vcm-cli --save

## 新建配置文件 .prettierrc 根据自己需要配置 ##

{ 
    	  "singleQuote": true,
    	  "trailingComma": "all",
    	  "printWidth": 100,
    	  "proseWrap": "never",
    	  "overrides": [
    	    { 
    	      "files": ".prettierrc",
    	      "options": { 
    	        "parser": "json"
    	      }
    	    }
    	  ]
    	}

## 配置package.json ##

"husky": {
    	    "hooks": {
    	      "pre-commit": "pretty-quick --staged",
    	      "commit-msg": "vcm"
    	    }
    	  },

# 尝试 #

git commit -am “a”  
此时的提示页面如下  
具体规则可以在  
[https://shudong.wang/10647.html][https_shudong.wang_10647.html]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Vhc3lDbHViX2hhbmppeGlu_size_16_color_FFFFFF_t_70]  
成功界面  
![在这里插入图片描述][20200603101444915.png]  
节省下的时间可以去玩耍了

[https_shudong.wang_10647.html]: https://shudong.wang/10647.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Vhc3lDbHViX2hhbmppeGlu_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200603101259578.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Vhc3lDbHViX2hhbmppeGlu,size_16,color_FFFFFF,t_70
[20200603101444915.png]: https://img-blog.csdnimg.cn/20200603101444915.png