# @brightlayer-ui/eslint-config 中文文档

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

版本：4\.0\.1
npm 元数据更新时间：2025-10-17T05:46:22.904Z
中文译文更新时间：2026-11-08T15:22:04.961Z
软件包许可：BSD-3-Clause

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

原始 npm 页面：https://www.npmjs.com/package/%40brightlayer-ui/eslint-config
原文对照：https://npmcn.com/package/%40brightlayer-ui/eslint-config/?lang=original
项目主页：https://github.com/etn-ccis/blui-code-standards/tree/master/eslint-config#readme
源码仓库：https://github.com/etn-ccis/blui-code-standards

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

- 包体积（解压后）：13.9 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：6 个
- peer 依赖：typescript ^5\.8\.3
- 首次发布：2021-10-18T18:45:34.109Z
- 最新版本发布：2025-10-17T05:46:22.704Z
- 近 30 天下载量：17648（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

Blightlayer UI 的 ESLint 配置文件

## 安装

```sh
npm install @brightlayer-ui/eslint-config
```

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

## README

# 亮层 UI ESLint 配置

[![](https://img.shields.io/npm/v/@brightlayer-ui/eslint-config?label=%40brightlayer-ui%2Feslint-config&style=flat)](https://www.npmjs.com/package/@brightlayer-ui/eslint-config)

这个软件包包含了用于Typescript和TSX项目的Brightlayer UI ESLint配置. ESLint用于执行跨越Brightlayer UI应用程序的代码质量.

> **注:** Brightlayer UI ESLint 配置包只兼容 TypeScript 项目.

所有执行代码样式的ESLint规则都被禁用,有利于使用更漂亮的代码格式化. 参见 [@ brightlayer- ui/ pretier- config](https://www.npmjs.com/package/@brightlayer-ui/prettier-config) 在您的应用程序中加入更漂亮的.

## 安装

从您的软件包根部安装亮层用户界面配置 :

`yarn add --dev @brightlayer-ui/eslint-config`

您还需要安装以下对等依赖 :

`yarn add --dev eslint eslint-config-prettier @typescript-eslint/eslint-plugin @typescript-eslint/parser`

如果您的工程正在使用 TSX 文件扩展名 React, 您还需要安装 :

`yarn add --dev eslint-plugin-react`

## 配置

### 添加 Linting 脚本

将以下脚本添加到您的 `package.json`。 。 。 .

```
"scripts": {
    "lint": "eslint \"src/**/**.ts\"",
    "lint:fix": "eslint \"src/**/**.ts\" --fix",
}
```

> **TSX项目:** 确定将.tsx文件扩展名包含在您提示的命令中(例如. `eslint '**/**.{tsx,ts}'`(中文(简体) )

这个 `--fix` 旗帜将自动尝试修正报告的错误。 如果不这样做,将报告错误/警告,而不试图纠正错误/警告.

### 导入 Linting 配置

Blightlayer UI配置需要导入到ESLint. 添加以下内容: `.eslintrc.js` 到您的项目根部.

```
module.exports =  {
    parser:  '@typescript-eslint/parser',
    extends:  [ '@brightlayer-ui/eslint-config/ts' ],
    parserOptions:  {
        project: "./tsconfig.json",
    },
    env: {
        browser: true
    }
};
```

> **TSX项目:** 从 `@brightlayer-ui/eslint-config/tsx`。 。 。 .

## 使用量

要在您的工程中插入所有打字符文件, 请运行 `yarn lint`。 。 。 .

要自动修正您工程中嵌入错误, 请运行 `yarn lint:fix` 或者说 `yarn lint --fix`。 。 。 .

## 常见问题

### @brightlayer-ui/eslint-config 是什么？

Blightlayer UI 的 ESLint 配置文件

### 如何安装 @brightlayer-ui/eslint-config？

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

### @brightlayer-ui/eslint-config 支持 TypeScript 吗？

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

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

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

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

@brightlayer-ui/eslint-config 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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