ESLint规则配置说明

0.前言

有的时候多人开发，代码的风格，用的代码编辑器都各不相同，所以为了大家能保持一种统一的风格，ESLint就可以帮我们检查代码的格式，和风格。


timg.jpeg

1.简介

通过用 ESLint 来检查一些规则，我们可以：

  • 统一代码风格规则，如：代码缩进用几个空格；是否用驼峰命名法来命名变量和函数名等。
  • 减少错误， 如：相等比较必须用 === ，变量在使用前必须被声明，在条件语句中不能使用赋值语句等。
  • 提高代码质量，如：函数最多有多少条件分支；最多有几个参数，代码块最多能嵌套多少层等。

2.安装

1 安装 ESLint 的依赖。
npm install  --save-dev eslint eslint-loader
2 在 webpack.config.js 加上配置
module: {
    rules: [
      {
        test: /\.(js|jsx)$/,
        enforce: "pre",
        loader: "eslint-loader",
        include: [path.resolve(__dirname, 'src')]// 指定检查的目录
      }]
  };
3 新建名为 .eslintrc 的文件。该文件的内容为对 ESLint 的配置。内容类似如下
{
  "extends": ["airbnb", "prettier"],
  "parser": "babel-eslint",
  "env": {
    "browser": true,
    "es6": true,
    "node": true
  },
  "parserOptions": {
    "ecmaVersion": 6,
    "sourceType": "module"
  },
  "rules": {
    "space-in-parens": [0],
    "no-tabs": [0],
    "global-require": [0],
    "react/jsx-filename-extension": [0],
    "indent": ["error", 2],
    "react/jsx-indent": [0],
    "jsx-a11y/anchor-is-valid": [0],
    "import/extensions": [0],
    "react/jsx-curly-spacing": [0],
    "react/jsx-tag-spacing": [0],
    "react/require-default-props": [0],
    "class-methods-use-this": ["off"],
    "arrow-body-style": ["warn", "always"],
    "padded-blocks": ["off"],
    "no-trailing-spaces": ["error", { "ignoreComments": true }],
    "react/jsx-indent-props": [0],
    "no-nested-ternary": ["error"],
    "no-underscore-dangle": ["off", "always"],
    "prefer-destructuring": ["warn"],
    "camelcase": ["warn"],
    "no-irregular-whitespace": ["warn"],
    "jsx-a11y/no-static-element-interactions": [0],
    "jsx-a11y/click-events-have-key-events": [0],
    "no-return-assign": ["off"],
    "consistent-return": ["error", { "treatUndefinedAsUnspecified": true }],
    "dot-notation": ["warn"],
    "linebreak-style": "off",
    "quotes": ["error", "double"],
    "no-console": ["warn", { "allow": ["warn", "error", "log"] }],
    "import/no-useless-path-segments": "off",
    "object-curly-newline": "off",
    "no-shadow": "off",
    "react/jsx-one-expression-per-line": "off",
    "jsx-a11y/label-has-associated-control": "off",
    "jsx-a11y/label-has-for": "off",
    "max-len": ["error", { "code": 100 }]
  }
}

其中

  • env 指定代码运行的环境。
  • parserOptions 指定 JavaScript 相关的选项， ecmaVersion 指定用哪个 ECMAScript 的版本，默认是 3 和 5。
  • rules 指定具体检查的规则。默认情况下，如果不设置检查的规则，ESLint 不会检查任何规则。

更详细的规则说明见官网

4 验证规则

验证规则是写在 .eslintrc 文件中的 rules 下面的，如

"rules": {
    "space-in-parens": [0],
    "no-tabs": [0],
    "global-require": [0],
    "react/jsx-filename-extension": [0],
    "indent": ["error", 2],
}

配置一条验证规则，这样写

规则名: 值

值可以是以下几种

  • ·off 或 0：表示不验证规则。
  • warn 或 1：表示验证规则，当不满足时，给警告。
  • error或 2 ：表示验证规则，不满足时报错。

如

"camelcase": 2
"linebreak-style": "off",

如果规则有参数，则这么写

规则名: [值, 参数1, 参数2...]

如

"no-underscore-dangle": ["off", "always"],
5 常见规则
  • indent： 代码缩进。参数有
  • no-mixed-spaces-and-tabs： 代码缩进不能混用空格和tab。
  • no-mixed-spaces-and-tabs： 代码缩进不能混用空格和tab。
  • camelcase： 变量，函数名遵循驼峰命名法。
  • quotes： 字符串的引号。
  • curly： 在 if，else if，else或 while 的代码块中，即使只有一行代码，也要用写在{} 中。
  • eqeqeq： 比较用 ===或 !==。
  • no-cond-assign： 不在 if 中使用赋值操作。
  • no-undef： 变量和函数在使用前必须先声明。全局变量或函数除外。
  • no-unused-vars：变量定义后会一定要被使用。
  • no-alert： 代码不用 alert,confirm 和 prompt。系统的弹出框比较丑，一般都用自定义的弹出框。
  • max-params： 函数最多有几个参数。默认是3个。
  • max-statements： 函数最多有多少条语句。
  • max-depth：代码块中默认嵌套深度。

更详细的规则说明见官网

eslint 的默认推荐规则

"extends": "eslint:recommended",// 启用 eslint 的默认推荐规
"rules": {
    // 新增的一些规则
    "indent": ["error", 4],
    "linebreak-style": ["error", "unix"],
    "quotes": ["error", "double"],
    "semi": ["error", "always"],

    // 覆盖一些规则的配置
    "comma-dangle": ["error", "always"],
    "no-cond-assign": ["error", "always"],

    // 禁用一些规则
    "no-console": "off",
}
6 常见规则错误
  1. "no-alert": 0,//禁止使用alert confirm prompt
  2. "no-array-constructor": 2,//禁止使用数组构造器
  3. "no-bitwise": 0,//禁止使用按位运算符
  4. "no-caller": 1,//禁止使用arguments.caller或arguments.callee
  5. "no-catch-shadow": 2,//禁止catch子句参数与外部作用域变量同名
  6. "no-class-assign": 2,//禁止给类赋值
  7. "no-cond-assign": 2,//禁止在条件表达式中使用赋值语句
  8. "no-console": 2,//禁止使用console
  9. "no-const-assign": 2,//禁止修改const声明的变量
  10. "no-constant-condition": 2,//禁止在条件中使用常量表达式 if(true) if(1)
  11. "no-continue": 0,//禁止使用continue
  12. "no-control-regex": 2,//禁止在正则表达式中使用控制字符
  13. "no-debugger": 2,//禁止使用debugger
  14. "no-delete-var": 2,//不能对var声明的变量使用delete操作符
  15. "no-div-regex": 1,//不能使用看起来像除法的正则表达式/=foo/
  16. "no-dupe-keys": 2,//在创建对象字面量时不允许键重复 {a:1,a:1}
  17. "no-dupe-args": 2,//函数参数不能重复
  18. "no-duplicate-case": 2,//switch中的case标签不能重复
  19. "no-else-return": 2,//如果if语句里面有return,后面不能跟else语句
  20. "no-empty": 2,//块语句中的内容不能为空
  21. "no-empty-character-class": 2,//正则表达式中的[]内容不能为空
  22. "no-empty-label": 2,//禁止使用空label
  23. "no-eq-null": 2,//禁止对null使用==或!=运算符
  24. "no-eval": 1,//禁止使用eval
  25. "no-ex-assign": 2,//禁止给catch语句中的异常参数赋值
  26. "no-extend-native": 2,//禁止扩展native对象
  27. "no-extra-bind": 2,//禁止不必要的函数绑定
  28. "no-extra-boolean-cast": 2,//禁止不必要的bool转换
  29. "no-extra-parens": 2,//禁止非必要的括号
  30. "no-extra-semi": 2,//禁止多余的冒号
  31. "no-fallthrough": 1,//禁止switch穿透
  32. "no-floating-decimal": 2,//禁止省略浮点数中的0 .5 3.
  33. "no-func-assign": 2,//禁止重复的函数声明
  34. "no-implicit-coercion": 1,//禁止隐式转换
  35. "no-implied-eval": 2,//禁止使用隐式eval
  36. "no-inline-comments": 0,//禁止行内备注
  37. "no-inner-declarations": [2, "functions"],//禁止在块语句中使用声明（变量或函数）
  38. "no-invalid-regexp": 2,//禁止无效的正则表达式
  39. "no-invalid-this": 2,//禁止无效的this，只能用在构造器，类，对象字面量
  40. "no-irregular-whitespace": 2,//不能有不规则的空格
  41. "no-iterator": 2,//禁止使用__iterator__ 属性
  42. "no-label-var": 2,//label名不能与var声明的变量名相同
  43. "no-labels": 2,//禁止标签声明
  44. "no-lone-blocks": 2,//禁止不必要的嵌套块
  45. "no-lonely-if": 2,//禁止else语句内只有if语句
  46. "no-loop-func": 1,//禁止在循环中使用函数（如果没有引用外部变量不形成闭包就可以）
  47. "no-mixed-requires": [0, false],//声明时不能混用声明类型
  48. "no-mixed-spaces-and-tabs": [2, false],//禁止混用tab和空格
  49. "linebreak-style": [0, "windows"],//换行风格
  50. "no-multi-spaces": 1,//不能用多余的空格
  51. "no-multi-str": 2,//字符串不能用\换行
  52. "no-multiple-empty-lines": [1, {"max": 2}],//空行最多不能超过2行
  53. "no-native-reassign": 2,//不能重写native对象
  54. "no-negated-in-lhs": 2,//in 操作符的左边不能有!
  55. "no-nested-ternary": 0,//禁止使用嵌套的三目运算
  56. "no-new": 1,//禁止在使用new构造一个实例后不赋值
  57. "no-new-func": 1,//禁止使用new Function
  58. "no-new-object": 2,//禁止使用new Object()
  59. "no-new-require": 2,//禁止使用new require
  60. "no-new-wrappers": 2,//禁止使用new创建包装实例，new String new Boolean new Number
  61. "no-obj-calls": 2,//不能调用内置的全局对象，比如Math() JSON()
  62. "no-octal": 2,//禁止使用八进制数字
  63. "no-octal-escape": 2,//禁止使用八进制转义序列
  64. "no-param-reassign": 2,//禁止给参数重新赋值
  65. "no-path-concat": 0,//node中不能使用__dirname或__filename做路径拼接
  66. "no-plusplus": 0,//禁止使用++，--
  67. "no-process-env": 0,//禁止使用process.env
  68. "no-process-exit": 0,//禁止使用process.exit()
  69. "no-proto": 2,//禁止使用__proto__属性
  70. "no-redeclare": 2,//禁止重复声明变量
  71. "no-regex-spaces": 2,//禁止在正则表达式字面量中使用多个空格 /foo bar/
  72. "no-restricted-modules": 0,//如果禁用了指定模块，使用就会报错
  73. "no-return-assign": 1,//return 语句中不能有赋值表达式
  74. "no-script-url": 0,//禁止使用javascript:void(0)
  75. "no-self-compare": 2,//不能比较自身
  76. "no-sequences": 0,//禁止使用逗号运算符
  77. "no-shadow": 2,//外部作用域中的变量不能与它所包含的作用域中的变量或参数同名
  78. "no-shadow-restricted-names": 2,//严格模式中规定的限制标识符不能作为声明时的变量名使用
  79. "no-spaced-func": 2,//函数调用时 函数名与()之间不能有空格
  80. "no-sparse-arrays": 2,//禁止稀疏数组， [1,,2]
  81. "no-sync": 0,//nodejs 禁止同步方法
  82. "no-ternary": 0,//禁止使用三目运算符
  83. "no-trailing-spaces": 1,//一行结束后面不要有空格
  84. "no-this-before-super": 0,//在调用super()之前不能使用this或super
  85. "no-throw-literal": 2,//禁止抛出字面量错误 throw "error";
  86. "no-undef": 1,//不能有未定义的变量
  87. "no-undef-init": 2,//变量初始化时不能直接给它赋值为undefined
  88. "no-undefined": 2,//不能使用undefined
  89. "no-unexpected-multiline": 2,//避免多行表达式
  90. "no-underscore-dangle": 1,//标识符不能以_开头或结尾
  91. "no-unneeded-ternary": 2,//禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
  92. "no-unreachable": 2,//不能有无法执行的代码
  93. "no-unused-expressions": 2,//禁止无用的表达式
  94. "no-unused-vars": [2, {"vars": "all", "args": "after-used"}],//不能有声明后未被使用的变量或参数
  95. "no-use-before-define": 2,//未定义前不能使用
  96. "no-useless-call": 2,//禁止不必要的call和apply
  97. "no-void": 2,//禁用void操作符
  98. "no-var": 0,//禁用var，用let和const代替
  99. "no-warning-comments": [1, { "terms": ["todo", "fixme", "xxx"], "location": "start" }],//不能有警告备注
  100. "no-with": 2,//禁用with
  101. "array-bracket-spacing": [2, "never"],//是否允许非空数组里面有多余的空格
  102. "arrow-parens": 0,//箭头函数用小括号括起来
  103. "arrow-spacing": 0,//=>的前/后括号
  104. "accessor-pairs": 0,//在对象中使用getter/setter
  105. "block-scoped-var": 0,//块语句中使用var
  106. "brace-style": [1, "1tbs"],//大括号风格
  107. "callback-return": 1,//避免多次调用回调什么的
  108. "camelcase": 2,//强制驼峰法命名
  109. "comma-dangle": [2, "never"],//对象字面量项尾不能有逗号
  110. "comma-spacing": 0,//逗号前后的空格
  111. "comma-style": [2, "last"],//逗号风格，换行时在行首还是行尾
  112. "complexity": [0, 11],//循环复杂度
  113. "computed-property-spacing": [0, "never"],//是否允许计算后的键名什么的
  114. "consistent-return": 0,//return 后面是否允许省略
  115. "consistent-this": [2, "that"],//this别名
  116. "constructor-super": 0,//非派生类不能调用super，派生类必须调用super
  117. "curly": [2, "all"],//必须使用 if(){} 中的{}
  118. "default-case": 2,//switch语句最后必须有default
  119. "dot-location": 0,//对象访问符的位置，换行的时候在行首还是行尾
  120. "dot-notation": [0, { "allowKeywords": true }],//避免不必要的方括号
  121. "eol-last": 0,//文件以单一的换行符结束
  122. "eqeqeq": 2,//必须使用全等
  123. "func-names": 0,//函数表达式必须有名字
  124. "func-style": [0, "declaration"],//函数风格，规定只能使用函数声明/函数表达式
  125. "generator-star-spacing": 0,//生成器函数*的前后空格
  126. "guard-for-in": 0,//for in循环要用if语句过滤
  127. "handle-callback-err": 0,//nodejs 处理错误
  128. "id-length": 0,//变量名长度
  129. "indent": [2, 4],//缩进风格
  130. "init-declarations": 0,//声明时必须赋初值
  131. "key-spacing": [0, { "beforeColon": false, "afterColon": true }],//对象字面量中冒号的前后空格
  132. "lines-around-comment": 0,//行前/行后备注
  133. "max-depth": [0, 4],//嵌套块深度
  134. "max-len": [0, 80, 4],//字符串最大长度
  135. "max-nested-callbacks": [0, 2],//回调嵌套深度
  136. "max-params": [0, 3],//函数最多只能有3个参数
  137. "max-statements": [0, 10],//函数内最多有几个声明
  138. "new-cap": 2,//函数名首行大写必须使用new方式调用，首行小写必须用不带new方式调用
  139. "new-parens": 2,//new时必须加小括号
  140. "newline-after-var": 2,//变量声明后是否需要空一行
  141. "object-curly-spacing": [0, "never"],//大括号内是否允许不必要的空格
  142. "object-shorthand": 0,//强制对象字面量缩写语法
  143. "one-var": 1,//连续声明
  144. "operator-assignment": [0, "always"],//赋值运算符 += -=什么的
  145. "operator-linebreak": [2, "after"],//换行时运算符在行尾还是行首
  146. "padded-blocks": 0,//块语句内行首行尾是否要空行
  147. "prefer-const": 0,//首选const
  148. "prefer-spread": 0,//首选展开运算
  149. "prefer-reflect": 0,//首选Reflect的方法
  150. "quotes": [1, "single"],//引号类型 "" ''
  151. "quote-props":[2, "always"],//对象字面量中的属性名是否强制双引号
  152. "radix": 2,//parseInt必须指定第二个参数
  153. "id-match": 0,//命名检测
  154. "require-yield": 0,//生成器函数必须有yield
  155. "semi": [2, "always"],//语句强制分号结尾
  156. "semi-spacing": [0, {"before": false, "after": true}],//分号前后空格
  157. "sort-vars": 0,//变量声明时排序
  158. "space-after-keywords": [0, "always"],//关键字后面是否要空一格
  159. "space-before-blocks": [0, "always"],//不以新行开始的块{前面要不要有空格
  160. "space-before-function-paren": [0, "always"],//函数定义时括号前面要不要有空格
  161. "space-in-parens": [0, "never"],//小括号里面要不要有空格
  162. "space-infix-ops": 0,//中缀操作符周围要不要有空格
  163. "space-return-throw-case": 2,//return throw case后面要不要加空格
  164. "space-unary-ops": [0, { "words": true, "nonwords": false }],//一元运算符的前/后要不要加空格
  165. "spaced-comment": 0,//注释风格要不要有空格什么的
  166. "strict": 2,//使用严格模式
  167. "use-isnan": 2,//禁止比较时使用NaN，只能用isNaN()
  168. "valid-jsdoc": 0,//jsdoc规则
  169. "valid-typeof": 2,//必须使用合法的typeof的值
  170. "vars-on-top": 2,//var必须放在作用域顶部
  171. "wrap-iife": [2, "inside"],//立即执行函数表达式的小括号风格
  172. "wrap-regex": 0,//正则表达式字面量用小括号包起来
  173. "yoda": [2, "never"]//禁止尤达条件

3.结束语
好了你可以去配置你的ESLint了😊！！！

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 194,457评论 5赞 459
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 81,837评论 2赞 371
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 141,696评论 0赞 319
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 52,183评论 1赞 263
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 61,057评论 4赞 355
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 46,105评论 1赞 272
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 36,520评论 3赞 381
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 35,211评论 0赞 253
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 39,482评论 1赞 290
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2赞 309
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1赞 326
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,213评论 3赞 312
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 37,576评论 3赞 298
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0赞 17
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1赞 250
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2赞 341
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2赞 335

推荐阅读更多精彩内容