Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.3 KB

README.md

File metadata and controls

43 lines (29 loc) · 1.3 KB
Raw

JAAL specification

Directory contents

This directory contains the specification for JAAL as JSON schema.

  • bundle/jaal.json: The JSON Schema of JAAL in a single file (bundle)
  • schemas/ : The JSON schema of JAAL as separate modules
  • test/ : test data to validate against the schema
  • bundle.js: compiles *.json into bundle/jaal.json
  • *.sh: convenience scripts
  • README.md : this file

Software requirements

Installation

JAAL is specified with JSON schema. The schemas can be easily validated with the command-line tool ajv-cli.

  1. Install node.js.
  2. Install npm
  3. Install required node.js libraries from command line: npm install

The convenience scripts test.sh and build.sh require Bash, but one can easily do without it; see the contents of those files.

Running tests

To run the unit tests: node test.js

Bundling

./build.sh uses json-schema-ref-parser to combine individual JAAL JSON Schema files into a single file bundle/jaal-bundle.json.

Running tests

Do the bundling first. Then ./test.sh tests the JAAL JSON Schema in individual JSON files against JSON data in directory test/.