# @formspec/config 中文文档

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

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

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

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

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

- 包体积（解压后）：476 kB，31 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-04-16T05:47:13.702Z
- 最新版本发布：2026-08-20T20:17:35.754Z
- 近 30 天下载量：4190（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

FormSpec - 扩展、限制、元数据、管道设置和DSL政策验证的统一配置

## 安装

```sh
npm install @formspec/config
```

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

## README

# @ formspec/ 配置

FormSpec项目的统一配置和DSL政策验证.

需要项目级别规则时使用此软件包, 例如 :

-   拒绝某些字段类型
-   限制布局嵌入
-   限制选定的字段选项
-   注册扩展名和全项目表格Spec 设置

## 安装

```bash
pnpm add @formspec/config
```

## `formspec.config.ts`

```ts
import { defineFormSpecConfig } from "@formspec/config";

export default defineFormSpecConfig({
  constraints: {
    fieldTypes: {
      dynamicEnum: "warn",
      dynamicSchema: "error",
    },
    layout: {
      conditionals: "off",
      maxNestingDepth: 2,
    },
    fieldOptions: {
      placeholder: "off",
      minItems: "warn",
    },
  },
});
```

## 程序化使用

```ts
import { loadFormSpecConfig, validateFormSpecElements } from "@formspec/config";
import { field, formspec } from "@formspec/dsl";

const result = await loadFormSpecConfig();
const constraints = result.found ? result.config.constraints : undefined;

const form = formspec(field.text("name"), field.dynamicEnum("country", "countries"));
const validation = validateFormSpecElements(form.elements, { constraints });
```

## 静态非节点导入

主要内容 `@formspec/config` 输入点不会静态导入节点文件系统模块, 因此面向浏览器的工具可以不拉入便导入策略帮助器 `node:fs` 或者说 `node:path`。需要配置发现的主机可以通过 `FileSystem` 路径和文件操作的适配器 :

```ts
import { loadFormSpecConfig, type FileSystem } from "@formspec/config";

const fileSystem: FileSystem = {
  exists: async (path) => existsInHost(path),
  readFile: async (path) => readFromHost(path),
  resolve: (...segments) => resolveInHost(...segments),
  dirname: (path) => dirnameInHost(path),
};

await loadFormSpecConfig({ searchFrom: ".", fileSystem });
```

适配器包括发现,存在检查,工作空间-根部检查,以及文件读取. 评价 TypeScript 配置模块仍然使用当前节点兼容 `jiti` 加载器;非节点模块评价员是今后的工作.

## 主要出口

-   `loadFormSpecConfig`
-   `defineFormSpecConfig`
-   `defineDSLPolicy`
-   `mergeWithDefaults`
-   `validateFormSpecElements`
-   `validateFormSpec`

## 许可证

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

## 常见问题

### @formspec/config 是什么？

FormSpec - 扩展、限制、元数据、管道设置和DSL政策验证的统一配置

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

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

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

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

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

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

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

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

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

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

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

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