Re-order return value properties #801
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
ehmicky
commented
Feb 7, 2024
|
|
||
| if (all !== undefined) { | ||
| error.all = all; | ||
| } | ||
|
|
||
| error.stdio = stdio; | ||
|
|
There was a problem hiding this comment.
stdout/stderr/all/stdio are potentially big, so they are put last.
ehmicky
commented
Feb 7, 2024
| @@ -84,27 +84,29 @@ export const makeError = ({ | |||
| error.shortMessage = shortMessage; | |||
There was a problem hiding this comment.
error.*message is the most important, so should come first.
ehmicky
commented
Feb 7, 2024
| @@ -84,27 +84,29 @@ export const makeError = ({ | |||
| error.shortMessage = shortMessage; | |||
| error.command = command; | |||
| error.escapedCommand = escapedCommand; | |||
| error.cwd = cwd; | |||
There was a problem hiding this comment.
The command's request properties (command and cwd) come before the result ones (exitCode, etc.).
ehmicky
commented
Feb 7, 2024
| error.failed = true; | ||
| error.timedOut = Boolean(timedOut); | ||
| error.isCanceled = isCanceled; | ||
| error.isTerminated = signal !== undefined; | ||
| error.exitCode = exitCode; | ||
| error.signal = signal; | ||
| error.signalDescription = signalDescription; |
There was a problem hiding this comment.
Boolean result properties like timedOut come before more descriptive ones like exitCode and signal.
ehmicky
commented
Feb 7, 2024
|
|
||
| This is `undefined` when the process could not be spawned or was terminated by a [signal](#signal-1). | ||
| The `cwd` of the command if provided in the [command options](#cwd-1). Otherwise it is `process.cwd()`. |
There was a problem hiding this comment.
Re-orders the documentation too.
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 re-orders the properties of the Execa return value (on success or error). When the result is printed, that order is preserved, so this PR makes them follow a logical order.
Also, this adds a test to make sure we are not missing properties, which avoids bugs like #798.