编码规范

# cd-eslint-config

TIP

印客学院 JavaScript TypeScript Node 规范

提供了多套配置文件以支持 JavaScript、TypeScript、React、Vue、Node.js 等多种项目类型。

# JavaScript 项目 - cd-eslint-config

针对未使用 React 或 Vue 的原生 JavaScript 项目，使用 ESLint 原生规则和 eslint-plugin-import (opens new window) 规则，使用 @babel/eslint-parser (opens new window) 作为 parser，是本包的默认配置。

# 依赖

# 安装

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

# 配置

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

# JavaScript + React 项目 - cd-eslint-config/react

针对 JS React 项目，继承了默认配置，并启用了 eslint-plugin-react (opens new window) 和 eslint-plugin-react-hooks (opens new window) 的规则。

# 依赖

# 安装

npm i -D cd-eslint-config @babel/core @babel/eslint-parser eslint-plugin-import eslint-plugin-react eslint-plugin-react-hooks

# 配置

{
  "extends": ["cd-eslint-config/react"]
}

如果需要无障碍能力：

npm i -D eslint-plugin-jsx-a11y

{
  "extends": ["cd-eslint-config/react", "cd-eslint-config/jsx-a11y"]
}

# JavaScript + Vue 项目 - cd-eslint-config/vue

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

# 依赖

# 安装

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

# 配置

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

# JavaScript (Node.js) 项目 - cd-eslint-config/node

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

# 依赖

# 安装

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

# 配置

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

# TypeScript 项目 - cd-eslint-config/typescript

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

# 依赖

# 安装

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

# 配置

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

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

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

# TypeScript + React 项目 - cd-eslint-config/typescript/react

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

# 依赖

# 安装

npm i -D cd-eslint-config @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-import-resolver-typescript eslint-plugin-react eslint-plugin-react-hooks

# 配置

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

如果需要无障碍能力：

npm i -D  eslint-plugin-jsx-a11y

{
  "extends": ["cd-eslint-config/typescript/react", "cd-eslint-config/jsx-a11y"]
}

# TypeScript + Vue 项目 - cd-eslint-config/typescript/vue

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

# 依赖

# 安装

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

# 配置

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

# TypeScript (Node.js) 项目 - cd-eslint-config/typescript/node

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

# 依赖

# 安装

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

# 配置

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

# 配合 Prettier 使用

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

# 安装

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

# 配置

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

{
  "extends": ["cd-eslint-config/typescript/react", "prettier"]
}

了解更多请阅读 Prettier - Integrating with Linters (opens new window)。

# 将风格问题降级

为了保证一致的编码风格，本包中大量风格相关的规则被设为了 error 级别，以引起开发者的足够重视。如果你觉得风格问题不足以是 error 级别（有些用户根据 ESLint error 进行流程卡点），本包还提供了一套名为 'essential' 的配置文件，这套配置将所有风格问题降级为 warn 级别，仅将必要问题报告为 error，引用方式为在相应配置的 cd-eslint-config 后面加上 /essential，如对 JS React 项目为 cd-eslint-config/essential/react、对 TS Vue 项目为 cd-eslint-config/essential/typescript/vue

# 了解更多

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