Usability issues #30
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
good first issue
Good for newcomers
Downloaded this for the first time today and gave it a try. Love the concept and am already getting good value out of the stateful schema checks! Creating this issue to discuss some usability issues I encountered while using the tool for the first time.
file://
values for parameters only work with absolute paths. It would be nice if they also worked with relative paths.--format
should be the default behavior (human-readable) and rather than printing the raw python objects, which are difficult to read or pass to other tools, you should add a--json
flag and output the result as JSON for machine-readable output.jq
to pretty-print it. Should play around with the experience here. Some ideas are to pretty-print it to stderr so it's easy to separate from the other output or have the diff output off by default and add a--verbose
flag to include it (although then discoverability becomes an issue) or you can keep the compact JSON output and add a--pretty
flag to pretty-print the JSON.[SKIPPED]:
and no rules under[PASSED]
,[WARNING]
or[FAILED]
. This was confusing to me because I thought it meant the checks were not being performed because they were disabled or something, but what it really meant was since the deep diff was an empty object, none of the rules applied at all. My intuitive expectation was to see all checks under the[PASSED]
section since none of the stateful checks were violated. I get the desire to distinguish between the check actually ran and passed vs the check was not applicable, so maybe it's just a wording thing and you should replace the word "skipped" with "not applicable" maybe?Hope this feedback is helpful! Thanks again for this great tool!
The text was updated successfully, but these errors were encountered: