# @acid-cat/catalog 中文文档

规范地址：https://npmcn.com/package/%40acid-cat/catalog/

版本：0\.9\.0
npm 元数据更新时间：2026-10-28T21:05:11.346Z
中文译文更新时间：2026-11-08T15:01:19.650Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40acid-cat/catalog
原文对照：https://npmcn.com/package/%40acid-cat/catalog/?lang=original
项目主页：https://github.com/Hebilicious/acidcat/tree/main/packages/catalog/typescript#readme
源码仓库：https://github.com/Hebilicious/acidcat

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

- 包体积（解压后）：15.7 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：0 个
- 首次发布：2026-10-14T08:52:16.573Z
- 最新版本发布：2026-10-28T21:05:10.950Z
- 近 30 天下载量：1770（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

在 TypeScript 中写出 AcidCat 目录,并以犬形形式制作.

## 安装

```sh
npm install @acid-cat/catalog
```

也可以使用：`pnpm add @acid-cat/catalog`、`yarn add @acid-cat/catalog`、`bun add @acid-cat/catalog`

## README

# @ acid- cat/ catalog

TypeScript 的 AcidCat 目录库 。 npm 软件包 : `@acid-cat/catalog`。 。 。 .

在 TypeScript 中写出目录,并以条形写出. 图书馆没有附属性. 在构建时使用它来写入 `acidcat.catalog.json`。 。 。 .

```sh
pnpm add -D @acid-cat/catalog
```

```ts
import { Catalog } from "@acid-cat/catalog";

const catalog = new Catalog({ title: "Neighbourhood lending library" });
catalog.target("desk", { bindings: ["cli"] });
const notFound = catalog.type("NotFound", { type: "object" });
catalog.capability("library.loan.return", {
  description: "Take a book back from a member.",
  audience: ["desk"],
  input: { type: "object", required: ["loan"], properties: { loan: { type: "string" } } },
  failures: { NotFound: notFound },
});

await writeFile("acidcat.catalog.json", catalog.render());
```

`validate()` 列出规则目录分解,以及 `render()` 拒绝让一个打破任何。 完整的例子是 [`examples/library.ts`](https://npmcn.com/package/%40acid-cat/catalog/examples/library.ts)借书室.

测试将库的输出与此目录中的文件进行比较: 出借- 图书馆目录 [`examples/library.acidcat.json`](https://npmcn.com/package/%40acid-cat/catalog/examples/library.acidcat.json),以及语言写法不同的价值观目录, [`test/fixtures/edge.acidcat.json`](https://npmcn.com/package/%40acid-cat/catalog/test/fixtures/edge.acidcat.json)。测试也比较 [`examples/aircon.ts`](https://npmcn.com/package/%40acid-cat/catalog/examples/aircon.ts) 与寄存器的空调目录。 每个已承诺的目录文件都在 [犬类形态](https://npmcn.com/spec/catalog.md#canonical-form)词根 `moon run check` 检查这个。 因此,所有目录库都同意犬科的形式,它们并不共享测试文件. 测试 `moon run catalog-typescript:test`。 。 。 .

## 常见问题

### @acid-cat/catalog 是什么？

在 TypeScript 中写出 AcidCat 目录,并以犬形形式制作\.

### 如何安装 @acid-cat/catalog？

在项目目录运行 npm install @acid-cat/catalog，或使用 pnpm add / yarn add / bun add。

### @acid-cat/catalog 支持 TypeScript 吗？

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

### @acid-cat/catalog 支持 ESM 还是 CommonJS？

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

### @acid-cat/catalog 需要什么版本的 Node\.js？

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

### @acid-cat/catalog 可以商用吗？

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

### @acid-cat/catalog 的下载量有多少？

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

### @acid-cat/catalog 还在维护吗？

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