npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jsondepth

v2.0.5

Published

A small command-line tool to parse JSON and log it with the desired object depth

Downloads

494

Readme

jsondepth

A small command-line tool to walk through the depth levels of a json objects

output json | jd <PATH>=. <DEPTH>=0

screenshot

Summary

Motivation

Working with super deep json objects from the terminal is a pain, unless you use a good json parser. jq is an awesome one, but doesn't handle object depths, afaik. Here the idea is to walk through a json object as you would read a summary: level by level.

Installation

npm install -g jsondepth

How-to

real world example:

url='https://www.wikidata.org/w/api.php?action=wbgetentities&ids=Q1&format=json'
curl -s "$url" | jsondepth

logs the object with only the first-level keys and values:

{ entities: [Object], success: 1 }

for the sake of convenience and lazyness, jsondepth is aliased to jd (which, purposedly make it look a bit like jq)

curl -s "$url" | jd

Specify a depth level

this is equivalent to the two previous one:

curl -s "$url" | jd 0

now let's go one-level deeper:

curl -s "$url" | jd 1

outputs:

{ entities: { Q1: [Object] }, success: 1 }

we need to go deeper

curl -s "$url" | jd 2
curl -s "$url" | jd 3
curl -s "$url" | jd 4
# etc
curl -s "$url" | jd -1

Specify a path

curl -s "$url" | jd entities.Q1.aliases.fi.1
# or to mimick jq syntax
curl -s "$url" | jd .entities.Q1.aliases.fi.1
# or with keys with spaces
curl -s "$url" | jd .entities.Q1.['a key with spaces']

Specify a depth and a path

if both a path and a depth are specified, path should come first, depth second

curl -s "$url" | jd entities.Q1.claims.P31.0 3

Access JS objects attributes

Native attributes

Arrays length
curl -s "$url" | jd entities.Q1.aliases.en.length
# => 5

Special keys

_keys

apply Object.keys to the final object

curl -s "$url" | jd entities._keys
# => ['Q1']
_values

apply _.values to an array

curl -s "$url" | jd entities._values
# => [{ id: 'Q1', etc...}]
curl -s "$url" | jd entities._values.0.id
# => 'Q1'
_map

map properties of an array

curl -s "$url" | jd entities._values._map.id
# => ['Q1']
_first
echo '["foo", "bar"]' | jd ._first
# => foo
_last
echo '["foo", "bar"]' | jd ._first
# => bar

Format the output as valid JSON

Wrapped results like { entities: { Q1: [Object] }, success: 1 } are more readible but aren't valid JSON. And sometimes, for whatever reason, you want a valid JSON output; there in a option for that: --json|-j

curl -s "$url" | jd entities.Q1.aliases --json

You can even specify the output indentation level (Between 0 and 9. Default: 2):

curl -s "$url" | jd entities.Q1.aliases --json=0
curl -s "$url" | jd entities.Q1.aliases --json=4

Notice that it disables the depth option as it's responsible for the wrapping mechanism.

Parse newline delimited JSON

Add the --line option to parse the stdin line by line

curl https://some.ndjson.dump | jd --line .key

There is a tolerance for JSON lines ending by a comma, and any line that isn't starting by a { or a } is ignored.

See also