通常情况下,一个项目的开发由多个人员协作完成。而对于各个开发者来说,大家喜爱的编辑器不同,代码风格也不一致。导致每次在git提交的时候看起来就像进行了大幅度的修改,为了方便代码的管理,我们可以在git提交的时候进行代码的自动格式化。
接下来,讲一下我的解决问题全过程。
1.出于项目需要,开始查找解决办法
网上大部分都是关于通过以下命令安装依赖然后进行配置
npm安装:
npm install --save-dev prettier husky lint-staged eslint
yarn安装
yarn add prettier husky lint-staged eslint --dev
具体步骤大家可以参考以下链接,不过我使用这个方法并没有成功。
代码提交git时自动格式化并通过ESlint检测
2.更换安装依赖方式,继续查找
我所开发的项目用的是yarn管理版本依赖,后来进行各种查找尝试有一篇文章说换成npm试一下,果断更换,还是没起作用。没办法,只能继续查找。
3.记得阅读官方文档,安装yorkie
开始阅读官方文档,发现一个重要的知识点。
在安装之后,
@vue/cli-service
也会安装 yorkie,它会让你在package.json
的gitHooks
字段中方便地指定 Git hook
eslint由于项目本身就有使用,所以看到这个之后我马上就把prettier husky lint-staged这三个依赖进行了卸载,package.json中代码变成了这样:
"scripts": {
......
"lint": "vue-cli-service lint"
},
"gitHooks": {
"pre-commit": "lint-staged"
},
"dependencies": {
"vue": "^2.6.10",
......
}
开始提交代码,运行git commit时出现乱码,本来是想解决掉乱码问题的,后来无法解决,只好继续解决格式化的问题。
文档中提到yorkie
fork 自 husky
,但是之前我对husky进行了几次的安装与卸载,会不会造成一些可能出现的错误。在husky卸载的情况下,对yorkie进行了安装。
乱码问题依旧存在。
4.安装lint-staged
想到之前按照其他方案解决问题的时候,package.json中除了增加husky的配置,还增加了lint-staged的配置,那么自己是不是因为只加了gitHooks的配置呢。
在package.json中增加lint-staged的配置(需要安装lint-staged依赖):
"scripts": {
......
"lint": "vue-cli-service lint"
},
"gitHooks": {
"pre-commit": "lint-staged"
},
"lint-staged": {
"*.{js,vue}": [ //标注
"eslint --fix",
"git add"
]
},
"dependencies": {
"vue": "^2.6.10",
......
}
修改文件,提交,成功。
如果想要继续安装prettier依赖也可以,安装之后可以在我上面lint-staged配置标注的下一行加入如下代码
"prettier --single-quote --write '*.{vue}'", //*.{vue}匹配所有的vue文件,可以进行修改
后来仔细看了一下,这个的确可以解决一部分问题,但是有些问题好像依然存在,有时间再继续排查是哪里的问题。欢迎大家留言进行讨论。
参考:
1.代码提交git时自动格式化并通过ESlint检测
2.Vue CLI文档
3.ESLint官方文档
4.过滤文件
5.prettier CLI
总结:
1.保持耐心。问题解决不出来的时候千万不能着急。
2.勇于尝试。多动手,不要只是在脑子里想想,说不定就成功了呢。
3.多看官方文档。好多知识点不是看一遍就能看到的,更不要说记住。