Improve error.message
#705
Merged
+52
−31
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
ehmicky
commented
Jan 20, 2024
| @@ -55,8 +64,8 @@ export const makeError = ({ | |||
| const isError = Object.prototype.toString.call(error) === '[object Error]'; | |||
| const shortMessage = isError ? `${execaMessage}\n${error.message}` : execaMessage; | |||
| const message = [shortMessage, stdio[2], stdio[1], ...stdio.slice(3)] | |||
| .map(messagePart => stripFinalNewline(serializeMessagePart(messagePart))) | |||
There was a problem hiding this comment.
We are joining each part with newlines. If a part ends with a newline, it just results in a single newline, not two.
ehmicky
commented
Jan 20, 2024
lib/error.js
Outdated
| .filter(Boolean) | ||
| .map(messagePart => serializeMessagePart(messagePart)) | ||
| .join('\n'); |
There was a problem hiding this comment.
I wonder whether we should separate the error message, stdout and stderr with an empty line or not?
Error: this failed
stdout
...
stderr
...
vs (current behavior)
Error: this failed
stdout
...
stderr
...
The first separates each part in a clearer way. But the second one is more compact. 🤔
Which one do you prefer?
ehmicky
force-pushed
the
error-message
branch
from
a3b92d2 to
2f68220
Compare
ehmicky
commented
Jan 20, 2024
| @@ -54,10 +63,11 @@ export const makeError = ({ | |||
| const execaMessage = `Command ${prefix}: ${command}`; | |||
| const isError = Object.prototype.toString.call(error) === '[object Error]'; | |||
| const shortMessage = isError ? `${execaMessage}\n${error.message}` : execaMessage; | |||
| const message = [shortMessage, stdio[2], stdio[1], ...stdio.slice(3)] | |||
| const messageStdio = all === undefined ? [stdio[2], stdio[1]] : [all]; | |||
There was a problem hiding this comment.
I have just added this line too: if all: true is used, the error message should show result.all instead, since it is intertwined, so it is more useful for debugging that splitting stdout and stderr.
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 slightly improves how
error.messageis built. It also improves the related tests.