vue项目git提交代码自动格式化

通常情况下,一个项目的开发由多个人员协作完成。而对于各个开发者来说,大家喜爱的编辑器不同,代码风格也不一致。导致每次在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.jsongitHooks 字段中方便地指定 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.多看官方文档。好多知识点不是看一遍就能看到的,更不要说记住。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容