# @formspec/core 中文文档

规范地址：https://npmcn.com/package/%40formspec/core/

版本：0\.1\.0-alpha\.70
npm 元数据更新时间：2026-08-20T20:17:36.345Z
中文译文更新时间：2026-11-15T09:15:32.310Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：702 kB，51 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-01-28T19:20:43.431Z
- 最新版本发布：2026-08-20T20:17:36.000Z
- 近 30 天下载量：350941（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 29 个）

## 中文简介

形态学的核心公用事业

## 安装

```sh
npm install @formspec/core
```

也可以使用：`pnpm add @formspec/core`、`yarn add @formspec/core`、`bun add @formspec/core`

## README

# @formspec/ core (帮助)

共享类型,犬形IR节点,以及FormSpec的扩展注册API.

## 安装

```bash
pnpm add @formspec/core
```

大部分应用代码应该更喜欢 `formspec` 除非您正在构建工具、扩展或低级集成.

## 主要责任

-   窗体元素和状态类型
-   建造管道所用的罐式IR型
-   约束定义元数据
-   为自定义类型、限制和说明提供扩展注册帮助
-   共用类型警卫

## 示例

```ts
import type { FormElement, FormIR } from "@formspec/core";
import {
  defineAnnotation,
  defineConstraint,
  defineCustomType,
  defineExtension,
} from "@formspec/core";

function isFieldElement(element: FormElement): boolean {
  return element._type === "field";
}

const decimalType = defineCustomType({
  typeName: "Decimal",
  tsTypeNames: ["Decimal"],
  toJsonSchema: (_payload, vendorPrefix) => ({
    type: "string",
    [`${vendorPrefix}-decimal`]: true,
  }),
});

const displayCurrency = defineAnnotation({
  annotationName: "DisplayCurrency",
  inheritFromBase: "local-wins",
});

const extension = defineExtension({
  extensionId: "x-example/decimal",
  types: [decimalType],
  constraints: [],
  annotations: [displayCurrency],
});
```

`inheritFromBase` 只有语义上的继承。 它允许一个类型级自定义注释流经类/界面遗产并被命名为类型别名的切入点,当所衍生的宣告在当地不声明相同的扩展注释,但不会将注释序列化为JSON Schema. 外观排放仍由可选的现有 `toJsonSchema` 钩子,所以地产级注释继承和元数据位继承仍然超出了范围.

## 密钥导出

### 窗体类型

-   `FormSpec`
-   `FormElement`
-   `AnyField`
-   `Group`
-   `Conditional`
-   `FieldState`
-   `FormState`

### IR 类型

-   `FormIR`
-   `FieldNode`
-   `LayoutNode`
-   `TypeNode`
-   `ConstraintNode`
-   `AnnotationNode`
-   `Provenance`

### 扩展 API

-   `defineExtension`
-   `defineConstraint`
-   `defineConstraintTag`
-   `defineAnnotation`
-   `defineCustomType`

### 公用事业

-   `normalizeConstraintTagName`
-   `createInitialFieldState`
-   `IR_VERSION`
-   字段和布局类型

## 条目点

| 入境点 | 目的 |
| --- | --- |
| `@formspec/core` | 稳定公共类型和扩展 API |
| `@formspec/core/internals` | 不稳定的低级别内部类型 |

## 许可证

这个包是FormSpec monorepo的一部分,根据MIT许可证发行. 见 [自由主义](https://npmcn.com/package/%40formspec/core/LICENSE) 详细情况.

## 常见问题

### @formspec/core 是什么？

形态学的核心公用事业

### 如何安装 @formspec/core？

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

### @formspec/core 支持 TypeScript 吗？

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

### @formspec/core 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @formspec/core 可以商用吗？

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

### @formspec/core 的下载量有多少？

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

### @formspec/core 还在维护吗？

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