# jjq [![Crates.io](https://img.shields.io/crates/v/js-json-query)](https://crates.io/crates/js-json-query) [![Tags](https://img.shields.io/github/v/tag/pjmp/js-json-query?label=latest%20tag&style=flat)](https://github.com/pjmp/js-json-query/tags) ![License](https://img.shields.io/crates/l/js-json-query) 

> A tool for processing JSON inputs with JavaScript, no dsl!

# Introduction

[jq](https://stedolan.github.io/jq/) is an awesome tool if you know it well go ahead, use it.

I don't use `jq` all the time, and consequently I don't remember its [filter](https://stedolan.github.io/jq/manual/#Basicfilters) DSL syntax, however I do know JavaScript, so it's easier and quicker for me to fire node and do whatever I want.

`jjq` is a convenient way to combine usability of `jq` and scripting ability of nodejs.

# Notes

By default, if no code is passed, `jjq` will pretty print the input json to stdout.

The input json can be accessed in the script with the variable name `it`.

# Examples

```shell
jjq 'it.feeds[0].multiMedia[0]' -f jsonfilewithhierarchy-100-100.json

echo '{"key": "value"}' | jjq

jjq 'it[0]' < EmployeeData.json

cat EmployeeData.json | jjq 'it.map(t => ({name: t.name, age: t.email}))'

# pass `-i` flag to include a js file
jjq 'let p = it.map(t => t.password); max(p.map(len))' -i demos/libs.js -f EmployeeData.json
```

# Installation

If you have rust toolchain installed, you can just do

```shell
cargo install js-json-query
```

Getting rust toolchain is super easy, head over [here](https://www.rust-lang.org/tools/install) if you are interested.

Alternatively, you can download pre-build binaries from the [release page](https://github.com/pjmp/js-json-query/releases).

# Usage

```
Usage: jjq [<script>] [-f <file>] [-v] [-i <includes>]

A tool for processing JSON inputs with JavaScript, no dsl

Positional Arguments:
  script            code to process the json input

Options:
  -f, --file        path to json file
  -v, --version     get version information
  -i, --includes    js files to include
  --help            display usage information
```

# Limitations

- The code passed should be a valid JavaScript code as this uses v8 engine to run the script therefore sometimes it can get quite verbose.

- The script passed should end with an expression not statement, if statement ends the script then `undefined` will be printed.

**Example**

```shell
jjq 'let t = it.key;' --file your-json-file.json # output -> undefined

jjq 'let t = it.key; t' --file your-json-file.json # output json -> {...}
```