feat: output json formatted errors on stdout #5716
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
lukekarrys
force-pushed
the
lk/json-error-stdout
branch
from
0db7dcc
to
cf39551
Compare
This also adds a new output method `outputBuffer()` which will buffer all output until it is flushed in the exit handler. This allows the exit handler to catch any errors and append them to the output when in json mode. This was necessary to not introduce a regression in the case of #2150. BREAKING CHANGE: `npm` now outputs some json errors on stdout. Previously `npm` would output all json formatted errors on stderr, making it difficult to parse as the stderr stream usually has logs already written to it. In the future, `npm` will differentiate between errors and crashes. Errors, such as `E404` and `ERESOLVE`, will be handled and will continue to be output on stdout. In the case of a crash, `npm` will log the error as usual but will not attempt to display it as json, even in `--json` mode. Moving a case from the category of an error to a crash will not be considered a breaking change. For more information see npm/rfcs#482. Closes #2740 Closes npm/statusboard#589
lukekarrys
force-pushed
the
lk/json-error-stdout
branch
from
cf39551
to
6c870b4
Compare
wraithgar
reviewed
Oct 19, 2022
| @@ -177,7 +177,7 @@ class LS extends ArboristWorkspaceCmd { | |||
| const [rootError] = tree.errors.filter(e => | |||
| e.code === 'EJSONPARSE' && e.path === resolve(path, 'package.json')) | |||
|
|
|||
| this.npm.output( | |||
There was a problem hiding this comment.
why are we only calling this in one command for now?
wraithgar
approved these changes
Oct 19, 2022
lukekarrys
added a commit
that referenced
this pull request
Oct 19, 2022
This also adds a new output method `outputBuffer()` which will buffer all output until it is flushed in the exit handler. This allows the exit handler to catch any errors and append them to the output when in json mode. This was necessary to not introduce a regression in the case of #2150. BREAKING CHANGE: `npm` now outputs some json errors on stdout. Previously `npm` would output all json formatted errors on stderr, making it difficult to parse as the stderr stream usually has logs already written to it. In the future, `npm` will differentiate between errors and crashes. Errors, such as `E404` and `ERESOLVE`, will be handled and will continue to be output on stdout. In the case of a crash, `npm` will log the error as usual but will not attempt to display it as json, even in `--json` mode. Moving a case from the category of an error to a crash will not be considered a breaking change. For more information see npm/rfcs#482. Closes #2740 Closes npm/statusboard#589
This was referenced Nov 5, 2022
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 also adds a new output method
outputBuffer()which will bufferall output until it is flushed in the exit handler. This allows the exit
handler to catch any errors and append them to the output when in json
mode. This was necessary to not introduce a regression in the case of
#2150.
BREAKING CHANGE:
npmnow outputs some json errors on stdout.Previously
npmwould output all json formatted errors on stderr,making it difficult to parse as the stderr stream usually has logs
already written to it. In the future,
npmwill differentiate betweenerrors and crashes. Errors, such as
E404andERESOLVE, will behandled and will continue to be output on stdout. In the case of a
crash,
npmwill log the error as usual but will not attempt to displayit as json, even in
--jsonmode. Moving a case from the category of anerror to a crash will not be considered a breaking change. For more
information see npm/rfcs#482.
Closes #2740
Closes npm/statusboard#589