# @asterql/formatter 中文文档

规范地址：https://npmcn.com/package/%40asterql/formatter/

版本：0\.5\.0
npm 元数据更新时间：2026-07-08T20:31:14.242Z
中文译文更新时间：2026-11-07T00:44:43.425Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40asterql/formatter
原文对照：https://npmcn.com/package/%40asterql/formatter/?lang=original
项目主页：https://www.asterql.org/tooling
源码仓库：https://github.com/ricokahler/asterql

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

- 包体积（解压后）：42.1 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2026-06-11T01:35:28.960Z
- 最新版本发布：2026-07-08T20:31:14.014Z
- 近 30 天下载量：2513（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

AsterQL的定型物质和犬类AST序列器.

## 安装

```sh
npm install @asterql/formatter
```

也可以使用：`pnpm add @asterql/formatter`、`yarn add @asterql/formatter`、`bun add @asterql/formatter`

## README

# @ asterql/ formatter (中文(简体) )

```sh
npm install @asterql/formatter
```

AsterQL 的定型格式化和条形AST序列化.

```ts
import { canonicalize, format } from "@asterql/formatter";

format('*.posts[status="published"]|sort(-date)[:10] {id,title}');
// *.posts[status == "published"]
// | sort(-date)[:10] {id, title}

canonicalize('*.posts[status="published"]');
// Span-free JSON over the parsed AST.
```

## API 密码

```ts
format(queryOrAst, { printWidth?: number }): string
canonicalAst(queryOrAst): CanonicalAst
canonicalize(queryOrAst): string
serializeCanonicalAst(queryOrAst): string
```

格式化是解析后又具有一能性. 强化是故意的 与格式区分,因此未来视图散列不依赖于白空或 质地源文字.

## 常见问题

### @asterql/formatter 是什么？

AsterQL的定型物质和犬类AST序列器\.

### 如何安装 @asterql/formatter？

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

### @asterql/formatter 支持 TypeScript 吗？

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

### @asterql/formatter 支持 ESM 还是 CommonJS？

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

### @asterql/formatter 需要什么版本的 Node\.js？

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

### @asterql/formatter 可以商用吗？

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

### @asterql/formatter 的下载量有多少？

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

### @asterql/formatter 还在维护吗？

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