Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix link to newline-delimited JSON #4

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix link to newline-delimited JSON #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/machine-readable-output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Applications *may* (and in the case of forced loose coupling, *should*) make the
* Programs *may* also provide their output as XML, [CBOR](https://cbor.io/), [MessagePack](https://msgpack.org/index.html), or other **self-describing** formats.
* A self-describing format is one where the keys, or some equivalent, are part of the serialized output.
* Formats like [protobuf](https://developers.google.com/protocol-buffers) are suitable as well, if up-to-date IDLs (e.g. `.proto` files) are published along with releases. One neat trick is to embed them into your binary and add a command to write them out to a given directory.
* If many lines of structured data are incrementally printed out, prefer a format like [newline-delimited JSON](http://ndjson.org/). This is the format used by Cargo's `--message-format json` option.
* If many lines of structured data are incrementally printed out, prefer a format like [newline-delimited JSON](https://jsonlines.org/). This is the format used by Cargo's `--message-format json` option.

**Programs *must not* provide their output as [bincode](https://github.com/bincode-org/bincode) or other non-self-describing formats.** These formats are unsuitable for interoperability, where stability is paramount.

Expand Down
Loading