# @electron-toolkit/eslint-config-prettier 中文文档

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

版本：3\.0\.1
npm 元数据更新时间：2026-09-27T11:19:10.630Z
中文译文更新时间：2026-11-13T11:58:16.066Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：4 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：eslint \>= 9\.0\.0，prettier \>= 3\.0\.0
- 首次发布：2023-07-23T15:17:59.083Z
- 最新版本发布：2026-09-27T11:19:10.455Z
- 近 30 天下载量：316904（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 1 个）

## 中文简介

ESLint配置了Electron项目Pretier支持.

## 安装

```sh
npm install @electron-toolkit/eslint-config-prettier
```

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

## README

# @electron-toolkit/eslint-config- prettier (英语)

> ESLint配置了Electron项目Pretier支持.

要求数 `eslint >= 9.0.0` 财务报告和审定财务报表 `prettier >= 3.0.0`。 。 。 .

此配置是专门为用于 `@quick-start/create-electron` 设置.

默认配置基于推荐的配置 [埃斯林特- 插孔- prettier](https://github.com/prettier/eslint-plugin-prettier/#recommended-configuration),这也取决于 [埃斯林特- 配置- prettier](https://github.com/prettier/eslint-config-prettier)4\. 请参考它们的相应文件,了解更多执行细节.

## 安装

```sh
npm add -D @electron-toolkit/eslint-config-prettier
```

## 使用量

导入 `@electron-toolkit/eslint-config-prettier` 并添加为 **最后一个** 在您的配置阵列中的项目 `eslint.config.js` 文件,以便它有机会覆盖其他配置.

```js
import configPrettier from '@electron-toolkit/eslint-config-prettier'

export default [
  // Any other config imports go at the top
  configPrettier
]
```

这种配置是使用Prettier的ESLint最直通的方式.

它禁用所有不必要的或可能与Pretier相冲突的规则. 还能使 `eslint-plugin-prettier` 插件,它将Pretier运行为ESLint规则,并将差异报告为单个的ESLint问题.

默认情况下,所有格式问题均报告为 `warnings`,并在 `eslint --fix`。 。 。 .

## 常见问题

### @electron-toolkit/eslint-config-prettier 是什么？

ESLint配置了Electron项目Pretier支持\.

### 如何安装 @electron-toolkit/eslint-config-prettier？

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

### @electron-toolkit/eslint-config-prettier 支持 TypeScript 吗？

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

### @electron-toolkit/eslint-config-prettier 支持 ESM 还是 CommonJS？

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

### @electron-toolkit/eslint-config-prettier 可以商用吗？

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

### @electron-toolkit/eslint-config-prettier 的下载量有多少？

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

### @electron-toolkit/eslint-config-prettier 还在维护吗？

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

