# @doist/eslint-config 中文文档

规范地址：https://npmcn.com/package/%40doist/eslint-config/

版本：13\.1\.1
npm 元数据更新时间：2026-08-21T21:57:59.090Z
中文译文更新时间：2026-11-13T06:04:26.836Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40doist/eslint-config
原文对照：https://npmcn.com/package/%40doist/eslint-config/?lang=original
项目主页：https://github.com/Doist/eslint-config#readme
源码仓库：https://github.com/Doist/eslint-config

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：30.4 kB，19 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：5 个
- peer 依赖：eslint ^8\.57\.0 \|\| ^9\.0\.0，eslint-plugin-react ^7\.29\.4，eslint-plugin-import ^2\.29\.0，eslint-plugin-prettier ^5\.0\.0，@typescript-eslint/parser ^6\.0\.0 \|\| ^7\.0\.0 \|\| ^8\.0\.0，eslint-plugin-react-hooks ^7\.0\.1，@typescript-eslint/eslint-plugin ^6\.0\.0 \|\| ^7\.0\.0 \|\| ^8\.0\.0，eslint-plugin-simple-import-sort ^7\.0\.0 \|\| ^8\.0\.0 \|\| ^9\.0\.0 \|\| ^10\.0\.0 \|\| ^12\.0\.0
- 首次发布：2021-01-04T13:10:32.476Z
- 最新版本发布：2026-03-02T18:59:31.422Z
- 近 30 天下载量：2159（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 4 个）

## 中文简介

全局 [埃斯林特语name](https://eslint.org/) 相会.

## 安装

```sh
npm install @doist/eslint-config
```

也可以使用：`pnpm add @doist/eslint-config`、`yarn add @doist/eslint-config`、`bun add @doist/eslint-config`

## README

# `@doist/eslint-config`

剂量 [ESLint 语录](https://eslint.org/) 相会.

## 使用量

### 安装

```sh
npm install --save-dev @doist/eslint-config
```

### 平面配置

```js
// eslint.config.js
import eslintConfig from '@doist/eslint-config'

export default [
    // Core set of rules, recommended for all JS projects
    ...eslintConfig.recommended,
    // OR
    // Core set of rules, recommended for all TS projects
    ...eslintConfig.recommendedTypeChecked,

    // Additional rules for sorting/grouping import statements (optional)
    ...eslintConfig.simpleImportSort,

    // Recommended for projects using React.
    ...eslintConfig.react,
]
```

### .eslintrac Config( 列克西语)

单位 `.eslintrc`数字 :

```jsonc
{
    // ...
    "extends": [
        // ...

        // Core set of rules, recommended for all projects.
        "@doist/eslint-config/eslintrc/recommended",

        // Additional rules requiring type information (recommended for TypeScript projects).
        "@doist/eslint-config/eslintrc/recommended-type-checked",

        // Additional rules for sorting/grouping import statements (optional)
        "@doist/eslint-config/eslintrc/simple-import-sort"

        // Recommended for projects using React.
        "@doist/eslint-config/eslintrc/react"
    ],

    // When using `recommended-type-checked`,
    // you need to link to `tsconfig.eslint.json` file (see section below) for the project.
    "parserOptions": {
        "project": "tsconfig.eslint.json"
    }
}
```

### 导入排序的路径别名支持

如果您的项目使用路径化名( 例如 ) . `@components` 地图到 `src/components/`,可以配置 `simple-import-sort` 通过使用 `simpleImportSortFactory`。 。 。 .

**平面配置 :**

```js
// eslint.config.js
import eslintConfig from '@doist/eslint-config'

export default [
    ...eslintConfig.recommended,
    // Replace ...eslintConfig.simpleImportSort with a custom config:
    ...eslintConfig.simpleImportSortFactory({ aliases: ['@app', '@components'] }),
]
```

**遗产配置** ——在 `.eslintrc`数字 :

```js
const config = {
    extends: ['@doist/eslint-config/eslintrc/simple-import-sort'],
    rules: {
        'simple-import-sort/imports':
            require('@doist/eslint-config/lib/create-simple-import-sort').createSimpleImportSortConfig(
                { aliases: ['@app', '@components'] },
            ),
    },
}
```

别名归为一组(它们之间没有空白行),按它们在数组中的位置排列.

### 配置类型检查

对于基于类型的规则,项目 `tsconfig.json` 文件需要在 `parserOptions.project`。如果您想要插入未包含在构建中的文件,我们建议 创建单独的 `tsconfig.eslint.json` 配置并指定它而不是默认的.

注:在平面配置中, `recommendedTypeChecked` 套装 `project: true` 默认, 自动检测 `tsconfig.json`。 。 。 .

## 释放新软件包

这个项目使用 [语义版本](https://semver.org/)。当驱动新标签时,将向 npm 和 GitHub 软件包注册处发布新版本。 请确保增加一个条目 [变动情况](https://npmcn.com/package/%40doist/eslint-config/CHANGELOG.md)。 。 。 .

```
git checkout main
npm version <major|minor|patch>
git push --follow-tags
```

## 链接

-   [ESLint 可共享配置](https://eslint.org/docs/developer-guide/shareable-configs)

## 常见问题

### @doist/eslint-config 是什么？

全局 埃斯林特语name 相会\.

### 如何安装 @doist/eslint-config？

在项目目录运行 npm install @doist/eslint-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^8\.57\.0 \|\| ^9\.0\.0）、eslint-plugin-react（^7\.29\.4）、eslint-plugin-import（^2\.29\.0）、eslint-plugin-prettier（^5\.0\.0）、@typescript-eslint/parser（^6\.0\.0 \|\| ^7\.0\.0 \|\| ^8\.0\.0）、eslint-plugin-react-hooks（^7\.0\.1）、@typescript-eslint/eslint-plugin（^6\.0\.0 \|\| ^7\.0\.0 \|\| ^8\.0\.0）、eslint-plugin-simple-import-sort（^7\.0\.0 \|\| ^8\.0\.0 \|\| ^9\.0\.0 \|\| ^10\.0\.0 \|\| ^12\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @doist/eslint-config 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @doist/eslint-config 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @doist/eslint-config 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @doist/eslint-config 可以商用吗？

@doist/eslint-config 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @doist/eslint-config 的下载量有多少？

根据 npm 官方下载统计，@doist/eslint-config 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,159 次，日均约 72 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @doist/eslint-config 还在维护吗？

最新版本 13\.1\.1 发布于 2026/03/03（8 个月前）；至今共发布 26 个版本，其中过去 12 个月发布了 4 个；首次发布于 2021/01/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。