schema-watcher

schema-watcher (swatch)

A bare-bones command line utility that watches a JSON-schema file and a data file and validates the data against the schema in real time

Installation

npm i -g schema-watcher

or

yarn global add schema-watcher

Usage

> swatch [-h] -f FILE -s SCHEMA [-q QUERY] [-d]

• --help (-h): Show the help message

• --file (-f) FILE: Path to the data file (YAML or JSON)

• --schema (-s) SCHEMA: Path to a schema file (YAML or JSON)

• --query (-q) QUERY: JMESpath query to the schema if nested within a larger document. Particularly useful when validating against a nested portion of a larger schema.

  For example, if you have a file with multiple schemas like this

  schema-1:
   type: object
   properties: 
      something:
          $ref: '#/.schema-2'
       
  schema-2:
   type: object
   properties: 
      hello:
          type: string
          enum:
              - world
              - nurse
              - dolly
  

  you could validate a document against schema-2 by specifying --query schema-2

• -d: Dereference the Schema object (i.e. expand the '$ref' attributes). This may be required when the schema is nested within a larger document, but may increase memory usage and slow down validation. In the above example, when validing a docuemnt against schema-1 you may need to specify the -d flag to dereference the $ref: ... reference