td-eslint-config

天道金科 eslint-config 配置文件。

特别注意

ESLint 要求共享配置包的包名符合 eslint-config-xxx 或 @xxx/eslint-config-xxx 的命名规范，但是因为我们公司包的命名要求是 td-xxx 的，所以无法直接使用 td-eslint-config 包名。

解决方法是在安装依赖时重命名包名，将 td-eslint-config 修改为 @tdft/eslint-config，如下：

{
  "devDependencies": {
    "@tdft/eslint-config": "npm:td-eslint-config"
  }
}

也可以在安装时直接指定：

npm i -D @tdft/eslint-config@npm:td-eslint-config

共享配置列表

• @tdft/eslint-config/eslint - 基础 ESLint 规则
• @tdft/eslint-config/vue-typescript - 启用 TypeScript 的 Vue 2.7 规则

说明

已关闭和 Prettier 相关的规则，格式化全部交给 Prettier 负责，请使用 td-prettier-config。

使用方式

为了避免在项目中引入过多 ESLint 依赖，使用 @rushstack/eslint-patch 解决已知的 ESLint 依赖问题。

1. 安装依赖

npm i -D @tdft/eslint-config@npm:td-eslint-config @rushstack/eslint-patch

2. 选择共享配置

eslint

通用 ESLint 规则，继承自 eslint:recommended 并关闭了和 Prettier 冲突的规则。

/* .eslintrc.js */

/* eslint-env node */
require('@rushstack/eslint-patch/modern-module-resolution')

module.exports = {
  root: true,

  extends: ['@tdft/eslint-config/eslint'],
}

vue-typescript

启用了 TypeScript 的 Vue 2.7 规则，使用的是 Vue 官方推荐的规则集。

/* .eslintrc.js */

/* eslint-env node */
require('@rushstack/eslint-patch/modern-module-resolution')

module.exports = {
  root: true,

  extends: ['@tdft/eslint-config/vue-typescript'],
}