Skip to content

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

Notifications You must be signed in to change notification settings

mheap/json-schema-spell-checker

Repository files navigation

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

npm install -g json-schema-spell-checker

Usage

Check against specific field names at any depth:

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

Alternatively, you can specify a JSONPath expression yourself

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

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

Pre-commit hook

You can use this tool as a pre-commit hook by adding the following to your .pre-commit-config.yaml:

repos:
  - repo: https://github.com/mheap/json-schema-spell-checker
    rev: <version> # Use the ref you want to point at
    hooks:
      - id: json-schema-spell-checker
        files: <schema>\.json$

About

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

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published