feat(jest-core): Add newline after Json output

[jessevanassen]

Summary

This pull request adds newline characters at the end of Json objects produced with jest --json.

This makes it trivial to separate multiple test runs when running jest --json --watch. With the current behavior, all result objects will be concatenated without separators, requiring a streaming or custom parser to separate the test runs.

It also makes the output conform to the Unix file specification, which dicates that lines in a text file should end with an \n.

Fixes #13816

Test plan

All existing tests still pass.

[facebook-github-bot]

Hi @jessevanassen!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[SimenB]

can you add an integration test verifying the newline is present?

[jessevanassen]

can you add an integration test verifying the newline is present?

On it! 👍

[jessevanassen]

I've amended the existing tests for the Json reporter to check for the final \n, for both the variant that writes to a file and to stdout.

I also needed to add an option to runJest to preserve the final newline in stdout / stderr. The tests use Execa to spawn Jest, which by default strips the final newline. Not great if you explicitly want to test if the final new line is present 😄.
I made it configurable so that the trailing new line can be preserved, but by default will be stripped to keep the original behavior.

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[SimenB]

thanks!

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.