validator command can now output JSON to stdout, with extras optionally included#537
Merged
validator command can now output JSON to stdout, with extras optionally included#537
Conversation
Generated Code Check ✅All generated code is up to date. |
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds JSON output functionality to the validator command, allowing validation results to be written to stdout in JSON format with log suppression, making it easier to programmatically consume the output. The changes also expose options to include additional data in the JSON output such as GTFS entities, route geometries, and service levels.
Key Changes:
- Added
--output-format jsonflag to output JSON to stdout while suppressing log messages - Added three new include flags (
--include-entities,--include-route-geometries,--include-service-levels) to optionally include extra data in JSON output - Renamed the output flag from
-oto--output/-owith improved help text
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 PR enhances the validator command with JSON output capabilities and additional data inclusion options.
New Features
-o -to write JSON validation results directly to stdout, which automatically enables quiet mode-q/--quietflag to suppress log output, useful for scripting and CI pipelines--include-entities- Include GTFS entities in JSON output--include-route-geometries- Include route geometries in JSON output--include-service-levels- Include service levels in JSON outputChanges
--oto-o/--outfor consistency with CLI conventionsExample Usage
Motivation
These changes make it easier to programmatically consume validation results by: