# @edx/eslint-config 中文文档

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

版本：4\.4\.0
npm 元数据更新时间：2026-07-10T14:29:38.426Z
中文译文更新时间：2026-11-13T07:47:22.999Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：46.3 kB，16 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：eslint ^7\.32\.0 \|\| ^8\.2\.0，eslint-plugin-react ^7\.18\.0，eslint-config-airbnb ^18\.0\.1 \|\| ^19\.0\.0，eslint-plugin-import ^2\.25\.3，eslint-plugin-jsx-a11y ^6\.2\.3，@typescript-eslint/parser ^5\.62\.0，eslint-plugin-react-hooks ^1\.7\.0 \|\| ^4\.0\.0，eslint-config-airbnb-typescript ^17\.0\.0，@typescript-eslint/eslint-plugin ^5\.62\.0
- 首次发布：2020-01-30T21:09:43.696Z
- 最新版本发布：2025-08-13T00:16:14.176Z
- 近 30 天下载量：35406（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 0 个）

## 中文简介

EdX JavaScript代码的ESLint配置.

## 安装

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

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

## README

[![Build Status](https://github.com/openedx/eslint-config/actions/workflows/release.yml/badge.svg)](https://github.com/openedx/eslint-config/actions/workflows/release.yml/) [![NPM Version](https://img.shields.io/npm/v/@edx/eslint-config.svg)](https://www.npmjs.com/package/@edx/eslint-config) [![npm\_downloads](https://img.shields.io/npm/dt/@edx/eslint-config.svg)](https://www.npmjs.com/package/@edx/eslint-config) [![license](https://img.shields.io/npm/l/@edx/eslint-config.svg)](https://github.com/openedx/eslint-config/blob/master/LICENSE) [![semantic release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

# @ edx/ slint- config

## 安装

如果你在使用@edx/frontend-building,那么你会免费得到这个包. 否则,你可以通过:

```shell
npx install-peerdeps --dev @edx/eslint-config
```

这将安装软件包及其所有对等依赖 .

然后,一旦它安装, 创建一个 `.eslintrc.js` 在您的工程顶级目录中包含以下内容的文件 :

```js
module.exports = {
  extends: "@edx/eslint-config",
}
```

### 使用类型脚本

若为 `@edx/eslint-config` 检测到 a `tsconfig.json` 在您工程的根文件夹中的文件,它会选择配置 ESLint 来添加对 TypeScript 的支持。 如果有的话 `tsconfig.json` 文件已存在, ESLint 配置将 :

-   扩展 `airbnb-typescript` (单位:千美元)[来源](https://www.npmjs.com/package/eslint-config-airbnb-typescript)) (中文(简体) ).
-   配置 `parserOptions.project` 指着 `tsconfig.json` 在工程的根文件夹中存档.

`airbnb-typescript` 只有在下列情况下才可延长: `tsconfig.json` 文件存在于您的工程中.

狦 `tsconfig.json` 文件被定义到您工程的根文件夹以外的地方, 您可以通过扩展来覆盖默认的 ESLint 配置 `airbnb-typescript` 包括通往你 `tsconfig.json` 文档中 `parserOptions.project` ESLint配置.

## 常见问题

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

EdX JavaScript代码的ESLint配置\.

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

在项目目录运行 npm install @edx/eslint-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^7\.32\.0 \|\| ^8\.2\.0）、eslint-plugin-react（^7\.18\.0）、eslint-config-airbnb（^18\.0\.1 \|\| ^19\.0\.0）、eslint-plugin-import（^2\.25\.3）、eslint-plugin-jsx-a11y（^6\.2\.3）、@typescript-eslint/parser（^5\.62\.0）、eslint-plugin-react-hooks（^1\.7\.0 \|\| ^4\.0\.0）、eslint-config-airbnb-typescript（^17\.0\.0）、@typescript-eslint/eslint-plugin（^5\.62\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

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

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

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

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

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

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