json-to-usv 1.1.0

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

json-to-usv

Convert JavaScript Object Notation (JSON) to Unicode Separated Values (USV).

Syntax:

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

Example:

cat example.json | json-to-usv

Example with output to a file:

cat example.json | json-to-usv > example.usv

Options

Options for USV separators and modifiers:

  • -u --unit-separator : Set the unit separator string.

  • -r --record-separator : Set the record separator string.

  • -g --group-separator : Set the group separator string.

  • -f --file-separator : Set the file separator string.

  • --escape : Set the escape string.

  • --end-of-transmission : Set the end-of-transmission string.

Options for USV style sets:

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

  • --style-controls : Set the style to use controls, such as "\u{001F}" for Unit Separator.

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

  • --style-liners : Set the style to use liners wrapping every symbol, such as "\n␟\n" for Unit Separator.

  • --style-sheets : Set the style similar to spreadsheet sheets, such as "␟" for Unit Separator and "␟\n" for Record Separator.

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␟␞

Run:

cat example.json | json-to-usv --style-sheets

Output:

a␟b␟␞
c␟d␟␞

FAQ

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.

Is there a similar command to convert from USV to JSON?

Yes: usv-to-json.

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.

Help wanted

Constructive feedback welcome. Pull requests and feature requests welcome.

Tracking

  • Package: json-to-usv-rust-crate
  • Version: 1.1.0
  • Created: 2024-03-09T13:33:20Z
  • Updated: 2024-03-19T21:20:08Z
  • 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)