# @adonisjs/eslint-config 中文文档

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

版本：3\.1\.0
npm 元数据更新时间：2026-05-29T05:18:41.273Z
中文译文更新时间：2026-11-05T17:33:23.554Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：15 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：6 个
- peer 依赖：eslint ^9\.9\.0 \|\| ^10\.0\.0，prettier ^3\.8\.1，eslint-plugin-vue ^10\.9\.1，eslint-plugin-react ^7\.37\.5，eslint-plugin-react-hooks ^7\.1\.1
- 首次发布：2023-06-15T20:56:18.067Z
- 最新版本发布：2026-05-29T05:18:40.919Z
- 近 30 天下载量：261370（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 8 个）

## 中文简介

AdonisJS 应用程序和软件包使用的 ESLint 基础配置

## 安装

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

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

## README

# @ adonisjs/eslint-config

> 兼容 ESLint 9.0 和 Pretier 3

* * *

  

### AdonisJS核心团队使用的ESLint预设

这个 `adonisjs/eslint-config` 拥有阿多尼斯JS核心团队使用的默认ESLint规则的舰只. 预设曲被调制成与Prettier一起工作.

  

[![npm-image](https://img.shields.io/npm/v/@adonisjs/eslint-config/latest.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@adonisjs/eslint-config/v/latest "npm") [![license-image](https://img.shields.io/github/license/adonisjs/adonis-framework?style=for-the-badge)](https://npmcn.com/package/%40adonisjs/eslint-config/LICENSE.md)

## 安装

从 npm 注册处安装软件包 .

```sh
npm i -D @adonisjs/eslint-config@beta

# Install peer dependencies
npm i -D eslint@9 prettier@3
```

## 使用量

安装后,根据应用程序/图书馆的性质使用以下预设之一.

**软件包开发**: 开发软件包时使用下列预设

```ts
// eslint.config.js
import { configPkg } from '@adonisjs/eslint-config'
export default configPkg()
```

**应用程序开发**: 在开发 AdonisJS 应用程序时使用以下预设

```ts
// eslint.config.js
import { configApp } from '@adonisjs/eslint-config'
export default configApp()
```

### 惯性支持

若为 `@adonisjs/inertia` ,将自动启用以下规则对文件进行安装 `inertia/**`数字 :

-   `@adonisjs/no-backend-import-in-frontend`: 防止在前端文件中导入后端代码
-   `@adonisjs/prefer-adonisjs-inertia-link`: 使用 AdonisJS 类型安全的建议 `<Link>` 组件而不是Inertia的 `<Link>` 组件

## 添加额外的配置块

您可以将附加的配置块作为多个参数传递到一个预设函数.

```ts
import { configApp, INCLUDE_LIST, GLOBAL_IGNORE_LIST } from '@adonisjs/eslint-config'

export default configApp({
  name: 'Custom config',
  files: INCLUDE_LIST,
  ignores: GLOBAL_IGNORE_LIST,
  plugins: {
    // ESLint plugins go here
  },
  rules: {
    // ESLint rules go here
  },
})
```

### [网站](https://adonisjs.com/) | [指南](https://docs.adonisjs.com/) | [捐款](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md)

由 QQ 创建 [朱利安·里普乌托](https://github.com/Julien-R44) 财务报告和审定财务报表 [维克号](https://github.com/thetutlage)

## 常见问题

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

AdonisJS 应用程序和软件包使用的 ESLint 基础配置

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

在项目目录运行 npm install @adonisjs/eslint-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^9\.9\.0 \|\| ^10\.0\.0）、prettier（^3\.8\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/adonisjs\_\_eslint-config 是否存在。

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

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

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

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

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

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

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

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