一、用 eslint 进行语法检查
步骤:
- 安装 eslint
npm i -g eslint
- 命令行输入 “eslint --init” 自动生成 .eslintrc.json
输入 eslint --init 以后可以选以下配置:
有了 eslint 配置文件以后,VSCode 会自动检查规范。- 配置 package.json 的 scripts,方便以后使用
"scripts": { "lint": "eslint src" }
-
执行 npm run lint 进行代码检查,代码检查不通过控制台则会报错:
- 加上 --fix 参数可以自动修复
eslint index.js --fix
三、webpack 打包时进行语法检查
1. 安装eslint
// 全局安装
npm i -g eslint
// 当然也可以局部安装
npm i -D eslint
2. 安装依赖包
npm i -D eslint-config-airbnb eslint-plugin-jsx-a11y eslint-plugin-import eslint-plugin-react babel-eslint eslint-loader eslint-plugin-babel
- eslint-config-airbnb:Airbnb的标准(配置文件的extends里没用airbnb的话可以不装)
- eslint-plugin-jsx-a11y:Airbnb标准必需
- eslint-plugin-import:Airbnb标准必需。用来校验 import 的,比如不能加 .js 后缀。
- eslint-plugin-react:支持 react 语法
- eslint-plugin-vue: 支持 vue 语法
- babel-eslint: 兼容ES处于实验性阶段的语法,如类属性用”=“赋值。
- eslint-loader:在webpack中解析
- eslint-plugin-babel:兼容处于实验阶段的特征
3. 创建 .eslintrc.js
可以用 eslint --init 命令自动生成,也可以自己新建。
控制台输入 eslint --init 命令后会进入问答模式,问答模式的最后一步会问你是否安装依赖,如果你的项目中的依赖都是用 cnpm 安装的,那这一步就选择不要自动安装(自动安装的话会用 npm 安装,会出现很多依赖不兼容的问题),等问答模式结束生成 .eslintrc.js 文件后,用 cnpm 手动安装刚才问答模式中提示需要安装的依赖。
init 时提供3种预安装包的区别:
- Google标准,就是Google公司的标准。
- Airbnb标准,Airbnb公司的标准(公认最好的标准)。
- Standard标准,就是一些前端工程师自定的标准。
4. 配置 webpack.config.js
这个配置了以后,用 webpack-dev-server 起的服务会用 eslint 对代码进行检验,并把检验结果输出在控制台。
rules: [
{
test: /\.jsx?$/,
enforce: 'pre',
loader: "eslint-loader",
include: /src/
}
],
四、.eslintrc.js 的配置
rules 规则语法:
// 配置参数
rules: {
"规则名1": [规则值, 规则配置],
"规则名2": [规则值, 规则配置]
}
rules 中的规则等级:
- "off" 或 0 - 关闭规则
- "warn" 或 1 - 开启规则,使用警告级别的错误:warn (不会导致程序退出)
- "error" 或 2 - 开启规则,使用错误级别的错误:error (当被触发的时候,程序会退出)
module.exports = {
// 指定脚本的运行环境,一个环境定义了一组预定义的全局变量
"env": {
"browser": true, //浏览器环境中的全局变量
// "es6": true, //启用除了modules以外的所有ES6特性(该选项会自动设置 ecmaVersion 解析器选项为 6)
"es2021": true,
"node": true, //Node.js 全局变量和 Node.js 作用域
"jquery": true,
},
"extends": [
"eslint:recommended", //所有在规则页面被标记为“✔️”的规则将会默认开启
"plugin:vue/essential", // Vue 基本的规则
"plugin:react/recommended" // React 推荐的规则
],
// 设置全局变量
"globals": {
"API": true,
"Vue": true,
// "Highcharts": true,
},
// 指定解析器
"parser": "babel-eslint", //兼容ES处于实验性阶段的语法,如类属性用”=“赋值
// 指定解析器选项
"parserOptions": {
"ecmaFeatures": {
"jsx": true,
"generators": true,
"experimentalObjectRestSpread": true
},
"ecmaVersion": "latest",
"sourceType": "module"
},
// 第三方插件
"plugins": [
"vue",
"react",
"class-property" // 兼容class的实例属性
],
"settings": {
'import/resolver': {
// 识别 webpack 配置的路径别名
webpack: {
config: 'webpack.config.js',
}
},
},
"rules": {
"no-alert": 0,//禁止使用alert confirm prompt
"no-array-constructor": 2,//禁止使用数组构造器
"no-bitwise": 0,//禁止使用按位运算符
"no-caller": 1,//禁止使用arguments.caller或arguments.callee
"no-catch-shadow": 2,//禁止catch子句参数与外部作用域变量同名
"no-class-assign": 2,//禁止给类赋值
"no-cond-assign": 2,//禁止在条件表达式中使用赋值语句
"no-console": 2,//禁止使用console
"no-const-assign": 2,//禁止修改const声明的变量
"no-constant-condition": 2,//禁止在条件中使用常量表达式 if(true) if(1)
"no-continue": 0,//禁止使用continue
"no-control-regex": 2,//禁止在正则表达式中使用控制字符
"no-debugger": 2,//禁止使用debugger
"no-delete-var": 2,//不能对var声明的变量使用delete操作符
"no-div-regex": 1,//不能使用看起来像除法的正则表达式/=foo/
"no-dupe-keys": 2,//在创建对象字面量时不允许键重复 {a:1,a:1}
"no-dupe-args": 2,//函数参数不能重复
"no-duplicate-case": 2,//switch中的case标签不能重复
"no-else-return": 2,//如果if语句里面有return,后面不能跟else语句
"no-empty": 2,//块语句中的内容不能为空
"no-empty-character-class": 2,//正则表达式中的[]内容不能为空
"no-empty-label": 2,//禁止使用空label
"no-eq-null": 2,//禁止对null使用==或!=运算符
"no-eval": 1,//禁止使用eval
"no-ex-assign": 2,//禁止给catch语句中的异常参数赋值
"no-extend-native": 2,//禁止扩展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": 0,//禁止行内备注
"no-inner-declarations": [2, "functions"],//禁止在块语句中使用声明(变量或函数)
"no-invalid-regexp": 2,//禁止无效的正则表达式
"no-invalid-this": 2,//禁止无效的this,只能用在构造器,类,对象字面量
"no-irregular-whitespace": 2,//不能有不规则的空格
"no-iterator": 2,//禁止使用__iterator__ 属性
"no-label-var": 2,//label名不能与var声明的变量名相同
"no-labels": 2,//禁止标签声明
"no-lone-blocks": 2,//禁止不必要的嵌套块
"no-lonely-if": 2,//禁止else语句内只有if语句
"no-loop-func": 1,//禁止在循环中使用函数(如果没有引用外部变量不形成闭包就可以)
"no-mixed-requires": [0, false],//声明时不能混用声明类型
"no-mixed-spaces-and-tabs": 1,//禁止混用tab和空格
"linebreak-style": [0, "windows"],//换行风格
"no-multi-spaces": 1,//不能用多余的空格
"no-multi-str": 2,//字符串不能用\换行
"no-multiple-empty-lines": [1, {"max": 2}],//空行最多不能超过2行
"no-native-reassign": 2,//不能重写native对象
"no-negated-in-lhs": 2,//in 操作符的左边不能有!
"no-nested-ternary": 0,//禁止使用嵌套的三目运算
"no-new": 1,//禁止在使用new构造一个实例后不赋值
"no-new-func": 1,//禁止使用new Function
"no-new-object": 2,//禁止使用new Object()
"no-new-require": 2,//禁止使用new require
"no-new-wrappers": 2,//禁止使用new创建包装实例,new String new Boolean new Number
"no-obj-calls": 2,//不能调用内置的全局对象,比如Math() JSON()
"no-octal": 2,//禁止使用八进制数字
"no-octal-escape": 2,//禁止使用八进制转义序列
"no-param-reassign": 2,//禁止给参数重新赋值
"no-path-concat": 0,//node中不能使用__dirname或__filename做路径拼接
"no-plusplus": 0,//禁止使用++,--
"no-process-env": 0,//禁止使用process.env
"no-process-exit": 0,//禁止使用process.exit()
"no-proto": 2,//禁止使用__proto__属性
"no-redeclare": 2,//禁止重复声明变量
"no-regex-spaces": 2,//禁止在正则表达式字面量中使用多个空格 /foo bar/
"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": 2,//禁止抛出字面量错误 throw "error";
"no-undef": 1,//不能有未定义的变量
"no-undef-init": 2,//变量初始化时不能直接给它赋值为undefined
"no-undefined": 2,//不能使用undefined
"no-unexpected-multiline": 2,//避免多行表达式
"no-underscore-dangle": 1,//标识符不能以_开头或结尾
"no-unneeded-ternary": 2,//禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
"no-unreachable": 2,//不能有无法执行的代码
"no-unused-expressions": 2,//禁止无用的表达式
"no-unused-vars": [1, {"vars": "all", "args": "after-used"}],//不能有声明后未被使用的变量或参数
"no-use-before-define": 2,//未定义前不能使用
"no-useless-call": 2,//禁止不必要的call和apply
"no-void": 2,//禁用void操作符
"no-var": 0,//禁用var,用let和const代替
"no-warning-comments": [1, { "terms": ["todo", "fixme", "xxx"], "location": "start" }],//不能有警告备注
"no-with": 2,//禁用with
"array-bracket-spacing": [2, "never"],//是否允许非空数组里面有多余的空格
"arrow-parens": 0,//箭头函数用小括号括起来
"arrow-spacing": 0,//=>的前/后括号
"accessor-pairs": 0,//在对象中使用getter/setter
"block-scoped-var": 0,//块语句中使用var
"brace-style": [1, "1tbs"],//大括号风格
"callback-return": 1,//避免多次调用回调什么的
"camelcase": 2,//强制驼峰法命名
"comma-dangle": 1,//对象字面量项尾不能有逗号
"comma-spacing": 0,//逗号前后的空格
"comma-style": [2, "last"],//逗号风格,换行时在行首还是行尾
"complexity": [0, 11],//循环复杂度
"computed-property-spacing": [0, "never"],//是否允许计算后的键名什么的
"consistent-return": 0,//return 后面是否允许省略
"consistent-this": [2, "that"],//this别名
"constructor-super": 0,//非派生类不能调用super,派生类必须调用super
"curly": [2, "all"],//必须使用 if(){} 中的{}
"default-case": 2,//switch语句最后必须有default
"dot-location": 0,//对象访问符的位置,换行的时候在行首还是行尾
"dot-notation": [0, { "allowKeywords": true }],//避免不必要的方括号
"eol-last": 0,//文件以单一的换行符结束
"eqeqeq": 2,//必须使用全等
"func-names": 0,//函数表达式必须有名字
"func-style": [0, "declaration"],//函数风格,规定只能使用函数声明/函数表达式
"generator-star-spacing": 0,//生成器函数*的前后空格
"guard-for-in": 0,//for in循环要用if语句过滤
"handle-callback-err": 0,//nodejs 处理错误
"id-length": 0,//变量名长度
"indent": [2, 4],//缩进风格
"init-declarations": 0,//声明时必须赋初值
"key-spacing": [0, { "beforeColon": false, "afterColon": true }],//对象字面量中冒号的前后空格
"lines-around-comment": 0,//行前/行后备注
"max-depth": [0, 4],//嵌套块深度
"max-len": [0, 80, 4],//字符串最大长度
"max-nested-callbacks": [0, 2],//回调嵌套深度
"max-params": [0, 3],//函数最多只能有3个参数
"max-statements": [0, 10],//函数内最多有几个声明
"new-cap": 2,//函数名首行大写必须使用new方式调用,首行小写必须用不带new方式调用
"new-parens": 2,//new时必须加小括号
"newline-after-var": 2,//变量声明后是否需要空一行
"object-curly-spacing": [0, "never"],//大括号内是否允许不必要的空格
"object-shorthand": 0,//强制对象字面量缩写语法
"one-var": 1,//连续声明
"operator-assignment": [0, "always"],//赋值运算符 += -=什么的
"operator-linebreak": [2, "after"],//换行时运算符在行尾还是行首
"padded-blocks": 0,//块语句内行首行尾是否要空行
"prefer-const": 0,//首选const
"prefer-spread": 0,//首选展开运算
"prefer-reflect": 0,//首选Reflect的方法
"quotes": [1, "single"],//引号类型 `` "" ''
"quote-props":[2, "always"],//对象字面量中的属性名是否强制双引号
"radix": 2,//parseInt必须指定第二个参数
"id-match": 0,//命名检测
"require-yield": 0,//生成器函数必须有yield
"semi": [2, "always"],//语句强制分号结尾
"semi-spacing": [0, {"before": false, "after": true}],//分号前后空格
"sort-vars": 0,//变量声明时排序
"space-after-keywords": [0, "always"],//关键字后面是否要空一格
"space-before-blocks": [0, "always"],//不以新行开始的块{前面要不要有空格
"space-before-function-paren": [0, "always"],//函数定义时括号前面要不要有空格
"space-in-parens": [0, "never"],//小括号里面要不要有空格
"space-infix-ops": 0,//中缀操作符周围要不要有空格
"space-return-throw-case": 2,//return throw case后面要不要加空格
"space-unary-ops": [0, { "words": true, "nonwords": false }],//一元运算符的前/后要不要加空格
"spaced-comment": 0,//注释风格要不要有空格什么的
"strict": 2,//使用严格模式
"use-isnan": 2,//禁止比较时使用NaN,只能用isNaN()
"valid-jsdoc": 0,//jsdoc规则
"valid-typeof": 2,//必须使用合法的typeof的值
"vars-on-top": 2,//var必须放在作用域顶部
"wrap-iife": [2, "inside"],//立即执行函数表达式的小括号风格
"wrap-regex": 0,//正则表达式字面量用小括号包起来
"yoda": [2, "never"],//禁止尤达条件
"global-strict": 0,
"no-empty-pattern": 1,
"no-useless-escape": 1,
"no-case-declarations": 1,
"react/no-string-refs": 1,
"react/react-in-jsx-scope": 2,
"react/no-direct-mutation-state": 1,
"react/prop-types": 0,
"react/jsx-uses-react": 2,
"react/jsx-uses-vars": 2,
"react/jsx-no-undef": 2,
"react/display-name": 0,
"react/no-deprecated": 0,
"react/no-unescaped-entities": 1,
"react/jsx-key": 1,
"react/jsx-no-target-blank": 1,
"react/no-find-dom-node": 1,
"experimentalDecorators": 0
}
};
五、.eslintignore的配置
build/*.js
config/*.js
六、操作 eslint
可以在文件注释中禁用、启用和配置规则:
/* eslint-disable */
/* eslint-enable */
/* eslint eqeqeq: 0, curly: 2 */
七、关闭 eslint 的方法
方法一:注释掉 package.json 中 eslint 的配置
"eslintConfig": {
"root": true, // 告诉eslint找当前配置文件不能往父级查找
"env": {
"node": true
},
"extends": [
"plugin:vue/essential",
"@vue/standard"
],
"rules": {//规则配置写在这里
"indent": [1, 4]
},
"parserOptions": {
"parser": "babel-eslint"
}
},
或者 vue.config.js 中将以下三项设置为false:
devServer: {
overlay: {
warnings: false,
errors: false
},
lintOnSave: false
}
方法二:删除 eslint 配置文件内容来
关闭 eslint
配置文件可能叫 .eslintrc.js,也可能叫 .eslintrc.json 等
,直接删除里边全部内容就可以了,但不要删除这个文件,否则会报错 Error: No ESLint configuration found.
文件第一行写上:
/* eslint-disable */
方法四:如果只是关闭 VSCode 编辑器的 eslint 检查,禁用 VSCode 的 eslint 插件就可以了
八、一些 eslint 相关安装包的升级
可以参考这里