vue cli4之Eslint初使用

快来打我* 2022-12-03 09:55 144阅读 0赞

### 一.介绍 ###

ESLint 是在 ECMAScript/JavaScript 代码中识别和报告模式匹配的工具，它的目标是保证代码的一致性和避免错误。在许多方面，它和 JSLint、JSHint 相似，除了少数的例外：

*  ESLint 使用 Espree 解析 JavaScript。
 *  ESLint 使用 AST 去分析代码中的模式
 *  ESLint 是完全插件化的。每一个规则都是一个插件并且你可以在运行时添加更多的规则。

### 二.使用 ###

##### 1.安装 #####

"devDependencies": { 
        "@vue/eslint-config-prettier": "^6.0.0",
        "babel-eslint": "^10.1.0",
        "eslint": "^6.7.2",
        "eslint-plugin-prettier": "^3.1.3",
        "eslint-plugin-vue": "^7.0.0-0",
      },

##### 2.配置 #####

（1）配置文件

*  配置可以使用项目下.eslintrc文件，文件支持 .js .yaml .yal .json等格式的配置文件
 *  在 package.json 里的eslintConfig配置
 *  如果 .eslintrc.js 和 package.json里的 eslintConfig 同时存在，则只会读取 .eslintrc文件

（2）在package.json文件中eslintConfig属性标签下，默认配置如下

"eslintConfig": { 
        "root": true,
        "env": { 
          "node": true
        },
        "extends": [
          "plugin:vue/vue3-essential",
          "eslint:recommended",
          "@vue/prettier"
        ],
        "parserOptions": { 
          "parser": "babel-eslint"
        },
        "rules": { 
        }
      },

相关参数介绍

*  root  
    默认情况下，ESLint 会在所有父级目录里寻找配置文件，一直到根目录。如果发现配置文件中有 “root”: true，它就会停止在父级目录中寻找。
 *  env  
    使用 env 关键字指定你想启用的环境。

env: { 
        es6: true, // 启用 ES6 语法支持以及新的 ES6 全局变量或类型
        node: true, // Node.js 全局变量和 Node.js 作用域
        browser: true, // 浏览器全局变量
        jquery: true, // jQuery 全局变量
      }

*  extends  
    配置代码规范，比如：“eslint:recommended” 的 extends 属性启用了eslint默认的规则
 *  parserOptions

parserOptions: { 
        parser: 'babel-eslint', // 解析器，默认使用Espree
        ecmaVersion: 6, // 支持es6语法，但并不意味着同时支持新的 ES6 全局变量或类型（比如 Set 等新类型）
        sourceType: 'module', // 指定来源的类型，"script" (默认) 或 "module"（如果你的代码是 ECMAScript 模块)
        // 使用的额外的语言特性
        ecmaFeatures: { 
          jsx: true, // 启用 JSX
          globalReturn: true, // 允许在全局作用域下使用 return 语句
          impliedStrict: true, // 启用全局 strict mode (如果 ecmaVersion 是 5 或更高)
          experimentalObjectRestSpread: true, // 启用实验性的 object rest/spread properties 支持。(重要：这是一个实验性的功能,在未来可能会有明显改变。 建议你写的规则 不要 依赖该功能，除非当它发生改变时你愿意承担维护成本。)
        },
      }

*  rules  
    可以在rules选项中设置，设置的规则将覆盖上面继承的默认规则。要改变一个规则设置，你必须将规则 ID 设置为下列值之一：

> “off” 或 0 - 关闭规则  
> “warn” 或 1 - 开启规则，使用警告级别的错误：warn (不会导致程序退出)  
> “error” 或 2 - 开启规则，使用错误级别的错误：error (当被触发的时候，程序会退出)

##### 3.检测开关 #####

配置Eslint检测开关，则在vue.config.js中配置

module.exports = { 
      lintOnSave: false,//false代表关闭，true代表开启
    };

##### 4.示例 #####

以下为添加规则no-console属性为2，代表开启规则，为错误级别

项目中，如果写入console，则该行将有错误提示  
![在这里插入图片描述][2020090311324012.png_pic_center]  
如果no-console为1，则该行将有警告提示  
![在这里插入图片描述][20200903113423101.png_pic_center]  
如果no-console为0，则将关闭该规则  
![在这里插入图片描述][20200903113454801.png_pic_center]

##### 4.常用规则 #####

'rules': { 
       "comma-dangle": ["error", "never"], //是否允许对象中出现结尾逗号
       "no-cond-assign": 2, //条件语句的条件中不允许出现赋值运算符
       "no-console": 2, //不允许出现console语句
       "no-constant-condition": 2, //条件语句的条件中不允许出现恒定不变的量
       "no-control-regex": 2, //正则表达式中不允许出现控制字符
       "no-debugger": 2, //不允许出现debugger语句
       "no-dupe-args": 2, //函数定义的时候不允许出现重复的参数
       "no-dupe-keys": 2, //对象中不允许出现重复的键
       "no-duplicate-case": 2, //switch语句中不允许出现重复的case标签
       "no-empty": 2, //不允许出现空的代码块
       "no-empty-character-class": 2, //正则表达式中不允许出现空的字符组
       "no-ex-assign": 2, //在try catch语句中不允许重新分配异常变量
       "no-extra-boolean-cast": 2, //不允许出现不必要的布尔值转换
       "no-extra-parens": 0, //不允许出现不必要的圆括号
       "no-extra-semi": 2, //不允许出现不必要的分号
       "no-func-assign": 2, //不允许重新分配函数声明
       "no-inner-declarations": ["error", "functions"], //不允许在嵌套代码块里声明函数
       "no-invalid-regexp": 2, //不允许在RegExp构造函数里出现无效的正则表达式
       "no-irregular-whitespace": 2, //不允许出现不规则的空格
       "no-negated-in-lhs": 2, //不允许在in表达式语句中对最左边的运算数使用取反操作
       "no-obj-calls": 2, //不允许把全局对象属性当做函数来调用
       "no-regex-spaces": 2, //正则表达式中不允许出现多个连续空格
       "quote-props": 2, //对象中的属性名是否需要用引号引起来
       "no-sparse-arrays": 2, //数组中不允许出现空位置
       "no-unreachable": 2, //在return，throw，continue，break语句后不允许出现不可能到达的语句
       "use-isnan": 2, //要求检查NaN的时候使用isNaN()
       "valid-jsdoc": ["error", { 
         "requireReturn": false,
         "requireParamDescription": false,
         "requireReturnDescription": true
       }], //强制JSDoc注释
       "valid-typeof": ["error", { 
         "requireStringLiterals": true
       }], //在使用typeof表达式比较的时候强制使用有效的字符串
       "block-scoped-var": 2, //将变量声明放在合适的代码块里
       "complexity": 0, //限制条件语句的复杂度
       "consistent-return": 2, //无论有没有返回值都强制要求return语句返回一个值
       "curly": ["error", "all"], //强制使用花括号的风格
       "default-case": 0, //在switch语句中需要有default语句
       "dot-notation": ["error", { "allowKeywords": false, "allowPattern": ""}], //获取对象属性的时候使用点号
       "eqeqeq": ["error", "smart"], //比较的时候使用严格等于
       "no-alert": 1, //不允许使用alert，confirm，prompt语句
       "no-caller": 2, //不允许使用arguments.callee和arguments.caller属性
       "guard-for-in": 0, //监视for in循环，防止出现不可预料的情况
       "no-div-regex": 2, //不能使用看起来像除法的正则表达式
       "no-else-return": 0, //如果if语句有return，else里的return不用放在else里
       "no-labels": ["error", { 
         "allowLoop": false,
         "allowSwitch": false
       }], //不允许标签语句
       "no-eq-null": 2, //不允许对null用==或者!=
       "no-eval": 2, //不允许使用eval()
       "no-extend-native": 2, //不允许扩展原生对象
       "no-extra-bind": 2, //不允许不必要的函数绑定
       "no-fallthrough": 2, //不允许switch按顺序全部执行所有case
       "no-floating-decimal": 2, //不允许浮点数缺失数字
       "no-implied-eval": 2, //不允许使用隐式eval()
       "no-iterator": 2, //不允许使用__iterator__属性
       "no-lone-blocks": 2, //不允许不必要的嵌套代码块
       "no-loop-func": 2, //不允许在循环语句中进行函数声明
       "no-multi-spaces": 2, //不允许出现多余的空格
       "no-multi-str": 2, //不允许用\来让字符串换行
       "no-global-assign": 2, //不允许重新分配原生对象
       "no-new": 2, //不允许new一个实例后不赋值或者不比较
       "no-new-func": 2, //不允许使用new Function
       "no-new-wrappers": 2, //不允许使用new String，Number和Boolean对象
       "no-octal": 2, //不允许使用八进制字面值
       "no-octal-escape": 2, //不允许使用八进制转义序列
       "no-param-reassign": 0, //不允许重新分配函数参数"no-proto": 2, //不允许使用__proto__属性
       "no-redeclare": 2, //不允许变量重复声明
       "no-return-assign": 2, //不允许在return语句中使用分配语句
       "no-script-url": 2, //不允许使用javascript:void(0)
       "no-self-compare": 2, //不允许自己和自己比较
       "no-sequences": 2, //不允许使用逗号表达式
       "no-throw-literal": 2, //不允许抛出字面量错误 throw "error"
       "no-unused-expressions": 2, //不允许无用的表达式
       "no-void": 2, //不允许void操作符
       "no-warning-comments": [1, { "terms": ["todo", "fixme", "any other term"]}], //不允许警告备注
       "no-with": 2, //不允许使用with语句
       "radix": 1, //使用parseInt时强制使用基数来指定是十进制还是其他进制
       "vars-on-top": 0, //var必须放在作用域顶部
       "wrap-iife": [2, "any"], //立即执行表达式的括号风格
       "yoda": [2, "never", { "exceptRange": true}], //不允许在if条件中使用yoda条件
       "strict": [2, "function"], //使用严格模式
       "no-catch-shadow": 2, //不允许try catch语句接受的err变量与外部变量重名"no-delete-var": 2, //不允许使用delete操作符
       "no-label-var": 2, //不允许标签和变量同名
       "no-shadow": 2, //外部作用域中的变量不能与它所包含的作用域中的变量或参数同名
       "no-shadow-restricted-names": 2, //js关键字和保留字不能作为函数名或者变量名
       "no-undef": 2, //不允许未声明的变量
       "no-undef-init": 2, //不允许初始化变量时给变量赋值undefined
       "no-undefined": 2, //不允许把undefined当做标识符使用
       "no-unused-vars": [2, { "vars": "all", "args": "after-used"}], //不允许有声明后未使用的变量或者参数
       "no-use-before-define": [2, "nofunc"], //不允许在未定义之前就使用变量"indent": 2, //强制一致的缩进风格
       "brace-style": [2, "1tbs", {  "allowSingleLine": false}], //大括号风格
       "camelcase": [2, { "properties": "never"}], //强制驼峰命名规则
       "comma-style": [2, "last"], //逗号风格
       "consistent-this": [0, "self"], //当获取当前环境的this是用一样的风格
       "eol-last": 2, //文件以换行符结束
       "func-names": 0, //函数表达式必须有名字
       "func-style": 0, //函数风格，规定只能使用函数声明或者函数表达式
       "key-spacing": [2, { "beforeColon": false, "afterColon": true}], //对象字面量中冒号的前后空格
       "max-nested-callbacks": 0, //回调嵌套深度
       "new-cap": [2, { "newIsCap": true, "capIsNew": false}], //构造函数名字首字母要大写
       "new-parens": 2, //new时构造函数必须有小括号
       "newline-after-var": 0, //变量声明后必须空一行
       "no-array-constructor": 2, //不允许使用数组构造器
       "no-inline-comments": 0, //不允许行内注释
       "no-lonely-if": 0, //不允许else语句内只有if语句
       "no-mixed-spaces-and-tabs": [2, "smart-tabs"], //不允许混用tab和空格
       "no-multiple-empty-lines": [2, { "max": 2}], //空行最多不能超过两行
       "no-nested-ternary": 2, //不允许使用嵌套的三目运算符
       "no-new-object": 2, //禁止使用new Object()
       "fun-call-spacing": 2, //函数调用时，函数名与()之间不能有空格
       "no-ternary": 0, //不允许使用三目运算符
       "no-trailing-spaces": 2, //一行最后不允许有空格
       "no-underscore-dangle": 2, //不允许标识符以下划线开头
       "no-extra-parens": 0, //不允许出现多余的括号
       "one-var": 0, //强制变量声明放在一起
       "operator-assignment": 0, //赋值运算符的风格
       "padded-blocks": [2, "never"], //块内行首行尾是否空行
       "quote-props": 0, //对象字面量中属性名加引号
       "quotes": [1, "single", "avoid-escape"], //引号风格
       "semi": [2, "always"], //强制语句分号结尾
       "semi-spacing": [2, { "before": false, "after": true}], //分后前后空格
       "sort-vars": 0, //变量声明时排序
       "space-before-blocks": [2, "always"], //块前的空格
       "space-before-function-paren": [2, { "anonymous": "always", "named": "never"}], //函数定义时括号前的空格
       "space-infix-ops": [2, { "int32Hint": true}], //操作符周围的空格
       "keyword-spacing": 2, //关键字前后的空格
       "space-unary-ops": [2, {  "words": true, "nonwords": false}], //一元运算符前后不要加空格
       "wrap-regex": 2, //正则表达式字面量用括号括起来
       "no-var": 0, //使用let和const代替var
       "generator-star-spacing": [2, "both"], //生成器函数前后空格
       "max-depth": 0, //嵌套块深度
       "max-len": 0, //一行最大长度，单位为字符
       "max-params": 0, //函数最多能有多少个参数
       "max-statements": 0, //函数内最多有几个声明
       "no-bitwise": 0, //不允许使用位运算符
       "no-plusplus": 0 //不允许使用++ --运算符
     }

更多规则以及详情查看文档

> https://eslint.org/docs/rules/

[2020090311324012.png_pic_center]: /images/20221123/bddbf808be6d40fca762743412322da1.png
[20200903113423101.png_pic_center]: /images/20221123/a837d5cc22b449aa8350fb9cd8995d36.png
[20200903113454801.png_pic_center]: /images/20221123/204f09c4b6484184a62b11f69db84919.png