json-schema-report

Visual tool to debug JSON schema validation errors field-by-field. I couldn't find any tool that did in-depth reporting on why a schema failed, so I made this one. The goal is to provide detailed, but readable analysis of schema validation errors, and to save time when debugging complex objects that don't validate.

JSON Schema versions are supported as per the underlying validator, jsonschema.

For example, showing valid (✓), invalid or missing (✕), and optional missing (?) properties with colored output to aid in reading:

  ✓ .name
  ✕ .age - instance must be greater than or equal to 0
  ✓ .address.line1
  ✓ .address.line2
  ✓ .address.city
  ✕ .address.state - required property is missing
  ✓ .address.country
  ? .catchphrase

2 errors found.

Where a schema uses allOf, anyOf, or oneOf, all the possible alternatives are shown, so you can see how much each one matched against the other candidates.

This can mean that data that does not match any of the candidates will show errors for all of them.

The example below shows where a oneOf matched only the second candidate.

  [oneOf 1/2]
  ? not matching
    ✓ .color
    ✓ .length
    ? .numMasts (omitted, not required)
    ✕ .numSails - required property is missing
  [oneOf 2/2]
  ✓ matching
    ✓ .color
    ✓ .length
    ? .numMasts (omitted, not required)
    ✓ .topSpeed

Options

In normal operation, a valid sub-schema will stop from showing considered alternatives. Use optional flags to adjust this behavior.

• -v - Show inferred types and partially or invalid sub-schemas/alternatives.
• -o - Hide optional properties that are not specified, but not invalid.

You can also export DEBUG=true to see a lot more debugging info.

Install

Install as a command line tool:

npm i -g json-schema-report

Then use the command:

jsr $schemaFilePath $dataFilePath

Run tests

npm test