git + prettier + husky 格式化提交

162 阅读1分钟

git + prettier + husky

用到的工具:husky + prettier + lint-staged
项目中,我们基于当前node版本使用对应的husky以及lint-staged,一般情况直接使用最新版本就好。
一、husky可以让我们向项目中方便添加git hooks。可以监听每次git commit提交,同时可以在git commit时候执行一些操作,比如格式化代码,单元测试。在这里主要介绍格式化代码。
1.npm install -D husky@4.3.0
执行 npx husky add .husky/pre-commit "npm run test"
运行完该命令后我们会看到.husky/目录下新增了一个名为pre-commit的shell脚本。
这个pre-commit文件里面需要更改一下执行地址,“node_modules/.bin/lint-staged”
上面都完成之后就需要在package.json文件中新增如下图的一句执行语句,prepare这个是执行npm install 之后默认执行。

2.在package.json文件中如下配置:

具体参考:zhuanlan.zhihu.com/p/366786798
二、lint-staged 对git暂存的文件进行lint检查
1.npm install -D lint-staged@10.4.0
2.在package.json文件中如下配置:

3.具体参考:www.cnblogs.com/jiaoshou/p/…
三、prettierrc 代码格式化模块,和vscode上安装的Vetur扩展工具使用的格式化相同
1npm install prettierrc
2在根目录创建文件 .prettierrc

具体配置可参考可视化配置:prettier.io/playground/

若有收获,就点个赞吧