describe-json 0.1.3

Basic piping

$ echo '{"a": [1, 2, 3, 4]}' | describe_json
{"a": ["length: 4; example:", 1]}

Basic array shortening

$ describe_json '{"a": [1, 2, 3, 4]}'
{"a": ["length: 4; example:", 1]}

Do you have some super long strings?

$ describe_json '{"key": "suuuuuuuuuuuuuper long string"}'
{"key": "suuuuuuuuu... len: 29, md5: b7d562a2bcec0a8a346b5f32c59f257f"}

…ok, in this case the output is longer than the string. But you’ll be happier when the string is 50K long

Use a .json file

$ cat example.json
{"key1": ["a", "b", "c"]}
$ describe_json -f example.json
{"key1": ["length: 3; example:", "a"]}

Use a random array element

By default, the first element of an array is displayed. Use a random one?

$ describe_json -r {"key1": ["a", "b", "c"]}
{"key1": ["length: 3; example:", "b"]}

Specify a maximum array length

By default, only one element is displayed from an array. Specify the maximum size of arrays, after which, they are displayed as shortened

$ describe_json -a 3 '{"key1": ["a", "b", "c"]}'
{"key1": ["a", "b", "c"]}

Specify a maximum string length

By default, strings longer than 10 characters are truncated, and their md5 hash is shown (so you can see whether multiple strings that begin with the same characters are equal or not). Specify a maximum length for strings

$ describe_json -s 30 '{"key": "qwertyuiopasdfghjklzxcvbnm"}
{"key": "qwertyuiopasdfghjklzxcvbnm"}

and that’s about it! :)