#convert-json

bin+lib json-to-usv

JSON to USV: Convert JavaScript Object Notation (JSON) to Unicode Separated Values (USV) for data markup, including for spreadsheets, databases, text files, and more

7 stable releases

1.2.4 Apr 11, 2024
1.2.2 Apr 4, 2024
1.2.1 Mar 26, 2024

#7 in #convert-json

MIT OR Apache-2.0 OR GPL-2.0 OR GPL-3.0

27KB
422 lines

json-to-usv

Convert JavaScript Object Notation (JSON) to Unicode Separated Values (USV). Built with the USV Rust crate.

Syntax:

stdin | json-to-usv [options] | stdout

Example:

cat example.json | json-to-usv

More examples below.

Options

Options for USV separators and modifiers:

  • -u, --us : Set the unit separator (US) string.

  • -r, --rs : Set the record separator (RS) string.

  • -g, --gs : Set the group separator (GS) string.

  • -f, --fs : Set the file separator (FS) string.

  • -e, --esc : Set the escape (ESC) string.

  • -z, --eot : Set the end of transmission (EOT) string.

Options for USV style:

  • --style-braces : Set the style to use braces, such as "{US}" for Unit Separator.

  • --style-controls : Set the style to use controls, such as "\u001F" for Unit Separator.

  • --style-symbols : Set the style to use symbols, such as "␟" for Unit Separator.

Options for USV layout:

  • --layout-0: Show each item with no line around it. This is no layout, in other words one long line.

  • --layout-1: Show each item with one line around it. This is like single-space lines for long form text.

  • --layout-2: Show each item with two lines around it. This is like double-space lines for long form text.

  • --layout-units: Show each unit on one line. This can be helpful for line-oriented tools.

  • --layout-records: Show each record on one line. This is like a typical spreadsheet sheet export.

  • --layout-groups: Show each group on one line. This can be helpful for folio-oriented tools.

  • --layout-files: Show one file on one line. This can be helpful for archive-oriented tools.

Options for command line tools:

  • -h, --help : Print help

  • -V, --version : Print version

  • -v, --verbose... : Set the verbosity level: 0=none, 1=error, 2=warn, 3=info, 4=debug, 5=trace. Example: --verbose …

  • --test : Print test output for debugging, verifying, tracing, and the like. Example: --test

Install

Install:

cargo install json-to-usv

Link: https://crates.io/crates/json-to-usv

Example

Suppose file example.json contains:

[
    ["a","b"],
    ["d","e"]
]

Run:

cat example.json | json-to-usv

Output:

a␟b␟␞
c␟d␟␞

FAQ

What converters are available?

When to use this command?

Use this command when you want to convert from JSON to USV.

A typical use case is when you have JSON data, such as a web request result, and you want to convert it to USV, such as to make the data easier to view, or edit, or maintain.

Our real-world use case is converting a bunch of JSON web API RPC results from a variety of programs, including Excel, to USV so we're better-able to handle quoting, and multi-line data units, and Unicode characters in a wide variety of human languages.

Why use USV instead of JSON?

See the documentation for USV.

Is USV aiming to become a standard?

Yes, USV is submitted to IETF.org as an Internet-Draft work in progress: link.

Can I build my own USV tools?

Yes, and you may freely use the USV RFC and USV Rust crate.

Help wanted

Constructive feedback welcome. Pull requests and feature requests welcome.

Tracking

  • Package: json-to-usv-rust-crate
  • Version: 1.2.4
  • Created: 2024-03-09T13:33:20Z
  • Updated: 2024-04-11T18:14:24Z
  • License: MIT or Apache-2.0 or GPL-2.0 or GPL-3.0 or contact us for more
  • Contact: Joel Parker Henderson (joel@sixarm.com)

Dependencies

~2–3MB
~58K SLoC