kanatti/pretty

Command line utility to view prettified files

Pretty

View files prettified on CLI

Development

Install as binary:

$ cargo install --path .
$ pretty --help
Usage: pretty [OPTIONS] <FILE>

Arguments:
  <FILE>

Options:
  -f, --flatten <FIELDS>           Comma seperated list of fields to flatten
  -c, --color <COLOR>              [default: never] [possible values: never, always, auto]
  -s, --select <SELECT>            [default: .]
      --select-mode <SELECT_MODE>  [default: auto] [possible values: only, append, auto]
      --sort <FIELD>               Field to sort by
      --filter <FIELD=VALUE>       Filter expression
  -h, --help                       Print help information
  -V, --version                    Print version information

Run samples:

$ pretty samples/test2.json

┌─────────────────┬───────┬──────────────┬──────┬───────┐
│name             │age    │secretIdentity│powers│address│
├─────────────────┼───────┼──────────────┼──────┼───────┤
│"Molecule Man"   │29     │"Dan Jukes"   │[..]  │{..}   │
├─────────────────┼───────┼──────────────┼──────┼───────┤
│"Madame Uppercut"│39     │"Jane Wilson" │[..]  │{..}   │
├─────────────────┼───────┼──────────────┼──────┼───────┤
│"Eternal Flame"  │1000000│"Unknown"     │[..]  │       │
└─────────────────┴───────┴──────────────┴──────┴───────┘

$ pretty samples/test2.json --flatten=address

┌─────────────────┬───────┬──────────────┬──────┬───────────────┬──────────────┬──────────────┐
│name             │age    │secretIdentity│powers│address.country│address.planet│address.galaxy│
├─────────────────┼───────┼──────────────┼──────┼───────────────┼──────────────┼──────────────┤
│"Molecule Man"   │29     │"Dan Jukes"   │[..]  │"US"           │"Earth"       │              │
├─────────────────┼───────┼──────────────┼──────┼───────────────┼──────────────┼──────────────┤
│"Madame Uppercut"│39     │"Jane Wilson" │[..]  │               │"PL120"       │"Andromeda"   │
├─────────────────┼───────┼──────────────┼──────┼───────────────┼──────────────┼──────────────┤
│"Eternal Flame"  │1000000│"Unknown"     │[..]  │               │              │              │
└─────────────────┴───────┴──────────────┴──────┴───────────────┴──────────────┴──────────────┘

$ pretty samples/test2.json --select 'powers.[].0' --select-mode append

┌─────────────────┬───────┬──────────────┬──────┬───────┬──────────────────────┐
│name             │age    │secretIdentity│powers│address│powers.[].0           │
├─────────────────┼───────┼──────────────┼──────┼───────┼──────────────────────┤
│"Molecule Man"   │29     │"Dan Jukes"   │[..]  │{..}   │"Radiation resistance"│
├─────────────────┼───────┼──────────────┼──────┼───────┼──────────────────────┤
│"Madame Uppercut"│null   │"Jane Wilson" │[..]  │{..}   │"Million tonne punch" │
├─────────────────┼───────┼──────────────┼──────┼───────┼──────────────────────┤
│"Eternal Flame"  │1000000│"Unknown"     │[..]  │       │"Immortality"         │
└─────────────────┴───────┴──────────────┴──────┴───────┴──────────────────────┘

$ pretty samples/test2.json --sort age

┌─────────────────┬───────┬──────────────┬──────┬───────┐
│name             │age    │secretIdentity│powers│address│
├─────────────────┼───────┼──────────────┼──────┼───────┤
│"Molecule Man"   │29     │"Dan Jukes"   │[..]  │{..}   │
├─────────────────┼───────┼──────────────┼──────┼───────┤
│"Eternal Flame"  │1000000│"Unknown"     │[..]  │       │
├─────────────────┼───────┼──────────────┼──────┼───────┤
│"Madame Uppercut"│null   │"Jane Wilson" │[..]  │{..}   │
└─────────────────┴───────┴──────────────┴──────┴───────┘

# Filter only supports equals for now
$ pretty samples/test2.json --filter 'age=29'

┌──────────────┬───┬──────────────┬──────┬───────┐
│name          │age│secretIdentity│powers│address│
├──────────────┼───┼──────────────┼──────┼───────┤
│"Molecule Man"│29 │"Dan Jukes"   │[..]  │{..}   │
└──────────────┴───┴──────────────┴──────┴───────┘

Enabling color

Use --color auto or --color always to enable color.

$  pretty samples/test2.json --color auto

pretty's Issues

Revise API for different commands

For non-interactive mode, revise API for different commands like sort, filter, select, flatten etc.

• Should it be chain one after another?
• Or all commands as arguments?
• Should we limit non-interactive mode to fewer commands? than interactive

Basic version of interactive mode

• Full screen view
• Decide the parts of view
• Read command -> Render -> loop

Support jsonl format

Read and render jsonl. Trigger json vs jsonl based on just extension for now

Support CSV

Read and render csv files.

Render json with top level object

Right now we only render Json Array or Json lines. Render Json Object

Command to show inferred schema

Outputs

• full fledged schema json
• user friend rendered string on terminal

Open questions

• How to infer and what all to infer?

We can start with basic and improve (like enumarations etc)

Clip large values

• Clip columns
• Clips rows
• Clips string values

Also take into consideration available width and height of terminal?

Implement basic commands

• filter
• select
• sort

Note: no need to focus on API in this task, covered in - #3

Add roadmap documention

Add details around feature roadmap and status in readme

Support STDIN

Will have to detect format JSON vs JSON Lines

Json lines - ignore bad lines

Ignore bad lines in .jsonl format with warnings