Improve CLI error messages #3259
Merged
Conversation
This file contains 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
| @@ -62,6 +64,16 @@ export function registerCommandWithErrorHandling( | |||
| } else { | |||
| void showAndLogWarningMessage(logger, errorMessage.fullMessage); | |||
| } | |||
| } else if (e instanceof CliError) { | |||
| const fullMessage = `${e.commandDescription} failed with args:${EOL}${ | |||
There was a problem hiding this comment.
If I'm not mistaken, this message will come out as:
SomeCommand failed with args:
stderr stderr stderr stderr stderr stderr stderr stderr
stderr stderr stderr stderr stderr stderr stderr stderr
stderr stderr stderr stderr stderr stderr stderr stderr
stderr stderr stderr stderr stderr stderr stderr stderr
stderr stderr stderr stderr stderr stderr stderr stderr
stderr stderr stderr stderr stderr stderr stderr stderr
stderr stderr stderr stderr stderr stderr stderr stderr
stderr stderr stderr stderr stderr stderr stderr stderr
arg1 arg2 arg3
Should the args come before the stderr?
There was a problem hiding this comment.
Yes, you're right. I've updated this to be correct.
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 improves the CLI error messages by trying to parse the stderr if it matches a known exit code. This doesn't handle all cases, but it handles the most common cases. In case another error is returned, it will now simply print the stderr itself, rather than starting with
${description} failed with ${args}:. This can still be found in the extension logs, and is already printed when starting execution of the command in the extension logs as well.Checklist
ready-for-doc-reviewlabel there.