前言
用vsCode开发Vue项目,Vetur插件是必装的,然后有时候为了格式化代码,我们还装了Prettier插件、ESLint插件,而且Vue CLI也装了ESLint,其实,都没必要。
格式规范大多是浮云
先了解一下ESLint的Airbnb、Standard、Prettier三个Lint规则:
1.Airbnb、Standard这两个要比Prettier严苛,它两个会对代码逻辑做约束,而Prettier很少从代码逻辑上考虑优化。也就是说,Airbnb、Standard会有很多无法自动修复的警告,需要你手动去修改。Prettier这方面的约束很少。
2.Airbnb、Standard对比的话,它俩最明显的区别是,Airbnb要求必须加行尾分号、函数名后面必须加空格,Standard则反之。如果你根据这两条来选择到底用哪个,我得说,你还是太年轻。因为这两者就是书写的小习惯,根本不算大事,你需要比较的是它们对业务代码的写法的约束。从我长期的使用对比来看,Standard比较好,因为Airbnb会让你把一些正确的写法改成错的、没法运行的写法,让你的代码由正常交付改成没法用,而且,Airbnb会让你把一些漂亮的写法改成丑陋的写法,简直就是越用越生气。
3.那么是不是Standard最后胜出?我还是得说,你还是太年轻。如果你明白“严苛的规范都是浮云,投入产出比不值”,恭喜你,你开窍了。要求团队成员把编程逻辑都统一起来,收益跟付出不成正比,这种统一编程逻辑的工作应当在闲时去专门学习。基本的代码格式,就交给Vetur插件,有事没事右键“格式化”一下,才是最高效率的做法,何况Prettier并不是不管语法,基本的语法约束还是有。而Standard的约束确实比Prettier多,但大多数是付出与回报不成正比的约束,所以,Airbnb、Standard都不要用。
结论
1.你要在“规则”跟“效率”之间取得一个平衡,这是总原则,而且,你的工资往往跟效率挂钩,而不是规则。
2.安装Vue CLI时采用“ESLint + Prettier”规则。
3.插件就安装Vetur,不要安装Prettier,因为Vetur包含Prettier,也不要安装ESLint插件,因为右键格式化可以纠正95%的格式问题,然后命令行提示可以提示剩下5%的问题,一旦安装ESLint插件,编辑器内会有各种的~~~波浪线提示,乱且没有必要。
有必要说一下,如果你除了处理*.vue文件,还要处理大量的HTML文件,那么还是应该装上Prettier插件,这样右击html文件格式化会很有效,而VS Code自带的formatter弱鸡到渣。
4.(可选)修改.eslintrc.js,把"plugin:vue/essential"改成"plugin:vue/recommended",充分发挥eslint-plugin-vue的约束。这条你可以不做,尤其是团队人少、都比较懂规矩的前提下。开启的话,你可以积攒一批错误,然后运行yarn lint --fix去修复一下。
配置 .prettierrc.js
配置参考文档:https://prettier.io/docs/en/options.html
module.exports = {
// 一行最多 120 字符
printWidth: 120,
// 行尾需要有分号
semi: true,
// 使用单引号
singleQuote: true,
// 对象的 key 仅在必要时用引号
quoteProps: 'as-needed',
// jsx 不使用单引号,而使用双引号
jsxSingleQuote: false,
// 末尾不需要逗号
trailingComma: 'none',
// 大括号内的首尾需要空格
bracketSpacing: true,
// jsx 标签的反尖括号需要换行
jsxBracketSameLine: false,
// 每个文件格式化的范围是文件的全部内容
rangeStart: 0,
rangeEnd: Infinity,
// 不需要写文件开头的 @prettier
requirePragma: false,
// 不需要自动在文件开头插入 @prettier
insertPragma: false,
// 使用默认的折行标准
// proseWrap: 'preserve',
// 根据显示样式决定 html 要不要折行
htmlWhitespaceSensitivity: 'css',
// 换行符使用 lf
endOfLine: 'lf'
};