Add JSON Schema support via schemars #128
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The final step of actually emitting the JSON schema still needs to be plumbed in. But the types involved can all emit schema information now.
bradlarsen
added
documentation
Also, hide the `shell-completions` command from help output. That command is really only used for release packaging; it's not something that would be run by a regular user of Nosey Parker.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a JSON Schema for Nosey Parker's JSON report format. This is implemented using the
schemarscrate to mostly automatically generate the schema from Rust data types.The schema generation mechanism is accessed using a new
json-schematop-level command, which is hidden from help. This prints the generated schema to stdout.The generated schema is included in the release builds.
Fixes #72.