# @diplodoc/ajv 中文文档

规范地址：https://npmcn.com/package/%40diplodoc/ajv/

版本：0\.14\.0
npm 元数据更新时间：2026-11-11T13:09:53.439Z
中文译文更新时间：2026-11-12T10:47:15.499Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：10.3 MB，28 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-06-19T09:43:55.202Z
- 最新版本发布：2026-11-11T13:09:53.061Z
- 近 30 天下载量：12435（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：31（近 12 个月 31 个）

## 中文简介

Diplodoc JSON 计划(托克、预设、前题、页面构建器等),编辑器丰富

## 安装

```sh
npm install @diplodoc/ajv
```

也可以使用：`pnpm add @diplodoc/ajv`、`yarn add @diplodoc/ajv`、`bun add @diplodoc/ajv`

## README

**英语** | [русский](https://github.com/diplodoc-platform/ajv/blob/master/README.ru.md)

* * *

[![NPM version](https://img.shields.io/npm/v/@diplodoc/ajv.svg?style=flat)](https://www.npmjs.org/package/@diplodoc/ajv) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_ajv&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_ajv) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_ajv&metric=coverage)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_ajv) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_ajv&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_ajv) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_ajv&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_ajv) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=diplodoc-platform_ajv&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=diplodoc-platform_ajv)

# @diplodoc/ jiv (英语)

用于 Diplodoc 配置文件的 JSON schemas (`toc.yaml`, (中文(简体) ), `presets.yaml`前题, 页面构建器,主题,方向,主页, `.yfm`, (中文(简体) ), `.yfmlint`) (中文(简体) ). 计划是 用编辑器元数据来丰富(`markdownDescription`, (中文(简体) ), `defaultSnippets`因此,他们 diplodoc VS代码扩展等编辑器中的电源自动补全和内置文件.

## 安装

```sh
npm install @diplodoc/ajv
```

## 使用量

```ts
import {schemas, tocSchema, type SchemaName} from '@diplodoc/ajv';

// the toc.yaml schema
console.log(tocSchema.title);

// or look one up by name
const name: SchemaName = 'presets-schema';
const schema = schemas[name];
```

原始JSON文件也发布,可以直接导入:

```ts
import tocSchema from '@diplodoc/ajv/schemas/toc-schema.json';
```

## 如何维持计划

-   **真相来源:** `src/yaml/*.yaml` ——全方位,即时使用计划. **只编辑 YAML .**
-   **生成输出 :** `src/json/*.json` ——由建设剧本出自YAML. 这些是承诺和运送的.

构建脚本做一件事:解析YAML并写出JSON(格式化为Prettier). 无上相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相.

```sh
npm run build:schemas          # regenerate src/json from src/yaml
# or, the exported CLI:
npx diplodoc-ajv-build-schemas
```

你从来不用手来编辑JSON. 每一次拉动请求 [`sync-schemas`](https://npmcn.com/package/%40diplodoc/ajv/.github/workflows/sync-schemas.yml) 工作流程从 YAML并将结果交回PR分支,因此JSON总是与YAML匹配.

## 发展

```sh
npm install
npm run build      # build:schemas + bundle + d.ts
npm test
npm run typecheck
npm run lint
```

## 常见问题

### @diplodoc/ajv 是什么？

Diplodoc JSON 计划\(托克、预设、前题、页面构建器等\),编辑器丰富

### 如何安装 @diplodoc/ajv？

在项目目录运行 npm install @diplodoc/ajv，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 diplodoc-ajv-build-schemas，可以用 npx diplodoc-ajv-build-schemas 直接运行。

### @diplodoc/ajv 支持 TypeScript 吗？

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

### @diplodoc/ajv 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @diplodoc/ajv 可以商用吗？

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

### @diplodoc/ajv 的下载量有多少？

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

### @diplodoc/ajv 还在维护吗？

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