json-schema-spell-checker

This CLI allows you to provide a JSONPath expression and run mdspell against any matching lines.

> This tool is currently in alpha and has primarily been tested against OpenAPI files. PRs are welcome!

Installation

``bash
npm install -g json-schema-spell-checker
`

Usage

Check against specific field names at any depth:

`bash
json-schema-spell-checker -f 'description,title' /path/to/openapi.json
`

Alternatively, you can specify a JSONPath expression yourself

`bash
json-schema-spell-checker -j "$..[description,title]" /path/to/openapi.json
`

If you have words that aren't a spelling mistake but aren't in the dictionary, add them to a .spelling file (one word per line) in the current folder. Alternatively, you can provide a path with -s

`bash
json-schema-spell-checker -s /path/to/.spelling -f 'description,title' /path/to/openapi.json
``