Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Coverage report
Test suite run success3973 tests passing in 1524 suites. Report generated by 🧪jest coverage report action from 28a0c2a |
83a7548 to
7eff2a7
Compare
da7fb1e to
c953d80
Compare
c953d80 to
085ad44
Compare
|
We detected some changes at Caution DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release. |
There was a problem hiding this comment.
Pull request overview
Disables ANSI color output automatically when the CLI is invoked in JSON output mode, to prevent escape sequences from leaking into machine-readable JSON.
Changes:
- Treat
--json/-jas “no-color” signals during CLI bootstrap (setsFORCE_COLOR=0). - Update
--jsonflag descriptions across the CLI manifest/README and generated docs. - Add unit tests ensuring
--json/-jtrigger no-color mode.
Reviewed changes
Copilot reviewed 19 out of 20 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/cli/oclif.manifest.json | Updates --json flag descriptions to note color is disabled. |
| packages/cli/README.md | Updates command flag help text for --json to mention no-color behavior. |
| packages/cli-kit/src/public/node/cli.ts | Implements no-color forcing when --json / -j is present. |
| packages/cli-kit/src/public/node/cli.test.ts | Adds tests for --json / -j disabling color. |
| docs-shopify.dev/generated/generated_docs_data.json | Regenerates docs data reflecting updated --json description. |
| docs-shopify.dev/commands/interfaces/theme-push.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/theme-profile.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/theme-list.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/theme-info.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/organization-list.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/app-logs.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/app-info.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/app-function-run.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/app-function-info.interface.ts | Updates --json flag docstring to mention no-color behavior. |
| docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts | Adds generated interface docs for app config validate (no JSON flag listed). |
| docs-shopify.dev/commands/examples/app-config-validate.example.sh | Adds generated example snippet for app config validate. |
| docs-shopify.dev/commands/app-config-validate.doc.ts | Adds generated docs entity for app config validate. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
085ad44 to
28a0c2a
Compare

What
Disable color output automatically when a command runs in JSON mode.
This makes
--jsonand-jbehave like--no-colorat CLI bootstrap.Why
Machine-readable output should not depend on terminal styling.
Without this, ANSI escape sequences can leak into JSON string values unless callers also remember to pass
--no-color.How
Treat
--json,-j, andSHOPIFY_FLAG_JSONas no-color signals when the CLI sets up its environment.Testing
Run any command that supports
--jsonand confirm the JSON output does not contain ANSI escape sequences without also passing--no-color.On this stack,
shopify app config validate --json ...works once the next PR lands.