feat: Add global --json flag for commands #1070
Closed
Conversation
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
This change introduces a global `--json` flag to provide command output in a machine-readable JSON format.
Key changes:
- Added a global `--json` option in `src/commands/program.ts`.
- Removed local `--json` flags from `src/commands/show-file-status.ts` and `src/commands/tail-logs.ts`.
- Updated all commands to utilize the global `--json` flag and output appropriate JSON structures when the flag is present.
- For commands that output lists of items (e.g., `list-scripts`, `list-deployments`), the JSON output is an object containing an array of those items.
- For commands that perform actions (e.g., `create-script`, `deploy`), the JSON output includes relevant identifiers (like scriptId, deploymentId, version) or status messages.
- For commands that open URLs, the JSON output is `{"url": "openedUrl"}` and the URL is still opened in the browser.
- Informational text messages are suppressed when `--json` is active.
- Updated or created unit tests for all commands to ensure:
- Correct JSON output when the `--json` flag is used.
- Continued correct behavior for standard text output.
- Proper mocking of dependencies and use of the `runCommand` utility.
- Verification that text output is suppressed when JSON output is active.
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 introduces a global
--jsonflag to provide command output in a machine-readable JSON format.Key changes:
--jsonoption insrc/commands/program.ts.--jsonflags fromsrc/commands/show-file-status.tsandsrc/commands/tail-logs.ts.--jsonflag and output appropriate JSON structures when the flag is present.list-scripts,list-deployments), the JSON output is an object containing an array of those items.create-script,deploy), the JSON output includes relevant identifiers (like scriptId, deploymentId, version) or status messages.{"url": "openedUrl"}and the URL is still opened in the browser.--jsonis active.--jsonflag is used.runCommandutility.Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)
npm run testsucceeds.npm run lintsucceeds.