在日常的团队开发中,为了避免出现低级bug和统一代码风格,通常会在开发前约定一套编码规范。为了保证规范的执行,可以使用Lint工具和代码风格检测工具。
ESLint就是一个Lint工具,它是由JS红宝书的作者Nicholas C.Zakas创立的一个开源项目,旨在为大家提供一个可扩展、每条规则独立、不内置编码风格的语法检查工具。

ESLint的配置

在项目中配置ESLint有两种基本方法:
1.用JavaScript注解的方式将配置信息直接加到文件中。
2.使用JavaScript、JSON或YAML文件为整个目录定义配置信息。文件格式可以是.eslintrc.*或package.json。ESLint会自动查找并读取配置文件。

配置规则

Environments
脚本将要运行的环境,每个环境都有自己预定义好的全局变量集合。通过env关键字配置Environments选项,下面的配置表示脚本将运行在浏览器和node环境。

//package.json
{
  "env":{
    "browser":true,
    "node":true
  }
}

Globals
在脚本运行期间需要额外加入的全局变量。当变量在当前文件中未定义却被访问时,会触发未定义规则警告。因此,如果设置了一些全局变量,则需要在ESLint的配置文件中进行配置。

//package.json
{
  "globals":{
    "varA":true,
    "varB":false
   }
}

上述配置表明varA、varB都是全局变量,其中varB的值不可写(只读)。
Rules
ESLint提供了大量的规则,用户通过配置规则是否生效来定义自己的项目需要使用哪些规则。

//package.json
{
  "rules":{
    "eqeqe":"off",
    "curly":"error"
  }
}
Logo

开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!

更多推荐