vue项目代码检查工具 ESLint vs Prettier

说到vue的代码检查工具，离不开eslint的加持，经历过几个项目之后，发现eslint的配置也是千奇百怪的。

其实 eslint 的配置方式跟多个因素有关：vue/vue-cli 的版本、Airbnb/Standard/Prettier 的选择、js/ts 的选择、编辑器本地配置 等都有关系，下面就几种环境给出配置参考，具体的问题还需要结合项目特点进行修正。

1. vue2.6 + js + eslint standard

这种组合是我接触最多的，优点是所有的代码约束都通过 eslint 来约束，只需要关注 eslint 的配置项，比较简单易理解。

在新建一个vue项目时选择  ESLint + Standard config  模式即可。

? Check the features needed for your project: Choose Vue version, Babel, Linter
? Choose a version of Vue.js that you want to start the project with 2.x
? Pick a linter / formatter config:
  ESLint with error prevention only
  ESLint + Airbnb config
> ESLint + Standard config
  ESLint + Prettier

依赖的npm包： @vue/cli-plugin-eslint  |  @vue/eslint-config-standard  |  babel-eslint  |  eslint  |  eslint-plugin-import  |  eslint-plugin-node  |  eslint-plugin-promise  |  eslint-plugin-standard  |  eslint-plugin-vue

依赖的vscode插件：vuter  +  eslint

默认的配置在 .eslintrc.js 文件中：

module.exports = {
  root: true,
  env: {
    node: true
  },
  extends: [
    'plugin:vue/essential',
    '@vue/standard'
  ],
  parserOptions: {
    parser: 'babel-eslint'
  },
  rules: {
    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off'
  }
}

如果要增加修改一些配置，可以在rules中添加相关的规则，文章结尾我会列出常用的eslint配置。

eslint配置项：

• parser : 默认使用 Espree 作为其解析器，你可以在配置文件中指定一个不同的解析器。 esprima / babel-eslint / typescript-eslint-parser(实验)

• parserOptions :  这个属性常用于设置语法解析器的一些配置。可用的选项有：ecmaVersion: 指定 ECMAScript 的版本，默认设置为 3，5（默认）， 你可以使用 6、7、8 或 9 来指定你想要使用的 ECMAScript 版本

• sourceType : 源码类型，设置为 "script" (默认) 或 "module"（如果你的代码是 ECMAScript 模块)。

• ecmaFeatures :  这是个对象，表示你想使用的额外的语言特性:

  1. globalReturn - 允许在全局作用域下使用 return 语句。 false/true

  2. impliedStrict - 启用全局 strict mode (如果 ecmaVersion 是 5 或更高)。 false/true

  3. jsx - 启用 JSX。 false/true

  4. experimentalObjectRestSpread - 启用实验性的 object rest/spread properties 支持。 false/true

• globals : 我们使用第三方提供的全局变量的时候（例如：jQuery,AMap 等对象），ESLint 并不能识别他们，总是会报错。这个时候，该配置的作用就出现了。使用 globals 指出你要使用的全局变量。将变量设置为 true 将允许变量被重写，或 false 将不允许被重写。

• plugins-eslint : 支持使用第三方插件。在使用插件之前，你必须使用包管理工具安装它。 在配置文件里配置插件时，可以使用 plugins 关键字来存放插件名字的列表。插件名称可以省略 eslint-plugin- 前缀。

• extends : 一个配置文件可以从基础配置中继承已启用的规则。

standard 的默认格式是：

• 句尾没有分号；
• 强制单引号；
• 方法名后保留一个空格；
• 无拖尾逗号；

2. vue2.6 + js + eslint + prettier

这种组合的约束范围更广一些，像 vue、react这种本质上全靠render函数来渲染的框架来说，eslint可能完全适用了，这是因为eslint只能检测js语言的规范，而prettier可以检测多种语言的规范。

prettier 有一个核心的思想就是Opinionated，意思是大家都用我的配置就行了，不需要过多的自定义，所以prettier提供的可配置项很少，只有几个核心的常用的配置项。所以打算用prettier的话就不要费劲个性化配置了，否则会越来越糟糕。建议在eslint配置文件中仅定义一些语法错误的配置。

在新建一个vue项目时选择  ESLint + Prettier 模式即可。

? Check the features needed for your project: Choose Vue version, Babel, Linter
? Choose a version of Vue.js that you want to start the project with 2.x
? Pick a linter / formatter config:
  ESLint with error prevention only
  ESLint + Airbnb config
  ESLint + Standard config
> ESLint + Prettier

依赖的npm包： @vue/cli-plugin-eslint  |  @vue/eslint-config-prettier  |  babel-eslint  |  eslint  |  eslint-plugin-prettier  |  eslint-plugin-vue |  prettier

依赖的vscode插件：vuter  +  eslint

这里也不需要依赖 prettier 插件

默认的配置在 .eslintrc.js 文件中：

module.exports = {
  root: true,
  env: {
    node: true,
  },
  extends: ["plugin:vue/essential", "eslint:recommended", "@vue/prettier"],
  parserOptions: {
    parser: "babel-eslint",
  },
  rules: {
    "no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
    "no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off",
  },
};

prettier 的默认格式是：

• 句尾有分号；
• 强制双引号；
• 方法名后没有空格；
• 有拖尾逗号；

（貌似与esint默认行为正好相反...）

如果确实需要修改一些prettier的配置，可以在项目根目录新建 .prettierrc 文件，这时候就必须依赖vscode安装的prettier插件了！修改配置需重启vscode。

 

3. vue2.6 + vetur + js-beautify (待续)

 

.eslintrc.js

  // 0 代表关闭 - 'off'  1 代表警告 - 'warn'  2 代表开启 - 'error'
  rules: {
    'indent': ["error", 2], // 缩进
    'semi': [2, 'never'], // 分号
    'no-unused-vars': [
      'warn',
      { vars: 'all', args: 'none', ignoreRestSiblings: false },
    ],   // 未使用的变量会警告，忽略未使用的参数警告
    'new-cap': 'off', // 可以 new 一个以小写字母开头的构造函数
    'prefer-const': 'off', // 关闭强制 const
    'no-useless-call': 'off', // 关闭使用.call警告
    'no-useless-constructor': 'off', // 关闭空的contructor警告
    'handle-callback-err': 'off', // 关闭回掉 err 必须使用的警告
    'no-eval': 'off', // 关闭 eval 报错
    'prefer-rest-params': 'off', // 关闭使用 arguments 变量报错
    'no-unneeded-ternary': 'off', // 关闭三元表达式的报错
    'no-async-promise-executor': 1, //禁止使用异步函数作为 Promise executor
    'no-await-in-loop': 1, // 禁止使用 await async
    'no-console': 1, //禁用 console
    'no-debugger': 1, //禁用 debugger
    'no-dupe-args': 2, //函数参数不能重复
    'no-regex-spaces': 2, //禁止正则表达式字面量中出现多个空格
    'default-case': 2, //switch语句最后必须有default
    'no-alert': 0, //禁止使用alert confirm prompt
    'no-array-constructor': 1, //禁止使用数组构造器
    'no-bitwise': 0, //禁止使用按位运算符
    'no-caller': 0, //禁止使用arguments.caller或arguments.callee
    'no-catch-shadow': 2, //禁止catch子句参数与外部作用域变量同名
    'no-class-assign': 0, //禁止给类赋值
    'no-cond-assign': 0, //禁止在条件表达式中使用赋值语
    'no-const-assign': 0, //禁止修改const声明的变量
    'no-constant-condition': 0, //禁止在条件中使用常量表达式 if(true) if(1)
    'no-continue': 0, //禁止使用continue
    'no-control-regex': 2, //禁止在正则表达式中使用控制字符
    'no-delete-var': 2, //不能对var声明的变量使用delete操作符
    'no-div-regex': 1, //不能使用看起来像除法的正则表达式/=foo/
    'no-dupe-keys': 2, //在创建对象字面量时不允许键重复 {a:1,a:1}
    'no-duplicate-case': 2, //switch中的case标签不能重复
    'no-else-return': 0, //如果if语句里面有return,后面不能跟else语句
    'no-empty': 2, //块语句中的内容不能为空
    'no-empty-character-class': 2, //正则表达式中的[]内容不能为空
    'no-eq-null': 1, //禁止对null使用==或!=运算符
    'no-ex-assign': 2, //禁止给catch语句中的异常参数赋值
    'no-extend-native': 0, //禁止扩展native对象
    'no-extra-bind': 2, //禁止不必要的函数绑定
    'no-extra-boolean-cast': 2, //禁止不必要的bool转换
    'no-extra-parens': 2, //禁止非必要的括号
    'no-extra-semi': 2, //禁止多余的冒号
    'no-fallthrough': 1, //禁止switch穿透
    'no-floating-decimal': 2, //禁止省略浮点数中的0 .5 3.
    'no-func-assign': 2, //禁止重复的函数声明
    'no-implicit-coercion': 1, //禁止隐式转换
    'no-implied-eval': 2, //禁止使用隐式eval
    'no-inline-comments': 1, //禁止行内备注
    'no-inner-declarations': [0, 'functions'], //禁止在块语句中使用声明（变量或函数）
    'no-invalid-regexp': 2, //禁止无效的正则表达式
    'no-invalid-this': 2, //禁止无效的this，只能用在构造器，类，对象字面量
    'no-irregular-whitespace': 2, //不能有不规则的空格
    'no-iterator': 0, //禁止使用__iterator__ 属性
    'no-label-var': 2, //label名不能与var声明的变量名相同
    'no-labels': 0, //禁止标签声明
    'no-lone-blocks': 2, //禁止不必要的嵌套块
    'no-lonely-if': 1, //禁止else语句内只有if语句
    'no-loop-func': 1, //禁止在循环中使用函数（如果没有引用外部变量不形成闭包就可以）
    'no-mixed-requires': [0, false], //声明时不能混用声明类型
    'no-mixed-spaces-and-tabs': [2, false], //禁止混用tab和空格
    'linebreak-style': [0, 'windows'], //换行风格
    'no-multi-spaces': 1, //不能用多余的空格
    'no-multi-str': 2, //字符串不能用\换行
    'no-multiple-empty-lines': [1, {max: 2}], //空行最多不能超过2行
    'no-native-reassign': 0, //不能重写native对象
    'no-negated-in-lhs': 2, //in 操作符的左边不能有!
    'no-nested-ternary': 0, //禁止使用嵌套的三目运算
    'no-new': 1, //禁止在使用new构造一个实例后不赋值
    'no-new-func': 1, //禁止使用new Function
    'no-new-object': 1, //禁止使用new Object()
    'no-new-require': 1, //禁止使用new require
    'no-new-wrappers': 1, //禁止使用new创建包装实例，new String new Boolean new Number
    'no-obj-calls': 0, //不能调用内置的全局对象，比如Math() JSON()
    'no-octal': 2, //禁止使用八进制数字
    'no-octal-escape': 2, //禁止使用八进制转义序列
    'no-param-reassign': 0, //禁止给参数重新赋值
    'no-path-concat': 0, //node中不能使用__dirname或__filename做路径拼接
    'no-plusplus': 1, //禁止使用++，--
    'no-process-env': 0, //禁止使用process.env
    'no-process-exit': 0, //禁止使用process.exit()
    'no-proto': 0, //禁止使用__proto__属性
    'no-redeclare': 2, //禁止重复声明变量
    'no-restricted-modules': 0, //如果禁用了指定模块，使用就会报错
    'no-return-assign': 1, //return 语句中不能有赋值表达式
    'no-script-url': 0, //禁止使用javascript:void(0)
    'no-self-compare': 2, //不能比较自身
    'no-sequences': 0, //禁止使用逗号运算符
    'no-shadow': 2, //外部作用域中的变量不能与它所包含的作用域中的变量或参数同名
    'no-shadow-restricted-names': 2, //严格模式中规定的限制标识符不能作为声明时的变量名使用
    'no-spaced-func': 2, //函数调用时 函数名与()之间不能有空格
    'no-sparse-arrays': 2, //禁止稀疏数组， [1,,2]
    'no-sync': 0, //nodejs 禁止同步方法
    'no-ternary': 0, //禁止使用三目运算符
    'no-trailing-spaces': 1, //一行结束后面不要有空格
    'no-this-before-super': 0, //在调用super()之前不能使用this或super
    'no-throw-literal': 1, //禁止抛出字面量错误 throw "error";
    'no-undef': 1, //不能有未定义的变量
    'no-undef-init': 1, //变量初始化时不能直接给它赋值为undefined
    'no-undefined': 1, //不能使用undefined
    'no-unexpected-multiline': 2, //避免多行表达式
    'no-underscore-dangle': 1, //标识符不能以_开头或结尾
    'no-unreachable': 2, //不能有无法执行的代码
    'no-unused-expressions': 2, //禁止无用的表达式
    'no-unused-vars': [2, {vars: 'all', args: 'after-used'}], //不能有声明后未被使用的变量或参数
    'no-use-before-define': 2, //未定义前不能使用
    'no-void': 2, //禁用void操作符
    'no-var': 0, //禁用var，用let和const代替
    'space-before-function-paren': [0, 'always'], // 函数定义时括号前面要不要有空格
    'spaced-comment': 0, // 注释风格要不要有空格
    'use-isnan': 2, // 禁止比较时使用NaN，只能用isNaN()
  }

.prettierrc 文件

"useTabs": false,
"tabWidth": 2,
"printWidth": 100, // 每行代码长度（默认80）
"eslintIntegration": true,
"stylelintIntegration": true,
"singleQuote": true, // 使用单引号（默认false）
"semi": false, // 声明结尾使用分号(默认true)
"insertPragma": false,
"trailingComma": "none", // 多行使用拖尾逗号（默认none） none | all
"arrowParens": "avoid", // 箭头函数参数括号 默认avoid 可选 avoid | always
"jsxBracketSameLine": false, // 多行JSX中的>放置在最后一行的结尾，而不是另起一行（默认false）
"bracketSpacing": true, // 对象字面量的大括号间使用空格（默认true）