yllon-eslint-config

JavaScript 项目 : yllon-eslint-config

TODO: 定制化eslint规范 支持JavaScript、TypeScript、Vue、Node.js

依赖

• @babel/core@^7.16.0
• @babel/eslint-parser@^7.16.3
• eslint-plugin-import@^2.25.3

安装

npm i -D yllon-eslint-config @babel/core @babel/eslint-parser eslint-plugin-import

配置

绝对路径：

{
  "extends": ["yllon-eslint-config"]
}

如果编译器不支持绝对路径导入报错，可更换成相对路径导入。 相对路径：

{
  "extends": ["./node_modules/yllon-eslint-config"]
}

JavaScript + Vue 项目 : yllon-eslint-config/javascript/vue

针对 JS Vue 的项目，继承了默认配置，并启用了 eslint-plugin-vue 插件的规则，使用 vue-eslint-parser 作为 parser。

依赖

• @babel/core@^7.16.0
• @babel/eslint-parser@^7.16.3
• eslint-plugin-import@^2.25.3
• vue-eslint-parser@^7.0.0
• eslint-plugin-vue@^7.3.0

安装

npm i -D yllon-eslint-config @babel/core @babel/eslint-parser eslint-plugin-import vue-eslint-parser eslint-plugin-vue

配置

绝对路径：

{
  "extends": ["yllon-eslint-config/javascript/vue"]
}

如果编译器不支持绝对路径导入报错，可更换成相对路径导入。 相对路径：

{
  "extends": ["./node_modules/yllon-eslint-config/javascript/vue"]
}

JavaScript (Node.js) 项目 : yllon-eslint-config/javascript/node

针对 Node.js 项目，继承了默认配置和 eslint-config-egg 的规则，规则由 ESLint 原生规则和 eslint-plugin-node 提供。

依赖

• @babel/core@^7.16.0
• @babel/eslint-parser@^7.16.3
• eslint-plugin-import@^2.25.3
• eslint-config-egg@^10.0.0

安装

npm i -D yllon-eslint-config @babel/core @babel/eslint-parser eslint-plugin-import eslint-config-egg

配置

绝对路径：

{
  "extends": ["yllon-eslint-config/javascript/node"]
}

如果编译器不支持绝对路径导入报错，可更换成相对路径导入。 相对路径：

{
  "extends": ["./node_modules/yllon-eslint-config/javascript/node"]
}

TypeScript 项目 ： yllon-eslint-config/typescript

针对未使用 Vue 的 TypeScript 项目，继承了默认配置，并启用了 @typescript-eslint/eslint-plugin 插件的规则，使用 @typescript-eslint/parser 作为 parser。

依赖

• @typescript-eslint/parser@^5.0.0
• @typescript-eslint/eslint-plugin@^5.0.0
• eslint-plugin-import@^2.25.3
• eslint-import-resolver-typescript@2

安装

npm i -D yllon-eslint-config @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-import-resolver-typescript

配置

绝对路径：

{
  "extends": ["yllon-eslint-config/typescript"]
}

如果编译器不支持绝对路径导入报错，可更换成相对路径导入。 相对路径：

{
  "extends": ["./node_modules/yllon-eslint-config/typescript"]
}

需保证项目已安装 typescript 依赖，另外如果项目的 TS 配置文件不是 ./tsconfig.json，则需要设置 .eslintrc 中的 parserOptions.project 字段 ，例如：

{
  "extends": "yllon-eslint-config/typescript",
  "parserOptions": {
    "project": "./tsconfig.eslint.json"
  }
}

TypeScript + Vue 项目 ： yllon-eslint-config/typescript/vue

针对 TS Vue 项目，继承了 JS Vue 的配置，并启用了 @typescript-eslint/eslint-plugin 插件的规则，使用 @typescript-eslint/parser 作为 parser。

依赖

• @typescript-eslint/parser@^5.0.0
• @typescript-eslint/eslint-plugin@^5.0.0
• eslint-plugin-import@^2.25.3
• eslint-import-resolver-typescript@2
• vue-eslint-parser@^7.0.0
• eslint-plugin-vue@^7.3.0

安装

npm i -D yllon-eslint-config @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-import-resolver-typescript vue-eslint-parser eslint-plugin-vue

配置

绝对路径：

{
  "extends": ["yllon-eslint-config/typescript/vue"]
}

如果编译器不支持绝对路径导入报错，可更换成相对路径导入。 相对路径：

{
  "extends": ["./node_modules/yllon-eslint-config/typescript/vue"]
}

TypeScript (Node.js) 项目 ： yllon-eslint-config/typescript/node

针对未使用 Vue 的 TypeScript(Node) 项目，继承了 JS Node.js 配置，并启用了 @typescript-eslint/eslint-plugin 插件的规则，使用 @typescript-eslint/parser 作为 parser。

依赖

• @typescript-eslint/parser@^5.0.0
• @typescript-eslint/eslint-plugin@^5.0.0
• eslint-plugin-import@^2.25.3
• eslint-import-resolver-typescript@2
• eslint-config-egg@^10.0.0

安装

npm i -D yllon-eslint-config @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-import-resolver-typescript eslint-config-egg

配置

绝对路径：

{
  "extends": ["yllon-eslint-config/typescript/node"]
}

如果编译器不支持绝对路径导入报错，可更换成相对路径导入。 相对路径：

{
  "extends": ["./node_modules/yllon-eslint-config/typescript/node"]
}

配合 Prettier 使用

如果你的项目使用 Prettier 进行代码格式化，本包的一些规则可能会跟 Prettier 格式化结果有冲突，例如这条规则。为了避免冲突，你需要手动安装 eslint-config-prettier 和 eslint-plugin-prettier：

安装

npm install --save-dev eslint-config-prettier eslint-plugin-prettier

配置

并修改 .eslintrc 的 extends 配置，增加 prettier，如下（以 TS Vue 项目为例）： 绝对路径：

{
  "extends": ["yllon-eslint-config/typescript/vue", "prettier"]
}

如果编译器不支持绝对路径导入报错，可更换成相对路径导入。 相对路径：

{
  "extends": ["./node_modules/yllon-eslint-config/typescript/vue", "prettier"]
}

了解更多请阅读 Prettier - Integrating with Linters。

扩充

• extends: 继承一组规则集。"extends": "encode-fe-eslint-config", 表示继承本包定义的规则配置。
• rules: 配置规则，这里定义的规则会覆盖 extends 的规则。如果觉得本包开启的某条规则过于严格，你可以暂时在这里将其关闭。
• parser: 设置 ESLint 的解析器。ESLint 使用 espree 作为默认的解析器，可以通过这个参数指定其他的解析器。比如指定为 @babel/eslint-parser，以解析 Babel 支持但 ESLint 默认解析器不支持的语法（本包不同配置文件使用的解析器可在简介表格中的「依赖 parser」一列查看）。
• globals: 指定代码中可能用到的全局变量，以免全局变量被 no-undef 规则报错。
• env: 指定代码的运行环境，每个环境预定义了一组对应的全局变量，本包已开启的环境有 browser、node、jquery、es6 及几个测试框架的环境。
• 了解常用的 ESLint 命令，如 --fix、--ext，可参考官网的 Command Line Interface。
• Eslint官网：Getting Started