fix: match jest json output by making json reporter output ndjson-compatible#4824
Merged
sheremet-va merged 1 commit intovitest-dev:mainfrom Dec 31, 2023
Merged
Conversation
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.
Description
This change improves compatibility of the JSON reporter with Jest's
--jsonoutput by making thhe reporter's output parsable as NDJSON.Jest's JSON output is printed on a single line, which makes it consumable by NDJSON parsers when run in watch mode. Vitest's JSON output is pretty-printed; it can still be consumed when run in watch mode with e.g. stream-json, but that's more complex and less familiar for most. Given that this output is primarily intended for other programs, making it parsable as NDJSON makes intergrators' work easier. The occasional scenario of a human inspecting the output is covered by piping it into
jq.Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
pnpm-lock.yamlunless you introduce a new test example.Tests
pnpm test:ci.Documentation
pnpm run docscommand.Changesets
feat:,fix:,perf:,docs:, orchore:.