[Playground CLI] Improve error reporting #2401
Merged
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
Improves Playground CLI error reporting in two ways: * Stop printing the stack trace if the `--debug` flag isn't set. The typical errors are similar to "unknown option --blueprin" and displaying the stack trace makes the user experience worse. * Rejects unrecognized options. Before this PR, a typo in one of the flags will go undetected until the user realizes the CLI doesn't do what they want it to. With this PR, the typo is immediately apparent as the process will short-circuit and report a failure. We still support both kebab-cased and camelCased CLI flags ## Testing instructions Confirm this command prints a short error message: ``` node --experimental-strip-types --experimental-transform-types --disable-warning=ExperimentalWarning --import ./packages/meta/src/node-es-module-loader/register.mts ./packages/playground/cli/src/cli.ts server --php=8.4 --blueprin=./file.json ``` Add `--debug` and confirm you can see the entire stacktrace
adamziel
added
[Type] Enhancement
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.
Improves Playground CLI error reporting in two ways:
--debugflag isn't set. The typical errors are similar to "unknown option --blueprin" and displaying the stack trace makes the user experience worse.Testing instructions
Confirm this command prints a short error message:
Add
--debugand confirm you can see the entire stacktrace