Repository navigation
feat: document and validate --json for scriptable commands - #32
Merged
Merged
Conversation
Add JSON Schema files for why, history, loads, runs, used, usage and pending, wire loads, runs and pending to opt-in --json output, and check every document in tests/test_json_schemas.sh.
This file contains hidden or 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
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 change makes machine-readable output for the Zig-only commands consistent and checkable.
The commands
why,history,usedandusagealready accepted--jsonwithschema_version1. This kit adds the same opt-in flag toloads,runsandpending, documents the shape of every JSON document in JSON Schema files underdocs/orgmode/reference/json/, and adds a reference page that lists those files. The shell script still refuses the Zig-only commands; only the Zig build implements--json.tests/test_json_schemas.shruns each command on fixtures and validates stdout with thejsonschemaPython package against the matching schema. The Zig CI job installs that dependency and runs the suite throughzig build test. The shell and Zig help text stay byte-for-byte compatible for shared commands.Local CI covered shellcheck, the site-name grep,
zig fmt --check,zig build test, a release build, the shell regression suite, andpixi run -e docs docbld.