Vue + Vetur + ESlint + Prettier 代码规范及格式化配置方案

问题

工作场景中,由于项目越来越大,参与人员越来越多,通过成员约定或Code Review的形式来保障代码规范的方式也会因为需要耗费较多的精力和工作时间,导致项目规范的执行变得越来越难以落地。

除此之外,从社区众多的代码规范风格中,挑选出一套适合团队所有人的,也需要耗费大量时间及习惯成本。把本就宝贵的开发时间以及成长时间,浪费在这些边角的事情上实在是觉得不值。

解决方案

所以,建立一套自动化的代码风格检查及格式化工具,节省团队成员精力,就变得更有意义和价值。让所有人都更关注代码和逻辑本身,让程序员去做有价值的事情,这正是Prettier这个工具本身所努力的方向。也与我们的开发体验上需求相契合。

想必大家都已对 Eslint 有所了解,但对 Prettier 相对陌生些。简单来说,Eslint 负责代码风格的检查,可以自定义较多的复杂检查规则,给出警告或报错,同时具有一部分帮助你纠正代码风格的能力(eslint --fix);Prettier 更加简单粗暴,直接扫描文件本身的 AST(抽象语法树),然后按照自己的格式化风格重新修改文件,也就是帮你进行完全的代码格式化,配置项简单,只要遵从它的风格就OK了。

基于此,我们引入Vue + Vetur + ESlint + Prettier | ESlint + Prettier 方案作为 Vue 项目和 JS-SDK 项目的代码风格审查及自动格式化方案。简单的思路就是通过 Vetur 来做 Vue 代码风格的检查比如template,style,Vetur 搭配 Eslint 检测 js 部分的代码风格, 调用 Prettier 进行代码风格的修正统一。

熟悉 Vscode 和 Eslint、 Prettier 的小伙伴可能知道 Vscode 的插件市场有这两个工具的插件。而且 npm 平台上 也有二者对应的工具包,到底选哪种好?很简单,对比一下:

npm 形式安装的工具包,都需要手动通过 npm run 对应的 npm-script 命令来执行

Vscode 插件可以结合编辑器本身,展示更友好、及时的错误提醒,保存即可格式化。

虽然,npm包工具结合 webpack 或者 gulp 这些工具也能达到保存即可格式化的效果,但还需要引入更多工具和设置,更费周张。那,第二种方式就成为了我们的首选方案了。

给出 Vscode 编辑器下的配置方案:

更新项目,并重新执行npm i

安装 Vscode 插件: editorconfig, Vetur, Eslint, Prettier

打开项目的设置: Ctrl + , (Mac : Cmd + ,) ,选择工作区设置,打开 setting.json 文件,把下面插件相关的配置拷贝入文件,并保存

{"eslint.validate": [{"language":"html","autoFix":true},    {"language":"vue","autoFix":true},    {"language":"javascript","autoFix":true},    {"language":"javascriptreact","autoFix":true}  ],"editor.formatOnSave":false,"eslint.autoFixOnSave":true,"vetur.validation.template":false,}

项目中新增了 .eslintrc.js 文件,可以联合 Eslint 和 Prettier 的使用

module.exports = {root:true,env: {node:true},extends: ["plugin:vue/recommended","eslint:recommended","plugin:prettier/recommended","prettier/vue"],rules: {"no-console": process.env.NODE_ENV ==="production"?"error":"off","no-debugger": process.env.NODE_ENV ==="production"?"error":"off","no-unused-vars":"off",// "no-extra-semi": "error",// "semi": ["error", "never"],"no-redeclare":"off","no-empty":"off","no-undef":"off","no-case-declarations":"off","vue/no-use-v-if-with-v-for":"off","vue/no-unused-components":"off",  },parserOptions: {parser:"babel-eslint"}};

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

推荐阅读更多精彩内容