2019-08-11

eslint简介

eslint是什么?

ESLint是一个用来识别 ECMAScript 并且按照规则给出报告的代码检测工具,使用它可以避免低级错误和统一代码的风格。

eslint的安装

ESLint被设计为完全可配置的,主要有两种方式来配置ESLint:

在注释中配置:使用JavaScript注释直接把配置嵌入到JS文件中。
配置文件:使用下面任一的文件来为全部的目录和它的子目录指定配置信息。

javascript:使用.eslintrc.js文件并导出一个包含配置的对象。
YAML:.eslintrc.yaml或者.eslintrc.yml
JSON:.eslintrc.json,并且此文件允许使用JS形式的注释
废弃的用法:.eslintrc,此文件可以是JSON或者YAML
package.json:在package.json文件中创建eslintConfig属性,所有的配置包含在此属性中。

全局安装

npm i -g eslint

局部安装(推荐)

npm i -D eslint

安装完毕后,接下来新建一个配置文件.eslintrc.js,或者使用如下的命令行来自动生成。

eslint --init

配置


指定执行环境

JavaScript 代码可以运行在浏览器或 nodejs 等环境中,每个环境的全局变量都不尽相同(如 nodejs 中没有 DOM 相关的全局变量)。在配置文件中可以自由的指定执行环境。

// .eslintrc.js
module.exports = {
  env: {
    browser: true,
    node: true,
  },
};

指定全局变量

可以在配置文件或注释中指定额外的全局变量,false表明变量只读:

  • 使用注释来配置:
/* global var1, var2 */
/* global var1:false, var2:false */

  • 使用配置文件来配置:
// .eslintrc.js
module.exports = {
  globals: {
    var1: true,
    var2: true,
  },
};

规则

在配置文件中可以设置一些规则。

这些规则的等级有三种:

  • "off" 或者 0:关闭规则。
  • "warn" 或者 1:打开规则,并且作为一个警告(不影响exit code)。
  • "error" 或者 2:打开规则,并且作为一个错误(exit code将会是1)

使用方法

命令行

通过命令行工具来使用 eslint 。

eslint [options] file.js [file.js] [dir]

编辑器

配合相应的插件,在vscode中直接显示错误和警告。

image

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • ESLint 配置 ESlint 被设计为完全可配置的,这意味着你可以关闭每一个规则而只运行基本语法验证,或混合和...
    静默虚空阅读 41,822评论 3 14
  • 一、JSLint JSHint ESLint 参考前端工具考 - ESLint 篇JS Linter 进化史 C ...
    合肥黑阅读 77,126评论 0 47
  • EsLint入门学习整理 这两天因为公司要求,就对ESLint进行了初步的了解,网上的内容基本上都差不多,但是内容...
    点柈阅读 26,171评论 3 42
  • 两个月之前在项目中就开始使用 Eslint ,当时直接 copy 别人的 .eslintrc.js 文件,感觉好复...
    dkvirus阅读 112,463评论 33 190
  • 长夜无边 笼罩着茫茫人间 窗外的天光暗淡 无声的静寂 无尽地绵延 睁开朦胧睡眼 轻轻地 走向庭院 徘徊在篱下花前 ...
    岭表阅读 4,881评论 20 52

友情链接更多精彩内容