Fix: cleanup json output to be machine-readable

[newsroomdev]

Summary

This change accomplishes both a fix and provides a new feature. The initial v2 made the JSON output unable to be read by machines, specifically command-line tools like jq.

Changes

• Moves contextual info, e.g. the number of tests passed and the number of rows sampled, behind conditionals. If you're outputting JSON --json or --json-pretty then these contextual strings are not output.
• Converts WriteFileSync to WriteFile streams, allowing for CLI pipe | functionality, e.g. | jq

Addtions

• Adds a new flag --exit or -e to throw a CLI error if any Dataproofer tests are total failures. This allows for developers to creates automated CI workflows like GitHub Actions that can throw errors and notify others if a dataset has serious problems.

How to review

• Pull this branch
• Try out the sample datasets with jq queries. Maybe add some jq documentation?
• Run Dataproofer with the new --exit flag. Does it throw errors in your console ❌

[ejfox]

beautiful