# @formancy/spec 中文文档

规范地址：https://npmcn.com/package/%40formancy/spec/

版本：0\.13\.0
npm 元数据更新时间：2026-11-05T19:44:41.923Z
中文译文更新时间：2026-11-15T08:24:50.829Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40formancy/spec
原文对照：https://npmcn.com/package/%40formancy/spec/?lang=original
项目主页：https://github.com/sharkysan/formancy.ai
源码仓库：https://github.com/sharkysan/formancy.ai

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

- 包体积（解压后）：1.3 MB，17 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-09-20T19:24:52.292Z
- 最新版本发布：2026-11-05T19:44:41.532Z
- 近 30 天下载量：6936（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

造型形式为: schema 规格:类型,JSON Schema,犬科序列化和diffing.

## 安装

```sh
npm install @formancy/spec
```

也可以使用：`pnpm add @formancy/spec`、`yarn add @formancy/spec`、`bun add @formancy/spec`

## README

# @ 格式/ spec

成型形式为: 它的TypeScript类型, 它的JSON Schema, 一个验证器, 单体内容散列,和 diff 分类 改变的成本 数据已经收集.

这个软件包对于任何框架,节点或DOM都没有依赖性. 这个 相同的构建在浏览器,服务器和构建脚本中运行.

## 两项负载决定

**克能克散列是该版本的身份.** `schemaHash(schema)` 是一个 SHA -256通过犬科序列化, 所以两个文件只有钥匙不同 命令是同一个版本. `canonicalize` 拒绝 `undefined`, (中文(简体) ), `NaN` 财务报告和审定财务报表 `Infinity` 而不是让 `JSON.stringify` 放弃或胁迫他们——放弃 字段会让两个不同的计划 共享一个散列, 它会悄悄地打破 每一份呈文都依赖篡改证据.

**`diffSchemas` 按成本分类,在数据路径之上.** 每一个变化都是 `compatible`, (中文(简体) ), `lossy` 或者说 `breaking`,行走则遵循数据路径而不是 字段列表:在组合或中继器模板内看到更改,移动 字段在向导页面之间是完全没有变化的,将一个移动到一个组就是一个 删除外加添加——因为提交形状确实有变化。 键 未宣布的更改 `renamedFrom` 报告为去除后加 而非猜测; 猜测错误 悄悄地移动一个字段的答案 另一个领域.

## 使用

```ts
import { schemaHash, diffSchemas, modelDataPaths } from '@formancy/spec'
import { validateSchema } from '@formancy/spec/validate'

const result = validateSchema(document)
if (!result.valid) {
  for (const error of result.errors) console.log(error.path, error.message)
}

for (const change of diffSchemas(published, draft)) {
  console.log(change.severity, change.kind, change.path)
}
```

`validateSchema` 生活在自己的后路 因为它拉入了ajv 渲染器只为类型和散列导入此包 。 验证器本身 实值 **编写时预编译** ——在运行时间进行编译将到达 `new Function`,它扔在严格的不..`unsafe-eval` 政策 由浏览器嵌入的构建器运行在下.

文档 : `apps/docs` (概念-计划).

## 常见问题

### @formancy/spec 是什么？

造型形式为: schema 规格:类型,JSON Schema,犬科序列化和diffing\.

### 如何安装 @formancy/spec？

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

### @formancy/spec 支持 TypeScript 吗？

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

### @formancy/spec 支持 ESM 还是 CommonJS？

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

### @formancy/spec 可以商用吗？

@formancy/spec 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @formancy/spec 的下载量有多少？

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

### @formancy/spec 还在维护吗？

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