Eslint不仅仅是约束,更是一种保障

想在项目中引入静态检查工具,对JSLint,JSHint,ESLint该怎样选择?没用过没有关系,万事找度娘,搜下他们的优缺点,根据自己的需要选择即可

1、JSLint
优点:配置已经定好的,开箱即用。
不足:有限的配置选项,很多规则不能禁用;规范严格,凡是不符合老道所认为的好的风格的,都会有警告;扩展性差;无法根据错误定位到对应的规则
2、JSHint
优点:有了很多参数可以配置;支持配置文件,方便使用;支持了一些常用类库;支持了基本的ES6
不足:不支持自定义规则;无法根据错误定位到对应的规则
3、ESLint
优点:默认规则里面包含了JSLint和JSHint的规则,易于迁移;可配置为警告和错误两个等级,或者直接禁用掉;支持插件扩展
可以自定义规则;可以根据错误定位到对应的规则;支持ES6;唯一一个支持JSX的工具
不足:需要进行一些自定义配置;慢 (它比其他两个都要慢)

在我的项目中选择的是Eslint,下面介绍下它的使用,希望对你有所帮助

Eslint简介

ESLint由 Nicholas C. Zakas 于2013年6月创建,使用 Node.js 编写, 是一个开源的 JavaScript 代码检查工具,JavaScript 是一个动态的弱类型语言,在开发中比较容易出错, ESLint 这样的可以让你在编码的过程中发现问题,并且可以自己创建检测规则,保持代码编写风格的一致性
中文官方网站在这里,戳我,戳我,👇

安装

npm i -g eslint

初始化

eslint --init

这个命令会帮助新用户在当前目录下创建 .eslintrc 文件,用户通过回答一些问题,选择一个流行的风格指南(例如airbnb),当然你也可以按照自己的习惯进行配置

配置

ESlint 被设计为是完全可配置的,这意味着你可以控制每一个规则,以让 ESLint 更适合于你的项目。有两种主要的方式来配置 ESLint:
1.使用 JavaScript 注释把配置信息直接嵌入到一个文件
2.可以用 .eslintrc 文件或者在 package.json文件里的 eslintConfig 字段这两种方式进行配置,ESLint 会查找和自动读取它们,为整个目录和它的子目录指定配置信息

如果同一个目录下有多个配置文件,ESLint 只会使用一个,优先级顺序如下:
.eslintrc.js(JavaScript),.eslintrc.yaml/.eslintrc.yml(YAML),.eslintrc.json(JSON),.eslintrc(Deprecated),package.json(里 eslintConfig属性)

配置项讲解:

Environments - 配置项中简写为env,它可以指定脚本的运行环境,每种环境都有一组特定的预定义全局变量,例如:

“env”: {
    "browser": true,
    "commonjs": true,
    "es6": true
  },

Globals - 脚本在执行期间访问的额外的全局变量
当访问未定义的变量时,no-undef 规则将发出警告。如果你想在一个文件里使用全局变量,你可以定义这些全局变量,这样 ESLint 就不会发出警告了

例如:定义了var1var2为两个全局变量,如果你想指定这些变量不应被重写(只读),你可以将它们设置为 false:

"globals": {
  "var1": true,
  "var2": false
}

parserOptions - 属性设置解析器选项,例如:

    "parserOptions": {
        "ecmaVersion": 6,//ECMAScript 版本
        "sourceType": "module",//指定来源的类型,有两种”script”或”module”
        "ecmaFeatures": {//额外的语言特性
            "jsx": true// 启用 [JSX](http://facebook.github.io/jsx/)
        }
    }

Rules - 启用的规则及设定各自的错误级别
所有这些选项让你可以细粒度地控制 ESLint 如何对待你的代码,所有的规则默认都是禁用,详细配置可查看官方文档,戳我,戳我,👇

//开启官网中带✅的规则,报告一些常见的问题
 "extends": "eslint:recommended"
1. "off" 或 0 - 关闭规则
2. "warn" 或 1 - 开启规则,使用警告级别的错误:warn (不会导致程序退出)
3. "error" 或 2 - 开启规则,使用错误级别的错误:error (当被触发的时候,程序会退出)

例如:

"rules": {
   // 关闭console选项
   "no-console": 0,
   // 禁用 debugger
   "no-debugger": 2
   // 禁止在正则表达式中使用控制字符 :new RegExp("\x1f")
   "no-control-regex": 2,
   // 数组和对象键值对最后一个逗号, never参数:不能带末尾的逗号,         
   // always参数:必须带末尾的逗号,always-multiline:多行模式必须带逗号,单行模式不能带逗号
   "comma-dangle": [1, "always-multiline"]
}

常用规则设置,可参考:

1、错误提示相关

// 禁止条件表达式中出现赋值操作符
"no-cond-assign": 2,
// 禁用 console
"no-console": 0,
// 禁用 debugger
"no-debugger": 2,
// 禁用稀疏数组
"no-sparse-arrays": 2,
// 禁止在正则表达式中使用控制字符 :new RegExp("\x1f")
"no-control-regex": 2,
// 数组和对象键值对最后一个逗号, never参数:不能带末尾的逗号, always参数:必须带末尾的逗号,
// always-multiline:多行模式必须带逗号,单行模式不能带逗号
"comma-dangle": [1, "always-multiline"],
// 禁止 function 定义中出现重名参数
"no-dupe-args": 2,
// 禁止对象字面量中出现重复的 key
"no-dupe-keys": 2,
// 禁止重复的 case 标签
"no-duplicate-case": 2,
// 禁止不必要的布尔转换
"no-extra-boolean-cast": 2,
// 禁止不必要的分号
"no-extra-semi": 2,
// 禁止对 function 声明重新赋值
"no-func-assign": 2,
// 禁止在嵌套的块中出现 function 或 var 声明
"no-inner-declarations": [2, "functions"],
// 禁止 RegExp 构造函数中无效的正则表达式字符串
"no-invalid-regexp": 2,
// 禁止在 in 表达式中出现否定的左操作数
"no-negated-in-lhs": 2,
// 禁止把全局对象 (Math 和 JSON) 作为函数调用 错误:var math = Math();
"no-obj-calls": 2,
// 要求使用 isNaN() 检查 NaN
"use-isnan": 2,
// 强制使用有效的 JSDoc 注释
"valid-jsdoc": 1,
// 强制 typeof 表达式与有效的字符串进行比较typeof foo === "undefimed" 错误
"valid-typeof": 2,

2、最佳实践相关:

// 强制数组方法的回调函数中有 return 语句
"array-callback-return": 1,
// 强制把变量的使用限制在其定义的作用域范围内
"block-scoped-var": 1,
// 要求 return 语句要么总是指定返回的值,要么不指定
"consistent-return": 1,
// 强制所有控制语句使用一致的括号风格
"curly": [2, "all"],
// switch 语句强制 default 分支
"default-case": 2,
// 使用 === 替代 == allow-null允许null和undefined==
"eqeqeq": [2, "allow-null"],
// 禁用 alert、confirm 和 prompt
"no-alert": 1,
// 禁用 arguments.caller 或 arguments.callee
"no-caller": 2,
// 禁止除法操作符显式的出现在正则表达式开始的位置
"no-div-regex": 2,
// 禁止出现空函数.如果一个函数包含了一条注释,它将不会被认为有问题。
"no-empty-function": 2,
// 禁止使用空解构模式no-empty-pattern
"no-empty-pattern": 2,
// 禁止在没有类型检查操作符的情况下与 null 进行比较
"no-eq-null": 1,
// 禁用 eval()
"no-eval": 2,
// 禁止扩展原生类型
"no-extend-native": 2,
// 禁止不必要的 .bind() 调用
"no-extra-bind": 2,
// 禁用不必要的标签
"no-extra-label:": 1,
// 禁止 case 语句落空
"no-fallthrough": 2,
// 禁止数字字面量中使用前导和末尾小数点
"no-floating-decimal": 2,
// 禁止使用短符号进行类型转换(!!fOO)
"no-implicit-coercion": 1,
// 禁止 this 关键字出现在类和类对象之外
"no-invalid-this": 1,
// 禁用 __iterator__ 属性
"no-iterator": 2,
// 禁用标签语句
"no-labels": 2,
// 禁用不必要的嵌套块
"no-lone-blocks": 2,
// 禁止在循环中出现 function 声明和表达式
"no-loop-func": 1,
// 禁止使用多个空格
"no-multi-spaces": 1,
// 禁止使用多行字符串,在 JavaScript 中,可以在新行之前使用斜线创建多行字符串
"no-multi-str": 2,
// 禁止对原生对象赋值
"no-native-reassign": 2,
// 禁止在非赋值或条件语句中使用 new 操作符
"no-new": 2,
// 禁止对 Function 对象使用 new 操作符
"no-new-func": 1,
// 禁止对 String,Number 和 Boolean 使用 new 操作符
"no-new-wrappers": 2,
// 禁用八进制字面量
"no-octal": 2,
// 禁止在字符串中使用八进制转义序列
"no-octal-escape": 2,
// 禁用 __proto__ 属性
"no-proto": 2,
// 禁止使用 var 多次声明同一变量
"no-redeclare": 2,
// 禁用逗号操作符
"no-sequences": 2,
// 禁止抛出非异常字面量
"no-throw-literal": 2,
// 禁用一成不变的循环条件
"no-unmodified-loop-condition": 2,
// 禁用未使用过的标签
"no-unused-labels": 2,
// 禁止不必要的 .call() 和 .apply()
"no-useless-call": 2,
// 禁止不必要的字符串字面量或模板字面量的连接
"no-useless-concat": 2,
// 禁用不必要的转义字符
"no-useless-escape": 1,
// 禁用 with 语句
"no-with": 2,
// 强制在parseInt()使用基数参数
"radix": 2,
// 要求所有的 var 声明出现在它们所在的作用域顶部
"vars-on-top": 1,
// 要求 IIFE 使用括号括起来
"wrap-iife": [2, "any"],
// 要求或禁止 “Yoda” 条件
"yoda": [2, "never"],
// 要求或禁止使用严格模式指令
"strict": 0,

3、变量声明相关

// 不允许 catch 子句的参数与外层作用域中的变量同名
"no-catch-shadow": 1,
// 禁止删除变量
"no-delete-var": 2,
// 不允许标签与变量同名
"no-label-var": 2,
// 禁止 var 声明 与外层作用域的变量同名
"no-shadow": 1,
// 禁止覆盖受限制的标识符
"no-shadow-restricted-names": 2,
// 禁用未声明的变量,除非它们在 /*global */ 注释中被提到
"no-undef": 2,
// 禁止将变量初始化为 undefined
"no-undef-init": 2,
// 禁止将 undefined 作为标识符
"no-undefined": 1,
// 禁止出现未使用过的变量
"no-unused-vars": [2, {"vars": "all", "args": "none"}],
// 不允许在变量定义之前使用它们
"no-use-before-define": 1,

4、编写风格相关:

// 指定数组的元素之间要以空格隔开(, 后面), never参数:[ 之前和 ] 之后不能带空格,always参数:[ 之前和 ] 之后必须带空格
"array-bracket-spacing": [2, "never"],
// 禁止或强制在单行代码块中使用空格(禁用)
"block-spacing":[1, "never"],
//强制使用一致的缩进 第二个参数为 "tab" 时,会使用tab
"brace-style": [2, "1tbs", {"allowSingleLine": true}],
// 双峰驼命名格式
"camelcase": 2,
// 控制逗号前后的空格
"comma-spacing": [2, {"before": false, "after": true}],
// 控制逗号在行尾出现还是在行首出现 (默认行尾)
"comma-style": [2, "last"],
//"SwitchCase" (默认:0) 强制 switch 语句中的 case 子句的缩进水平
// 以方括号取对象属性时,[ 后面和 ] 前面是否需要空格, 可选参数 never, always
"computed-property-spacing": [2, "never"],
// 文件末尾强制换行
"eol-last": 2,
"indent": [2, 4, {"SwitchCase": 1}],
// 强制在对象字面量的属性中键和值之间使用一致的间距
"key-spacing": [2, {"beforeColon": false, "afterColon": true}],
// 强制使用一致的换行风格
"linebreak-style": [1, "unix"],
// 要求在注释周围有空行 ( 要求在块级注释之前有一空行)
"lines-around-comment": [1, {"beforeBlockComment": true}],
// 强制一致地使用函数声明或函数表达式,方法定义风格,参数:
// declaration: 强制使用方法声明的方式,function f(){} e.g [2, "declaration"]
// expression:强制使用方法表达式的方式,var f = function() {} e.g [2, "expression"]
// allowArrowFunctions: declaration风格中允许箭头函数。 e.g [2, "declaration", { "allowArrowFunctions": true }]
"func-style": 0,
// 强制回调函数最大嵌套深度 5层
"max-nested-callbacks": [1, 5],
// 强制在 JSX 属性中一致地使用双引号或单引号
"jsx-quotes": 1,
// 强制在关键字前后使用一致的空格 (前后腰需要)
"keyword-spacing": 2,
// 强制 function 定义中最多允许的参数数量
"max-params":[1, 7],
// 要求构造函数首字母大写 (要求调用 new 操作符时有首字母大小的函数,允许调用首字母大写的函数时没有 new 操作符。)
"new-cap": [2, {"newIsCap": true, "capIsNew": false}],
// 禁止使用 Array 构造函数
"no-array-constructor": 2,
// 要求方法链中每个调用都有一个换行符
"newline-per-chained-call": 1,
// 不允许空格和 tab 混合缩进
"no-mixed-spaces-and-tabs": 2,
// 禁止使用 Object 的构造函数
"no-new-object": 2,
// 禁止 function 标识符和括号之间出现空格
"no-spaced-func": 2,
// 禁止可以在有更简单的可替代的表达式时使用三元操作符
"no-unneeded-ternary": 2,
// 强制函数中的变量要么一起声明要么分开声明
"one-var": [2, {"initialized": "never"}],
// 要求或禁止在可能的情况下要求使用简化的赋值操作符
"operator-assignment": 1,
// 强制操作符使用一致的换行符
"operator-linebreak": [2, "after", {"overrides": {"?":"before", ":": "before"}}],
// 强制使用一致的反勾号、双引号或单引号
"quotes": [2, "single", "avoid-escape"],
// 要求使用 JSDoc 注释
"require-jsdoc": 1,
// 要求或禁止使用分号而不是 ASI(这个才是控制行尾部分号的,)
"semi": [2, "always"],
// 强制在块之前使用一致的空格
"space-before-blocks": [2, "always"],
// 强制在 function的左括号之前使用一致的空格
"space-before-function-paren": [2, "always"],
// 强制在圆括号内使用一致的空格
"space-in-parens": [2, "never"],
// 要求操作符周围有空格
"space-infix-ops": 2,
// 强制在一元操作符前后使用一致的空格
"space-unary-ops": [2, {"words": true, "nonwords": false}],
// 强制在注释中 // 或 /* 使用一致的空格
"spaced-comment": [2, "always", {"markers": ["global", "globals", "eslint", "eslint-disable", "*package","!"] }],

ES6相关

// 要求箭头函数体使用大括号
"arrow-body-style": 2,
// 要求箭头函数的参数使用圆括号
"arrow-parens": 2,
"arrow-spacing":[2, {"before": true, "after": true}],
// 强制在子类构造函数中用super()调用父类构造函数,TypeScrip的编译器也会提示
"constructor-super": 0,
// 强制 generator 函数中 * 号周围使用一致的空格
"generator-star-spacing": [2, {"before": true, "after": true}],
// 禁止修改类声明的变量
"no-class-assign": 2,
// 不允许箭头功能,在那里他们可以混淆的比较
"no-confusing-arrow": 0,
// 禁止修改 const 声明的变量
"no-const-assign": 2,
// 禁止类成员中出现重复的名称
"no-dupe-class-members": 2,
// 不允许复制模块的进口
"no-duplicate-imports": 0,
// 禁止 Symbol 的构造函数
"no-new-symbol": 2,
// 允许指定模块加载时的进口
"no-restricted-imports": 0,
// 禁止在构造函数中,在调用 super() 之前使用 this 或 super
"no-this-before-super": 2,
// 禁止不必要的计算性能键对象的文字
"no-useless-computed-key": 0,
// 要求使用 let 或 const 而不是 var
"no-var": 1,
// 要求或禁止对象字面量中方法和属性使用简写语法
"object-shorthand": 0,
// 要求使用箭头函数作为回调
"prefer-arrow-callback": 0,
// 要求使用 const 声明那些声明后不再被修改的变量
"prefer-const": 0,
// 要求在合适的地方使用 Reflect 方法
"prefer-reflect": 0,
// 要求使用扩展运算符而非 .apply()
"prefer-spread": 0,
// 要求使用模板字面量而非字符串连接
"prefer-template": 0,
// Suggest using the rest parameters instead of arguments
"prefer-rest-params": 0,
// 要求generator 函数内有 yield
"require-yield": 0,
// enforce spacing between rest and spread operators and their expressions
"rest-spread-spacing": 0,
// 强制模块内的 import 排序
"sort-imports": 0,
// 要求或禁止模板字符串中的嵌入表达式周围空格的使用
"template-curly-spacing": 1,
// 强制在 yield* 表达式中 * 周围使用空格
"yield-star-spacing": 2

eslint 检查指令

检查指定文件且自动修复,修复官网中带🔧的规则对应的错误👇

eslint app.js --fix(eslint * --fix所有文件)

忽略文件

可以通过对.eslintignore,.gitignore,.jshintignore 文件的配置,对一些文件进行忽略,该文件则不进行相应eslint检测,ESLint除了对 .eslintignore 文件中的配置进行忽略,还会自动忽略 /node_modules/* 和 /bower_components/* 中的文件

 "eslintIgnore": ["hello.js", "world.js"]

与开发工具的结合

1、Atom
Atom----Preferences----Install选项----搜索(linterlinter-eslint)----Install按钮,如图:

atom示例.png

2、WebStorm
Preferences ---- Languages & Frameworks ---- JavaScript ---- Code Quality Tools ----Eslint ---- Enable (勾选) ---- Apply ---- OK

3、Sublime
调出package control ---- 搜索(SublimeLinterSublimeLinter-contrib-eslint)---- 点击安装(据说该插件只支持Sublime text 3)

sublime示例.png

结束语

Eslint的配置很灵活,你可以不使用业界已经存在的规范(例如airbnb),可以完全由自己定制。有了Eslint的限制,一定程度上会保证代码的质量和整洁程度,刚开始的使用会让你感到一丢丢的麻烦,但是养成一个良好的编码习惯对你还是对后续开发人员来说都是有利的,所以建议大家可以将Eslint集成到项目中,来提高代码的质量和整洁程度

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

推荐阅读更多精彩内容

  • ESLint 配置 ESlint 被设计为完全可配置的,这意味着你可以关闭每一个规则而只运行基本语法验证,或混合和...
    静默虚空阅读 41,216评论 3 14
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • EsLint入门学习整理 这两天因为公司要求,就对ESLint进行了初步的了解,网上的内容基本上都差不多,但是内容...
    点柈阅读 26,000评论 3 42
  • ESLint最初是由Nicholas C. Zakas 于2013年6月创建的开源项目。它的目标是提供一个插件化的...
    gavinDu阅读 1,770评论 1 1
  • 两个月之前在项目中就开始使用 Eslint ,当时直接 copy 别人的 .eslintrc.js 文件,感觉好复...
    dkvirus阅读 111,788评论 33 190