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

@davesnx/query-json

v0.5.20

Published

faster and simpler re-implementation of jq in Reason Native

Downloads

21

Readme


query-json is a faster and simpler re-implementation of the jq language in Reason Native and distributed as a dependency-free binary thanks to the OCaml compiler. query-json, allows you to write small programs to operate on top of json files in a cute syntax:

Purpose

It was created with 2 reasons in mind, learn and fun:

  • Learn how to write a lexer/parser/compiler with the OCaml stack using menhir and sedlex while trying to create a compiler with great error messages and possibly recoverability (currently work in progress).
  • Create a CLI tool in Reason Native and being able to distribute it as a binary, enjoy it's performance and try further with cross-compilation.

Intro

query-json ".store.books | filter(.price > 10)" stores.json

This would access to "store" field inside the stores.json, access to "books" field, (since it's an array) it will run a filter on each item and if "price" field is bigger than 10 will keep that item on the list, and finally print the resultant list.

[
  {
    "title": "War and Peace",
    "author": "Leo Tolstoy",
    "price": 12.0
  },
  {
    "title": "Lolita",
    "author": "Vladimir Nabokov",
    "price": 13.0
  }
]

It brings

  • Great Performance: Fast, small footprint and minimum run-time. Check Performance section for a longer explanation.
  • Delightful errors:
    • Better errors when json types and operation don't match:
      $ query-json '.esy.release.wat' esy.json
      Error:  Trying to ".wat" on an object, that don't have the field "wat":
      { "bin": ... }
    • debug prints the tokens and the AST.
    • verbose flag, prints each operation in each state and it's intermediate states. (Work in progress...)
  • Improved API: made small adjustments to the buildin operations. Some examples are:
    • All methods are snake_case instead of alltoghetercase
    • Added filter(p) as an alias for map(select(p))
    • Supports comments in JSONs
  • Small: Lexer, Parser and Compiler are just 300 LOC and most of the commands that I use on my day to day are implemented in only 140 LOC.

Installation

Using a bash script

Check the content of scripts/install.sh before running anything in your local. Friends don't let friends curl | bash.

curl -sfL https://raw.githubusercontent.com/davesnx/query-json/master/scripts/install.sh | bash

Using npm/yarn

npm install --global @davesnx/query-json
# or
yarn global add @davesnx/query-json

Download zip files from GitHub

Usage

I recommend to write the query in single-quotes inside the terminal, since writting JSON requires double-quotes for accessing properties.

NOTE: I have aliased query-json to be "q" for short, you can set it in your dotfiles. alias q="query-json".

query a json file

q '.' pokemons.json

query from stdin

cat pokemons.json | q '.'

query a json inlined

q --kind=inline '.' '{ "bulvasur": { "id": 1, "power": 20 } }'

query without colors

q '.' pokemons.json --no-colors

Performance

This report is not an exhaustive performance report of both tools, it's a overview for the percieved performance of the user. Here I don't profile each tool and try to see what are the bootlenecks, since I assume that both tools have the penalty of parsing a JSON file. Simply run a bash script and analyze the results.

Aside from that, query-json doesn't have feature parity with jq which is ok at this point, but jq contains a ton of functionality that query-json misses. Adding the missing operations on query-json won't affect the performance of it, that could not be true for features like "modules" or "tests", which they will not be implemented in query-json.

The report shows that query-json is between 2x and 5x faster than jq in all operations tested and same speed (~1.1x) with huge files (> 100M).

Currently supported feature set:

| Badge | Meaning | | ----- | ------------------- | | ✅ | Implemented | | ⚠️ | Not implemented yet | | 🔴 | Won't implement |

Based on jq 1.6
  • CLI: Invoking jq

    • --version
    • --kind. This is different than jq ✅
      • --kind=file and the 2nd argument can be a json file
      • --kind=inline and the 2nd argument can be a json as a string
    • --no-color. This disables colors ✅
    • ...rest ⚠️
  • Basic filters

    • Identity: .
    • Object Identifier-Index: .foo, .foo.bar
    • Optional Object Identifier-Index: .foo?
    • Generic Object Index: .[<string>]
    • Array Index: .[2]
    • Pipe: |
    • Array/String Slice: .[10:15] ⚠️
    • Array/Object Value Iterator: .[]
    • Comma: ,
    • Parenthesis: () ✅️
  • Types and Values ⚠️

  • Builtin operators and functions

    • Addition: +
    • Subtraction: -
    • Multiplication, division, modulo: *, /, and %
    • length
    • keys
    • map
    • select
    • has(key) ⚠️
    • in ⚠️
    • path(path_expression) ⚠️
    • to_entries, from_entries, with_entries ⚠️
    • any, any(condition), any(generator; condition) ⚠️
    • all, all(condition), all(generator; condition) ⚠️
    • flatten
    • range(upto), range(from;upto) range(from;upto;by) ⚠️
    • floor, sqrt ⚠️
    • tonumber, tostring ⚠️
    • type ⚠️
    • infinite, nan, isinfinite, isnan, isfinite, isnormal ⚠️
    • sort, sort_by(path_expression)
    • group_by(path_expression) ⚠️
    • min, max, min_by(path_exp), max_by(path_exp) ⚠️
    • unique, unique_by(path_exp) ⚠️
    • reverse ⚠️
    • contains(element) ⚠️
    • index(s), rindex(s) ⚠️
    • startswith(str), endswith(str) ⚠️
    • explode, implode ⚠️
    • split(str), join(str) ⚠️
    • while(cond; update), until(cond; next) ⚠️
    • recurse(f), recurse, recurse(f; condition), recurse_down ⚠️
    • walk(f) ⚠️
    • transpose(f) ⚠️
    • Format strings and escaping: @text, @csv, etc.. 🔴

Conditionals and Comparisons

  • ==, !=
  • if-then-else ⚠️
  • >, >=, <=, <
  • and, or, not ⚠️
  • break 🔴

Regular expressions (PCRE) ⚠️

Advanced features ⚠️

Assignment ⚠️

Modules ⚠️

Contributing

Contributions are what make the open source community such an amazing place to be, learn, inspire, and create. Any contributions you make are greatly appreciated. If you have any questions just contact me @twitter or email ([email protected]).

Support

I usually hang out at discord.gg/reasonml or reasonml.chat so feel free to ask anything there.

Setup

Requirements: esy

git clone https://github.com/davesnx/query-json
cd query-json
esy # installs
esy test # runs unit tests with [rely](https://reason-native.com/docs/rely), live under test/.
esy bin # Run binary

Acknowledgements

Thanks to @EduardoRFS. Thanks to all the authors of dependencies that this project relies on: menhir, sedlex, yojson. Thanks to the OCaml and Reason Native team.