Schema for the output of cawi2json.js

This is a JSON Schema as documented at https://json-schema.org/

• cawi2json.schema.json - Master schema file (edit this)
• cawi2json.schema.d.ts - Typescript version (created via json2ts)

Tools

Here are some useful tools for working with JSON schemas:

Online validation

Copy/paste both the schema and JSON file here:

https://www.jsonschemavalidator.net/

check-jsonschema

Command-line Python tool to validate a JSON file against the schema.

Install with pip install check-jsonschema

Run with check-jsonschema --schemafile cawi2json.schema.json myproject.json

json-schema-to-typescript (json2ts)

Nodejs tool to Convert a JSON Schema to a typescript declarations file

Install with npm install -g json-schema-to-typescript

Run with json2ts cawi2json.schema.json > cawi2json.schema.ts

NOTE: There is an older npm package called json2ts which has not been updated since 2016.

typedoc

Nodejs tool which can create HTML documentation from a Typescript declarations file:

Can be run directly with npx:

npx typedoc --sort source-order --commentStyle Block cawi2json.schema.ts

Will create HTML documentation in the docs/ subdirectory.