mheap / json-schema-spell-checker

This CLI allows you to provide a JSONPath expression and run mdspell against any matching lines.
2 stars 1 forks source link

Commands dont work on windows #6

Open savage-alex opened 4 years ago

savage-alex commented 4 years ago

When trying the command line functions with windows I get errors image

These are resolved by removing the single quotes and the commands are:

Field mode: json-schema-spell-checker -f title,summary ./openapi.json

Json path mode: json-schema-spell-checker -j $..['description','title'] ./openapi.json

Also worth noting if you want to find specific sub elements such as names for tags (as spell checking all property names wouldnt be fun ;-) ) json-schema-spell-checker -j $..tags[*]['description','name'] ./openapi.json

bash: json-schema-spell-checker -a -n -j '$..tags[*]["description","name"]' ./openapi.yaml It would also be good to mention in the docs that yaml is supported from the file extension

Would you like PR for the docs changes?

mheap commented 4 years ago

Yes please!