json-schema-org/json-schema-spec：The JSON Schema specification

项目介绍

json-schema-org/json-schema-spec 是一个托管在 GitHub 上的开源项目，主要使用 JavaScript 编写，采用 Other 许可证，目前获得 5.2k 个 Star、477 次 Fork。

仓库全名: json-schema-org/json-schema-spec

README 摘要

Welcome to JSON Schema JSON Schema is a vocabulary that allows you to validate, annotate, and manipulate JSON documents. This repository contains the sources for the work in progress of the next set of JSON Schema IETF Internet Draft (I-D) documents. For the latest released I-Ds, please see the Specification page on the website. Call for contributions and feedback Reviews, comments and suggestions are most welcome…

完整内容见 GitHub 原始 README 或本页。

常见问题

json-schema-spec 用什么语言开发？

主要使用 JavaScript 编写，采用 Other 许可证，目前有 5.2k 个 Star。

json-schema-spec 可以免费商用吗？

仓库标注的许可证为 Other，商用前请先阅读仓库 LICENSE 文件确认授权范围。

如何获取 json-schema-spec 的源码？

可以直接克隆仓库：git clone https://github.com/json-schema-org/json-schema-spec.git，默认分支为 main；安装与运行步骤见仓库 README。

json-schema-spec 最近还在维护吗？

仓库最近一次更新为 1 周前，当前有 73 个未关闭 Issue；Star 数为 5.2k，可作为社区活跃度的参考。

Welcome to JSON Schema

JSON Schema is a vocabulary that allows you to validate, annotate, and manipulate JSON documents.

This repository contains the sources for the work in progress of the next set of JSON Schema IETF Internet Draft (I-D) documents. For the latest released I-Ds, please see the Specification page on the website.

Call for contributions and feedback

Reviews, comments and suggestions are most welcome! Please read our guidelines for contributing.

Status

For the current status of issues and pull requests, please see the following labels

Labels are assigned based on Sensible GitHub Labels.

Authoring and Building

Specification

To build all the spec files to HTML from the Markdown sources, run npm run build -- specs. You can also build each individually with npm run build -- specs/filename.md (Example: npm run build -- specs/jsonschema-core.md). You can also use wildcards to build multiple specs at the same time: npm run build -- specs/jsonschema-*.md. The HTML files will be available in the web folder.

The spec is built using Remark, a markdown engine with good support for plugins and lots of existing plugins we can use. Remark also has a language server and a VSCode extension we can use to get linting and link checking while developing the spec.

Plugins

The following is a not-necessarily-complete list of configured plugins and the features they make available to you.

remark-lint – Enforce markdown style guide.
remark-validate-links – Check for broken links.
remark-gfm – Adds support for GitHub Flavored Markdown specific markdown features such as autolink literals, footnotes, strikethrough, tables, and tasklists.
remark-heading-id – Adds support for {#my-anchor} syntax to add an id to an element so it can be referenced using URI fragment syntax.
remark-headings – A collection of enhancements for headings.
- Adds hierarchical section numbers to headings.
  - Use the %appendix% prefix on headings that should be numbered as an appendix.
- Adds id anchors to headers that don’t have one
  - Example: #section-2-13
  - Example: #appendix-a
- Makes the heading a link utilizing its anchor
remark-reference-links – Adds new syntax for referencing a section of the spec using the section number as the link text.
- Example:
```
## Foo {#foo}
## Bar
This is covered in {{foo}} // --> Renders to "This is covered in [Section 2.3](#foo)"
```
- Link text will use “Section” or “Appendix” as needed
remark-table-of-contents – Adds a table of contents in a section with a header called “Table of Contents”.
remark-code-titles – Add titles to code blocks
- Example:
```
\`\`\`jsonschema "My Fun Title"
{ "type": "string" }
\`\`\`
```
- The languages jsonschema and json have special styling
- The title will be parsed as a JSON string, but you have to double escape escaped characters. So, to get My "quoted" title, you would need to write "My \\\\"quoted\\\\" title".
rehype-highlight – Syntax highlighting.
rehype-highlight-code-lines – Adds line numbers to code blocks. Supports ranges.
remark-flexible-containers – Add a callout box using the following syntax. Supported container types are warning, note, and experimental.
```
::: {type} {title}
{content}
:::
```

Internet-Drafts

To build components that are being maintained as IETF Internet-Drafts, run npm run build-ietf.

Descriptions of the xml2rfc, I-D documents, and RFC processes:

Test suites

Conformance tests for JSON Schema and its vocabularies may be found in their own repository.

Tests for the meta-schema are included here. Run npm test to run the meta-schema tests. To get a test coverage report, you can use npm run test:coverage. In addition to the CLI report, a detailed HTML report will be generated in the coverage directory and can be viewed using something like npx http-server coverage.