# @ggts-sh/spec 中文文档

规范地址：https://npmcn.com/package/%40ggts-sh/spec/

版本：0\.48\.3
npm 元数据更新时间：2026-11-05T23:47:18.306Z
中文译文更新时间：2026-11-16T07:32:46.591Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：7.1 MB，689 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：2 个
- 首次发布：2026-09-08T13:03:41.614Z
- 最新版本发布：2026-11-05T23:47:17.911Z
- 近 30 天下载量：9447（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

ggts plot spec: TypeBox schemas, PortableSpec 类型, 常态化 (), 有代理错误的验证(), 流畅的构建器, JSON Schema 文物.

## 安装

```sh
npm install @ggts-sh/spec
```

也可以使用：`pnpm add @ggts-sh/spec`、`yarn add @ggts-sh/spec`、`bun add @ggts-sh/spec`

## README

# @ggts-sh/ spec( 秒)

[![codecov](https://codecov.io/gh/ggts-sh/ggts/branch/main/graph/badge.svg?component=packages-spec)](https://app.codecov.io/gh/ggts-sh/ggts/tree/main/packages%2Fspec)

便携式Spec类型,出版的JSON Schema, `normalize()`双层 `validate()` 与代理错误合同 (单位:千美元)`{ code, path, message, allowed?, fix }`, (中文(简体) ), `lintSpec()`和流畅 `gg()` 编号 : `aes()` 建会者. 没有DOM,没有D3. 预1.0.

```sh
bun add @ggts-sh/spec     # or: npm install @ggts-sh/spec
```

单独安装以进行校验和编写,不设渲染器. [`@ggts-sh/svelte`](https://www.npmjs.com/package/@ggts-sh/svelte) 再导出此软件包.

## 快速实例

```ts
import { gg, aes, validate } from "@ggts-sh/spec";
// constrained decoding / tool schemas
import schema from "@ggts-sh/spec/schema/v0.json";

const spec = gg(
  [
    { year: "1835", value: 12 },
    { year: "2026", value: 31 },
  ],
  aes({ x: "year", y: "value" }),
)
  .geomLine()
  .spec();

const result = validate(spec, {
  profile: {
    fields: [
      { name: "year", type: "temporal" },
      { name: "value", type: "quantitative" },
    ],
  },
  lint: true,
});
if (!result.ok) {
  // Apply fix.example at path, then re-validate.
  // { code, path, message, allowed?, fix: { description, example } }
}
```

## 代理合同

-   `validate(spec)` -只有形状.
-   `validate(spec, { profile })` ——数据认识无航运行.
-   `validate(spec, { lint: true })` 关于有效但有疑问的规格的建议.
-   每一个错误都带有 `fix.example`应用到 `path` 并重新验证.
-   便携式Spec 仅为 JSON : 否 `Date`、召回或正则表达式. 构建器 `Date` 值到 ISO 字符串.
-   JSON Aes 用途 `{ field: "col" }` (JSON中的空字符串无效). 这个 建筑师和斯维尔特道具接受光弦短手.

## 渲染器

-   无头 SVG : [`@ggts-sh/core`](https://www.npmjs.com/package/@ggts-sh/core) (单位:千美元)`renderToSVGString`(中文(简体) )
-   CLI 环( 验证 + stderr 上的警告) : [`@ggts-sh/cli`](https://www.npmjs.com/package/@ggts-sh/cli) (单位:千美元)`ggts render`(中文(简体) )
-   斯维尔特5: [`@ggts-sh/svelte`](https://www.npmjs.com/package/@ggts-sh/svelte)

司马: [计划/v0.json](https://ggts.sh/schema/v0.json) \* 文件: [ggts.sh (英语)](https://ggts.sh/) • 恢复: [github.com/ggts-sh/ggts (英语)](https://github.com/ggts-sh/ggts)

[麻省理工学院](https://github.com/ggts-sh/ggts/blob/main/LICENSE) 利亚姆·奥德

## 常见问题

### @ggts-sh/spec 是什么？

ggts plot spec: TypeBox schemas, PortableSpec 类型, 常态化 \(\), 有代理错误的验证\(\), 流畅的构建器, JSON Schema 文物\.

### 如何安装 @ggts-sh/spec？

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

### @ggts-sh/spec 支持 TypeScript 吗？

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

### @ggts-sh/spec 支持 ESM 还是 CommonJS？

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

### @ggts-sh/spec 需要什么版本的 Node\.js？

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

### @ggts-sh/spec 可以商用吗？

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

### @ggts-sh/spec 的下载量有多少？

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

### @ggts-sh/spec 还在维护吗？

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

