英语 | русский

@diplodoc/ jiv (英语)

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

安装

npm install @diplodoc/ajv

使用量

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文件也发布,可以直接导入:

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

如何维持计划

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

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

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

你从来不用手来编辑JSON. 每一次拉动请求 sync-schemas 工作流程从 YAML并将结果交回PR分支,因此JSON总是与YAML匹配.

发展

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