0.8.3 • Published 4 years ago
@rdmo-author/schema v0.8.3
RDMO JSON Schema
This project contains a JSON schema for maintaining RDMO catalogs. The schema itself can be found under https://rdmo-json.gitlab.io/schema/catalog.schema.json.
Quick start
If you want to write JSON documents conforming to my catalog schema, I recommend you the following setup for productive writing:
- Install and open VSCode
- Create a new file and save it as JSON file, E.G.
catalog.json
- Insert the following snippet:
{
"$schema": "https://rdmo-json.gitlab.io/schema/catalog.schema.json",
}
If you continue typing after the $schema line, VSCode will provide validation, formatting, navigation, and autocompletion (see JSON editing in Visual Studio Code for more instructions).
If you are new to JSON, you can read a short introduction to JSON.
Install
npm i @rdmo-author/schema
Usage
The module has two exports:
schema
: The JSON schema itselfvalidate
: A validation function compiled by Ajv