eslint-config-ali

Install

eslint-config-ali 是一个可共享 ESLint 配置包，包内开启了一些 ESLint 原生规则和第三方插件规则。因此在使用 eslint-config-ali 时，需要保证项目同时安装了以下依赖的指定版本（这几个依赖在 eslint-config-ali 的 package.json 中作为 peerDependencies 进行了声明）：

• eslint@^5.5.0
• eslint-plugin-import@^2.14.0
• eslint-plugin-react@^7.4.0

对于未配置过 ESLint 的项目，可执行如下命令进行安装：

npm install --save-dev eslint-config-ali eslint@^5.5.0 eslint-plugin-import@^2.14.0 eslint-plugin-react@^7.4.0

对于已配置过 ESLint 的项目，同样可以执行以上命令安装，但要注意如果你的项目已安装过本包的 peerDependencies 依赖，需保证它们的版本正确。

Usage

在项目的 ESLint 配置 中（即 .eslintrc.* 文件或 package.json 的 eslintConfig 字段中）继承 eslint-config-ali。

本包提供了 3 份可选的配置，分别针对 ES6 项目（默认）、React 项目、ES5 项目。

对 ES6 项目：

{
  "extends": "eslint-config-ali"
}

对 React 项目：

{
  "extends": "eslint-config-ali/react"
}

对 ES5 项目：

{
  "extends": "eslint-config-ali/es5"
}

Learn more

• 如果你对 ESLint 还不熟悉，可通过官网的 Getting Started 快速入门。
• 了解如何在继承本包的基础上对项目的 ESLint 进行个性化配置，可参考官网的 Configuring ESLint。ESLint 配置中常用的几个字段简介：
  • extends: 继承一组规则集。"extends": "eslint-config-ali", 表示继承本包定义的规则配置。
  • rules: 配置规则，这里定义的规则会覆盖 extends 的规则。如果觉得本包开启的某条规则过于严格，你可以暂时在这里将其关闭。
  • parser: 设置 ESLint 的解析器。ESLint 使用 espree 作为默认的解析器，可以通过这个参数指定其他的解析器。比如指定为 babel-eslint，以解析 Babel 支持但 ESLint 默认解析器不支持的语法。
  • globals: 指定代码中可能用到的全局变量，以免全局变量被 no-undef 规则报错。
  • env: 指定代码的运行环境，每个环境预定义了一组对应的全局变量，本包已开启的环境有 browser、node、jquery、es6。
• 了解如何给自己的 IDE 配置 ESLint，可参考官网的 Integrations。
• 了解常用的 ESLint 命令，如 --fix、--ext、-f，可参考官网的 Command Line Interface。