# @antfu/eslint-define-config 中文文档

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

版本：1\.23\.0-2
npm 元数据更新时间：2023-10-24T05:55:54.455Z
中文译文更新时间：2026-11-06T06:30:53.186Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：3 MB，1471 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：0 个
- 首次发布：2023-10-08T13:16:52.847Z
- 最新版本发布：2023-10-24T05:55:54.288Z
- 近 30 天下载量：31601（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

为.eslintrc.js文件提供定义的Config函数

## 安装

```sh
npm install @antfu/eslint-define-config
```

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

## README

# @antfu/eslint-define-config (英语)

一个叉子 [eslint 定义配置](https://github.com/Shinigami92/eslint-define-config) 用于实验更好的平面配置支持.

## 此分叉中的变化

### 1\. 每个插件的再出口规则

```ts
import {
  VitestRules,
  VueRules,
  // ...
} from '@antfu/eslint-define-config'
```

### 2\. 允许超越规则

```ts
import pluginVitest from 'eslint-plugin-vitest'
import {
  defineFlatConfig,
  VitestRules
} from '@antfu/eslint-define-config'

export default defineFlatConfig<VitestRules, /* Strict */ true>({
  plugins: {
    vitest: pluginVitest,
  },
  rules: {
    // only `vitest/` rules are allowed and will be auto-completed
    'vitest/no-async': 'error',

    // @ts-expect-error not allowed
    'indent': 'error'
  },
})
```

### 3\. 支助重命名规则

```ts
import {
  RenamePrefix,
  TypeScriptRules // { '@typescript-eslint/indent': 'error', ... }
} from '@antfu/eslint-define-config'

type RenamedRules = RenamePrefix<TypeScriptRules, '@typescript-eslint/', 'ts/'>
// { 'ts/indent': 'error', ... }
```

这样它可以用于平面配置插件重命名 :

```ts
import pluginTypeScript from '@typescript-eslint/eslint-plugin'
import {
  defineFlatConfig,
  RenamePrefix,
  TypeScriptRules
} from '@antfu/eslint-define-config'

type RenamedRules = RenamePrefix<TypeScriptRules, '@typescript-eslint/', 'ts/'>

export default defineFlatConfig<RenamedRules>({
  plugins: {
    ts: pluginTypeScript, // renames to `ts/`
  },
  rules: {
    'ts/indent': 'error',

    // now we have auto-completion for `ts/` rules
  },
})
```

## 常见问题

### @antfu/eslint-define-config 是什么？

为\.eslintrc\.js文件提供定义的Config函数

### 如何安装 @antfu/eslint-define-config？

在项目目录运行 npm install @antfu/eslint-define-config，或使用 pnpm add / yarn add / bun add。

### @antfu/eslint-define-config 支持 TypeScript 吗？

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

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

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

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

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

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

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

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

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

最新版本 1\.23\.0-2 发布于 2023/10/24（3 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/10/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。