# @checkdigit/prettier-config 中文文档

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

版本：8\.3\.0
npm 元数据更新时间：2026-10-05T17:51:17.084Z
中文译文更新时间：2026-11-09T11:45:06.144Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：4.8 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=24\.20\.0
- 运行依赖：0 个
- peer 依赖：prettier 3\.9\.9，@prettier/plugin-oxc 0\.2\.3，@prettier/plugin-xml 3\.4\.2，prettier-plugin-svelte 4\.1\.1，prettier-plugin-packagejson 3\.0\.2，prettier-plugin-tailwindcss 0\.8\.1
- 首次发布：2019-09-06T18:25:33.995Z
- 最新版本发布：2026-09-23T21:27:53.338Z
- 近 30 天下载量：8661（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：77（近 12 个月 18 个）

## 中文简介

检查 Digit 代码格式配置

## 安装

```sh
npm install @checkdigit/prettier-config
```

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

## README

[![MIT License](https://img.shields.io/github/license/checkdigit/prettier-config)](https://github.com/checkdigit/prettier-config/blob/master/LICENSE.txt)

# 更漂亮的配置

检查数字 [高级](https://prettier.io/) 配置

版权所有 2021-2026 [检查 Digit, LLC](https://checkdigit.com/)

## 使用量

### 安装

```bash
$ npm add -D @checkdigit/prettier-config
```

重要说明来自 [高级安装文档](https://prettier.io/docs/en/install.html)数字 :

> 在您的工程中安装精确的 Pretier 本地版本 。 这保证了项目中的每个人 得到Pretier的准确版本。 即使是Pretier的补丁发布 也会导致稍有不同 格式化,所以你不希望不同的团队成员使用不同的版本和格式化彼此 前后变化.

为方便起见,只要安装 `@checkdigit/prettier-config` 将锁定到特定版本 联 合 国 `prettier` 将自动通过它的 `peerDependencies`。 。 。 . 不特别安装 `prettier` 本身是一个依赖.

### 编辑 `package.json`

```jsonc
{
  // ...
  "prettier": "@checkdigit/prettier-config"
  // ...
  scripts: {
    // ...
    "prettier": "prettier . --check",
    "prettier:fix": "prettier . --write",
    // ...
    "test": "... && npm run prettier"
    // ...
  }
}
```

除了进行测试和起伏外,还应使用更漂亮的设备 `npm test` 以验证格式化.

如果有问题, `npm run prettier:fix` 将把整个工程重新格式化为必要的样式.

注:Pretier 3.0和较新的忽略文件 `.gitignore` 默认。 如果您需要额外的 Pretier 特性 除外情形,将其添加到 `.prettierignore` 文档.

### 添加 `.prettierignore` 文件( 可选)

如果您已经生成了 TypeScript 文件, 您可以通过创建一个 `.prettierignore` 类似文件 :

```
src/api/*/swagger.ts
```

### 网络结构

WebStorm 支持 Pretier, 在首选项内打开 : Languages and Frameworks QQ JavaScript QQ Pretier.

您可以使用 QQP 用 Pretier 格式化块 。 WebStorm 还应询问您是否想要在整个项目中应用 Pretier 代码样式规则 。 (说是)

## 格式化固定装置

[`test`](https://npmcn.com/package/%40checkdigit/prettier-config/test/README.md) 包含覆盖 TypeScript 和每个已配置插件的格式基线. `npm test` 检查它们; 在依赖或配置更改后运行 `npm run prettier:fix` 并审查固定diffs.

## 许可证

麻省理工学院

## 常见问题

### @checkdigit/prettier-config 是什么？

检查 Digit 代码格式配置

### 如何安装 @checkdigit/prettier-config？

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

### @checkdigit/prettier-config 支持 TypeScript 吗？

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

### @checkdigit/prettier-config 支持 ESM 还是 CommonJS？

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

### @checkdigit/prettier-config 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24\.20\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @checkdigit/prettier-config 可以商用吗？

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

### @checkdigit/prettier-config 的下载量有多少？

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

### @checkdigit/prettier-config 还在维护吗？

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