# @forgerock/eslint-config 中文文档

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

版本：2\.0\.0
npm 元数据更新时间：2026-07-14T16:40:30.860Z
中文译文更新时间：2026-11-15T07:47:19.227Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：15.2 kB，32 个文件
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：eslint ^6\.5\.1，eslint-plugin-babel ^5\.3\.0，eslint-plugin-jsdoc ^15\.11\.1，eslint-plugin-react ^7\.16\.0，eslint-plugin-promise ^4\.2\.1，eslint-plugin-jsx-a11y ^6\.2\.3，eslint-plugin-filenames ^1\.3\.2，eslint-plugin-react-hooks ^2\.1\.2
- 首次发布：2018-12-14T15:48:24.566Z
- 最新版本发布：2020-03-04T13:16:38.167Z
- 近 30 天下载量：8267（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

ForgeRock 的 JavaScript 样式指南作为 ESLint 可共享配置 .

## 安装

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

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

## README

![](https://npmcn.com/package/%40forgerock/eslint-config/logo.png)

# ForgeRock ESLint 可共享配置

ForgeRock 的 JavaScript 样式指南作为 ESLint 可共享配置 .

 [![](https://img.shields.io/npm/v/@forgerock/eslint-config.svg?style=flat-square)](https://www.npmjs.com/package/@forgerock/eslint-config)![](https://img.shields.io/david/forgerock/eslint-config.svg?style=flat-square)

-   [先决条件](https://npmcn.com/package/%40forgerock/eslint-config/#readme-prerequisites)
-   [安装](https://npmcn.com/package/%40forgerock/eslint-config/#readme-installation)
    -   [通过 Yarn](https://npmcn.com/package/%40forgerock/eslint-config/#readme-via-yarn)
    -   [通过国家预防机制](https://npmcn.com/package/%40forgerock/eslint-config/#readme-via-npm)
-   [使用量](https://npmcn.com/package/%40forgerock/eslint-config/#readme-usage)
    -   [宝贝](https://npmcn.com/package/%40forgerock/eslint-config/#readme-babel)
    -   [内建](https://npmcn.com/package/%40forgerock/eslint-config/#readme-built-in)
    -   [文件名](https://npmcn.com/package/%40forgerock/eslint-config/#readme-filenames)
    -   [联合来文X a11y](https://npmcn.com/package/%40forgerock/eslint-config/#readme-jsx-a11y)
    -   [联合来文文件](https://npmcn.com/package/%40forgerock/eslint-config/#readme-jsdoc)
    -   [答应](https://npmcn.com/package/%40forgerock/eslint-config/#readme-promise)
    -   [反应](https://npmcn.com/package/%40forgerock/eslint-config/#readme-react)
    -   [反应钩](https://npmcn.com/package/%40forgerock/eslint-config/#readme-react-hooks)
-   [捐款](https://npmcn.com/package/%40forgerock/eslint-config/#readme-contributing)

## 先决条件

ForgeRock ESLint 可共享配置需要 [ESLint 语录](http://eslint.org/) 6.x. (中文(简体) ).

## 安装

### 通过 Yarn

```sh
yarn add @forgerock/eslint-config
```

### 通过国家预防机制

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

## 使用量

在下列规则中添加一个或多个 `extends` 区域 `.eslintrc.js` 配置 .

### 宝贝

```json
extends: ["@forgerock/eslint-config/babel"]
```

贝贝规则 [埃斯林特-插头-巴贝尔](https://github.com/babel/eslint-plugin-babel)。 。 。 .

如果您正在使用 `babel-eslint` par.

### 内建

```json
extends: ["@forgerock"]
```

内部规则 [ESLint 语录](http://eslint.org/docs/rules)。 。 。 .

### 文件名

```json
extends: ["@forgerock/eslint-config/filenames"]
```

文件名规则 [eslint-plugin 文件名](https://github.com/selaux/eslint-plugin-filenames)。 。 。 .

### 联合来文X a11y

```json
extends: ["@forgerock/eslint-config/jsx-a11y"]
```

JSX的准入规则 [埃斯林特-插头-jsx-a11y](https://github.com/evcohen/eslint-plugin-jsx-a11y)。 。 。 .

### 联合来文文件

```json
extends: ["@forgerock/eslint-config/jsdoc"]
```

JSDoc规则: [埃斯林特-插孔-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc)。 。 。 .

### 答应

```json
extends: ["@forgerock/eslint-config/promise"]
```

承诺规则 [埃斯林特- 插座- 保证](https://github.com/xjamundx/eslint-plugin-promise)。 。 。 .

### 反应

```json
extends: ["@forgerock/eslint-config/react"]
```

反应和JSX规则 [eslint- 插件反应](https://github.com/yannickcr/eslint-plugin-react)。 。 。 .

### 反应钩

```json
extends: ["@forgerock/eslint-config/react-hooks"]
```

反应 Hook 规则由 [eslint-plugin- react-hooks (英语)](https://github.com/facebook/react/tree/master/packages/eslint-plugin-react-hooks)。 。 。 .

## 捐款

打开 Pull 请求, 协助 ForgeRock ESLint 共享配置 .

## 常见问题

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

ForgeRock 的 JavaScript 样式指南作为 ESLint 可共享配置 \.

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

在项目目录运行 npm install @forgerock/eslint-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^6\.5\.1）、eslint-plugin-babel（^5\.3\.0）、eslint-plugin-jsdoc（^15\.11\.1）、eslint-plugin-react（^7\.16\.0）、eslint-plugin-promise（^4\.2\.1）、eslint-plugin-jsx-a11y（^6\.2\.3）、eslint-plugin-filenames（^1\.3\.2）、eslint-plugin-react-hooks（^2\.1\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

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

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

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

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

