# @changesets/format 中文文档

规范地址：https://npmcn.com/package/%40changesets/format/

版本：0\.1\.3
npm 元数据更新时间：2026-10-23T07:35:02.978Z
中文译文更新时间：2026-11-09T10:17:04.582Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40changesets/format
原文对照：https://npmcn.com/package/%40changesets/format/?lang=original
源码仓库：https://github.com/changesets/format

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

- 包体积（解压后）：11.4 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：^22\.11 \|\| ^24 \|\| \>=26
- 运行依赖：2 个
- 首次发布：2026-05-12T07:18:34.884Z
- 最新版本发布：2026-10-23T07:35:02.572Z
- 近 30 天下载量：8138786（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

检测和格式文件

## 安装

```sh
npm install @changesets/format
```

也可以使用：`pnpm add @changesets/format`、`yarn add @changesets/format`、`bun add @changesets/format`

## README

# @ changersets/format (中文(简体) )

检测已安装的代码格式化器和与之相通的格式文件 .

## 使用量

### `detect()`

检测项目中使用的首选地物 .

```ts
import { detect } from "@changesets/format";

const result = await detect();
// => "prettier"
```

选项可以传递到第一个参数:

-   `cwd`: 当前的工作目录将开始查找格式。 默认为 `process.cwd()`。 。 。 .
-   `stopDir`:停止翻转目录的路径.
-   `order`: 格式化器要检查的顺序。 默认为 `["dprint", "deno", "oxfmt", "biome", "prettier"]` (从) `defaultDetectOrder`(中文(简体) )

### `format()`

以指定的或自动检测的格式格式化给定的图案。 它回来了 `true` 如果找到一个格式, 格式化进程也会通过( 即使图案与任何文件不匹配), 否则返回 `false`。 。 。 .

```ts
import { format } from "@changesets/format";

await format(["src/index.ts"]);
```

选项可以传递到第二个参数:

-   `formatter`: 用于格式化的前题。 未指定,将使用自动检测 `detect`启用 `detect` 如果您想要对检测过程拥有更多的控制,则直接进行.
-   `cwd`: 当前的工作目录将开始查找格式和软件包管理器, 并执行格式命令 。 默认为 `process.cwd()`。 。 。 .
-   `stopDir`:停止翻转目录的路径.
-   `packageManager`: 用于执行 formatter 命令的软件包管理器 。 如果没有指定,它将使用 `package-manager-detector` 以检测软件包管理器.

## 谢谢

这个软件包的核心构想基于 [格式化](https://github.com/JoshuaKGoldberg/formatly),但已执行,以适应切换器的需求。 然而,它仍然具有通类性,足以被除"变相"之外的其他项目所使用.

## 许可证

麻省理工学院

## 常见问题

### @changesets/format 是什么？

检测和格式文件

### 如何安装 @changesets/format？

在项目目录运行 npm install @changesets/format，或使用 pnpm add / yarn add / bun add。

### @changesets/format 支持 TypeScript 吗？

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

### @changesets/format 支持 ESM 还是 CommonJS？

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

### @changesets/format 需要什么版本的 Node\.js？

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

### @changesets/format 可以商用吗？

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

### @changesets/format 的下载量有多少？

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

### @changesets/format 还在维护吗？

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