vscode安装和配置ESLint

墨蓝 2022-01-31 13:13 740阅读 0赞

# 文档 #

[ESLint中文网][ESLint]

# 实操 #

我的项目是由vue-cli3的脚手架搭建的，在搭建的时候选择的是[ESLint + Prettier][ESLint _ Prettier]

Vue CLI v3.1.3
    ? Please pick a preset: Manually select features
    ? Check the features needed for your project: Babel, Router, CSS Pre-processors, Linter
    ? Use history mode for router? (Requires proper server setup for index fallback in production) Yes
    ? Pick a CSS pre-processor (PostCSS, Autoprefixer and CSS Modules are supported by default): Sass/SCSS
    ? Pick a linter / formatter config: (Use arrow keys)
    > ESLint with error prevention only
      ESLint + Airbnb config
      ESLint + Standard config
      ESLint + Prettier

**各类Lint，比如ESLint来检测代码是否符合设定的规则，Prettier是用来一键格式化我们的代码，二者的配置要相符，一致。否则你会发现你使用Prettier格式化你的代码，结果不符合ESLint的检测要求~~~**

查看

*  [与editorconfig配合代码格式化设置][editorconfig]
 *  [与Prettier配和代码格式化设置][Prettier]

## 如果你的项目中没有eslint ##

全局安装： npm install -g eslint  
项目安装： npm install eslint --save-dev  
注意：

1.如果你想你所有项目都使用eslint，请全局安装；如果你想当前项目使用，请局部安装。

2.局部安装时请使用–save-dev，因为eslint是适用于开发环境（Software Development Environment，SDE）的插件，qing请不要添加到生产环境中。

接下来需要初始化esLint： eslint --init

上面的这个命令我使用没有效果，我用的这个`./node_modules/.bin/eslint --init`

1.  你想怎样使用eslint

PS F:\resource>  ./node_modules/.bin/eslint --init
    ? How would you like to use ESLint? (Use arrow keys)
      To check syntax only //只检查语法
    > To check syntax and find problems//检查语法、发现问题
      To check syntax, find problems, and enforce code style//检查语法、发现问题并执行代码样式

1.  您的项目使用什么类型的模块?  
    vue中用的`JavaScript modules`

1.  项目中使用的什么框架？  
    我用的vue

1.  你的代码运行在什么地方？  
    这里是多选，我选的浏览器和node

1.  您想如何为您的项目定义一个样式?

分别是 1. 使用大厂的 2. 问问题 3. 检查现有的代码自动生成

我选的第二个，问问题

后面根据实际情况回答就好了，即使不小心答错也没关系，都在配置文件里随时可以修改。

1.  您希望配置文件的格式是什么?  
    我选JavaScript

1.  你用什么来进行缩进  
    我比较爱用tabs

1.  字符串用什么引号？单引号还是双引号

? How would you like to use ESLint? To check syntax, find problems, and enforce code style
    ? What type of modules does your project use? JavaScript modules (import/export)
    ? Which framework does your project use? Vue.js
    ? Where does your code run? Browser, Node
    ? How would you like to define a style for your project? Answer questions about your style
    ? What format do you want your config file to be in? JavaScript
    ? What style of indentation do you use? Tabs
    ? What quotes do you use for strings? (Use arrow keys)
    > Double
      Single

1.  你用什么行尾?  
    我用的window

关于line endings ，其实看一下编辑器下面，如果是 LF 选择 Windows，CR 就选 Linux 就好了 。这个关于windows和linux对换行符的定义不同导致的，有兴趣的可以自己搜搜。

1.  你需要分号吗?  
    Y

1.  您希望配置文件的格式是什么?

PS F:\resource>  ./node_modules/.bin/eslint --init
    ? How would you like to use ESLint? To check syntax, find problems, and enforce code style
    ? What type of modules does your project use? JavaScript modules (import/export)
    ? Which framework does your project use? Vue.js
    ? Where does your code run? Browser, Node
    ? How would you like to define a style for your project? Answer questions about your style
    ? What format do you want your config file to be in? JavaScript
    ? What style of indentation do you use? Tabs
    ? What quotes do you use for strings? Single
    ? What line endings do you use? Windows
    ? Do you require semicolons? Yes
    ? What format do you want your config file to be in? (Use arrow keys)
    > JavaScript
      YAML
      JSON

1.  最后

PS F:\resource>  ./node_modules/.bin/eslint --init
    ? How would you like to use ESLint? To check syntax, find problems, and enforce code style
    ? What type of modules does your project use? JavaScript modules (import/export)
    ? Which framework does your project use? Vue.js
    ? Where does your code run? Browser, Node
    ? How would you like to define a style for your project? Answer questions about your style
    ? What format do you want your config file to be in? JavaScript
    ? What style of indentation do you use? Tabs
    ? What quotes do you use for strings? Single
    ? What line endings do you use? Windows
    ? Do you require semicolons? Yes
    ? What format do you want your config file to be in? JavaScript
    Checking peerDependencies of eslint-config-eslint:recommended,plugin:vue/essential@latest
    The config that you've selected requires the following dependencies:
    
    eslint-plugin-vue@latest eslint-config-eslint:recommended,plugin:vue/essential@latest error@[object Object]
    Successfully created .eslintrc.js file in F:\resource

在你的项目根目录下面会有一个.eslintrc.js文件，里面内容为

module.exports = { 
    	'env': { 
    		'browser': true,
    		'es6': true,
    		'node': true
    	},
    	'extends': [
    		'eslint:recommended',
    		'plugin:vue/essential'
    	],
    	'globals': { 
    		'Atomics': 'readonly',
    		'SharedArrayBuffer': 'readonly'
    	},
    	'parserOptions': { 
    		'ecmaVersion': 2018,
    		'sourceType': 'module'
    	},
    	'plugins': [
    		'vue'
    	],
    	'rules': { 
    		'indent': [
    			'error',
    			'tab'
    		],
    		'linebreak-style': [
    			'error',
    			'windows'
    		],
    		'quotes': [
    			'error',
    			'single'
    		],
    		'semi': [
    			'error',
    			'always'
    		]
    	}
    };

**如果觉得上面这个自己配置很烦**，可以在第5步选择`Use a popular style guide`

# 配置说明 #

## env ##

Environments，指定代码的运行环境。不同的运行环境，全局变量不一样，指明运行环境这样ESLint就能识别特定的全局变量。同时也会开启对应环境的语法支持，例如：es6。

## parser ##

ESLint 默认使用Espree作为其解析器，但它并不能很好的适应 React 环境，你可以安装 babel-eslint 用来代替默认的解析器，在配置里这么写"parser": “babel-eslint”。

## plugins ##

顾名思义就是插件，插件是单独的npm包，命名一般以eslint-plugin开头，写的时候用字符串数组的形式，可以省略eslint-plugin开头。plugins一般包含一个或多个规则配置，可以在extends中引入。  
例如：eslint:recommended就是 ESLint 的推荐规则配置，包含了ESLint的规则 里前面有✔︎的部分，recommended 规则只在ESLint升级大版本的才有可能改变。

## extends ##

ESLint 不需要自行定义大量的规则，因为很多规则已被分组作为一个规则配置。  
例如：`eslint:recommended`就是 ESLint 的推荐规则配置，包含了[ESLint的规则 里前面有✔︎的部分][ESLint_]，recommended 规则只在ESLint升级大版本的才有可能改变。

相对的 `eslint:all` 是应用所有的规则，但并不推荐这么做。另外，all 规则是根据版本随时变化的。  
extends 还可以以字符串数组的形式定义。

"extends": ["eslint:recommended", "plugin:react/recommended"],

`plugin:react/recommended` 即为 [eslint-plugin-react][] 插件中的提供的推荐规则配置。  
另外还有一点，extends定义的规则如果有重复的，后面的规则会覆盖前面的。

## rules ##

这里可以对规则进行细致的定义了，覆盖之前前面说的extends中定义的规则。例如`indent`就是对缩进的修改。`"indent": ["error",4]` 前面一项代表错误等级，第二项是具体配置，有些规则有第三项选项，例如 indent 就有 `{ "SwitchCase": 1 }`，代表对switch语句采取什么样的缩进策略，如果不设默认是0。具体可以定义什么 rules，可以 [参考这里][ESLint_]

错误等级有三级 0，1，2，分别代表off，warning，error。error错误会终止 lint-staged 执行。

0或’off’：关闭规则。
    1或’warn’：打开规则，并且作为一个警告（并不会导致检查不通过）。
    2或’error’：打开规则，并且作为一个错误 (退出码为1，检查不通过)。

参数说明：
    参数1 ： 错误等级
    参数2 ： 处理方式

## globals ##

全局变量，如果你的项目用到其他一些自定义的全局变量，`"__DEV__": false`这样配置，true  
和 false 代表可不可以被修改。

其他可用的配置[参考这个][Link 1]

## 调试配置 ##

配置肯定是不能拿来就用的，推荐先就只使用 `eslint:recommended`版本，如果你的项目 indent 比较特殊，再到 rules 定义 indent 就可以了。

然后先用命令行命令先对代码库里比较典型文件测试一下

node_modules/.bin/eslint app/app.js --fix

## 配置代码注释方式 ##

有时我们可能要在代码中忽略eslint的某种检查，或者加入某种特定检查，此时我们可以用如下的方式：

示例：

*  忽略 no-undef 检查

/* eslint-disable no-undef */

*  忽略 no-new 检查

/* eslint-disable no-new */

*  设置检查

/*eslint eqeqeq: off*/ /*eslint eqeqeq: 0*/

*  eslint 检查指令  
    检查且修复

eslint * --fix

*  检查指定文件

eslint app.js --fix

## 你可以使用别人的eslint配置 ##

你可以在 [npmjs.com ][npmjs.com]搜索 “eslint-config” 使用别人创建好的配置  
[eslint-config-elemefe][]  
[vue官方eslint-config-vue][vue_eslint-config-vue]

## ESLint规则配置详细说明 ##

"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": [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": 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": [2, { "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": [2, "never"],//对象字面量项尾不能有逗号
    "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"]//禁止尤达条件

## eslint-plugin-react 规则 ##

/**
     * AlloyTeam ESLint 规则 - React
     *
     * 包含所有 ESLint 规则，以及所有 eslint-plugin-react 规则
     * 使用 babel-eslint 作为解析器
     *
     * @fixable 表示此配置支持 --fix
     * @off 表示此配置被关闭了，并且后面说明了关闭的原因
     */
    
    module.exports = { 
        extends: [
            './index.js',
        ],
        plugins: [
            'react'
        ],
        rules: { 
            // 布尔值类型的 propTypes 的 name 必须为 is 或 has 开头
            // @off 不强制要求写 propTypes
            'react/boolean-prop-naming': 'off',
            // 一个 defaultProps 必须有对应的 propTypes
            // @off 不强制要求写 propTypes
            'react/default-props-match-prop-types': 'off',
            // 组件必须有 displayName 属性
            // @off 不强制要求写 displayName
            'react/display-name': 'off',
            // 禁止在自定义组件中使用一些指定的 props
            // @off 没必要限制
            'react/forbid-component-props': 'off',
            // 禁止使用一些指定的 elements
            // @off 没必要限制
            'react/forbid-elements': 'off',
            // 禁止使用一些指定的 propTypes
            // @off 不强制要求写 propTypes
            'react/forbid-prop-types': 'off',
            // 禁止直接使用别的组建的 propTypes
            // @off 不强制要求写 propTypes
            'react/forbid-foreign-prop-types': 'off',
            // 禁止使用数组的 index 作为 key
            // @off 太严格了
            'react/no-array-index-key': 'off',
            // 禁止使用 children 做 props
            'react/no-children-prop': 'error',
            // 禁止使用 dangerouslySetInnerHTML
            // @off 没必要限制
            'react/no-danger': 'off',
            // 禁止在使用了 dangerouslySetInnerHTML 的组建内添加 children
            'react/no-danger-with-children': 'error',
            // 禁止使用已废弃的 api
            'react/no-deprecated': 'error',
            // 禁止在 componentDidMount 里面使用 setState
            // @off 同构应用需要在 didMount 里写 setState
            'react/no-did-mount-set-state': 'off',
            // 禁止在 componentDidUpdate 里面使用 setState
            'react/no-did-update-set-state': 'error',
            // 禁止直接修改 this.state
            'react/no-direct-mutation-state': 'error',
            // 禁止使用 findDOMNode
            'react/no-find-dom-node': 'error',
            // 禁止使用 isMounted
            'react/no-is-mounted': 'error',
            // 禁止在一个文件创建两个组件
            // @off 有一个 bug https://github.com/yannickcr/eslint-plugin-react/issues/1181
            'react/no-multi-comp': 'off',
            // 禁止在 PureComponent 中使用 shouldComponentUpdate
            'react/no-redundant-should-component-update': 'error',
            // 禁止使用 ReactDOM.render 的返回值
            'react/no-render-return-value': 'error',
            // 禁止使用 setState
            // @off setState 很常用
            'react/no-set-state': 'off',
            // 禁止拼写错误
            'react/no-typos': 'error',
            // 禁止使用字符串 ref
            'react/no-string-refs': 'error',
            // 禁止在组件的内部存在未转义的 >, ", ' 或 } 'react/no-unescaped-entities': 'error', // @fixable 禁止出现 HTML 中的属性，如 class 'react/no-unknown-property': 'error', // 禁止出现未使用的 propTypes // @off 不强制要求写 propTypes 'react/no-unused-prop-types': 'off', // 定义过的 state 必须使用 // @off 没有官方文档，并且存在很多 bug： https://github.com/yannickcr/eslint-plugin-react/search?q=no-unused-state&type=Issues&utf8=%E2%9C%93 'react/no-unused-state': 'off', // 禁止在 componentWillUpdate 中使用 setState 'react/no-will-update-set-state': 'error', // 必须使用 Class 的形式创建组件 'react/prefer-es6-class': [ 'error', 'always' ], // 必须使用 pure function // @off 没必要限制 'react/prefer-stateless-function': 'off', // 组件必须写 propTypes // @off 不强制要求写 propTypes 'react/prop-types': 'off', // 出现 jsx 的地方必须 import React // @off 已经在 no-undef 中限制了 'react/react-in-jsx-scope': 'off', // 非 required 的 prop 必须有 defaultProps // @off 不强制要求写 propTypes 'react/require-default-props': 'off', // 组件必须有 shouldComponentUpdate // @off 没必要限制 'react/require-optimization': 'off', // render 方法中必须有返回值 'react/require-render-return': 'error', // @fixable 组件内没有 children 时，必须使用自闭和写法 // @off 没必要限制 'react/self-closing-comp': 'off', // @fixable 组件内方法必须按照一定规则排序 'react/sort-comp': 'error', // propTypes 的熟悉必须按照字母排序 // @off 没必要限制 'react/sort-prop-types': 'off', // style 属性的取值必须是 object 'react/style-prop-object': 'error', // HTML 中的自闭和标签禁止有 children 'react/void-dom-elements-no-children': 'error', // @fixable 布尔值的属性必须显式的写 someprop={true} // @off 没必要限制 'react/jsx-boolean-value': 'off', // @fixable 自闭和标签的反尖括号必须与尖括号的那一行对齐 'react/jsx-closing-bracket-location': [ 'error', { nonEmpty: false, selfClosing: 'line-aligned' } ], // @fixable 结束标签必须与开始标签的那一行对齐 // @off 已经在 jsx-indent 中限制了 'react/jsx-closing-tag-location': 'off', // @fixable 大括号内前后禁止有空格 'react/jsx-curly-spacing': [ 'error', { when: 'never', attributes: { allowMultiline: true }, children: true, spacing: { objectLiterals: 'never' } } ], // @fixable props 与 value 之间的等号前后禁止有空格 'react/jsx-equals-spacing': [ 'error', 'never' ], // 限制文件后缀 // @off 没必要限制 'react/jsx-filename-extension': 'off', // @fixable 第一个 prop 必须得换行 // @off 没必要限制 'react/jsx-first-prop-new-line': 'off', // handler 的名称必须是 onXXX 或 handleXXX // @off 没必要限制 'react/jsx-handler-names': 'off', // @fixable jsx 的 children 缩进必须为四个空格 'react/jsx-indent': [ 'error', 4 ], // @fixable jsx 的 props 缩进必须为四个空格 'react/jsx-indent-props': [ 'error', 4 ], // 数组中的 jsx 必须有 key 'react/jsx-key': 'error', // @fixable 限制每行的 props 数量 // @off 没必要限制 'react/jsx-max-props-per-line': 'off', // jsx 中禁止使用 bind // @off 太严格了 'react/jsx-no-bind': 'off', // 禁止在 jsx 中使用像注释的字符串 'react/jsx-no-comment-textnodes': 'error', // 禁止出现重复的 props 'react/jsx-no-duplicate-props': 'error', // 禁止在 jsx 中出现字符串 // @off 没必要限制 'react/jsx-no-literals': 'off', // 禁止使用 target="_blank"
            // @off 没必要限制
            'react/jsx-no-target-blank': 'off',
            // 禁止使用未定义的 jsx elemet
            'react/jsx-no-undef': 'error',
            // 禁止使用 pascal 写法的 jsx，比如 <TEST_COMPONENT>
            'react/jsx-pascal-case': 'error',
            // @fixable props 必须排好序
            // @off 没必要限制
            'react/jsx-sort-props': 'off',
            // @fixable jsx 的开始和闭合处禁止有空格
            'react/jsx-tag-spacing': [
                'error',
                { 
                    closingSlash: 'never',
                    beforeSelfClosing: 'always',
                    afterOpening: 'never'
                }
            ],
            // jsx 文件必须 import React
            'react/jsx-uses-react': 'error',
            // 定义了的 jsx element 必须使用
            'react/jsx-uses-vars': 'error',
            // @fixable 多行的 jsx 必须有括号包起来
            // @off 没必要限制
            'react/jsx-wrap-multilines': 'off'
        }
    };

## ESLint 标准规则说明 ##

查看我的另外一篇文章 [链接][Link 2]

# 致谢 #

[参考1][1]

[ESLint]: http://eslint.cn/
[ESLint _ Prettier]: https://www.npmjs.com/package/eslint-config-prettier
[editorconfig]: https://blog.csdn.net/Gabriel_wei/article/details/90286668
[Prettier]: https://blog.csdn.net/Gabriel_wei/article/details/90288144
[ESLint_]: https://eslint.org/docs/rules/
[eslint-plugin-react]: https://github.com/yannickcr/eslint-plugin-react#recommended
[Link 1]: https://eslint.org/docs/user-guide/configuring
[npmjs.com]: https://www.npmjs.com/search?q=eslint-config
[eslint-config-elemefe]: https://www.npmjs.com/package/eslint-config-elemefe
[vue_eslint-config-vue]: https://github.com/vuejs/eslint-config-vue
[Link 2]: https://blog.csdn.net/Gabriel_wei/article/details/90290734
[1]: https://www.jianshu.com/p/cdd749c624d9