https://github.com/kamataryo/jqf

Jqf is an easy CLI JSON processor.
https://github.com/kamataryo/jqf

Last synced: 2 months ago
JSON representation

Jqf is an easy CLI JSON processor.

• Host: GitHub
• URL: https://github.com/kamataryo/jqf
• Owner: kamataryo
• License: mit
• Created: 2018-12-28T05:13:43.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-03-08T22:57:54.000Z (11 months ago)
• Last Synced: 2024-10-16T01:32:01.288Z (3 months ago)
• Language: JavaScript
• Homepage: https://jqf.kamataryo.com
• Size: 1.58 MB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jqf

[![build](https://github.com/kamataryo/jqf/workflows/build/badge.svg)](https://github.com/kamataryo/jqf/actions/workflows/build.yml)

[![npm version](https://badge.fury.io/js/jqf.svg)](https://badge.fury.io/js/jqf)

Jqf is a CLI JSON processor with JavaScript function syntax.

Show documentation: [https://jqf.kamataryo.com](https://jqf.kamataryo.com)

## Prerequisites for usage

Node.js > 16

## install

```shell

$ npm install jqf --global

```

With `npx`:

```shell

$ echo '{"hello": "world"}' | npx jqf 'x => x.hello'

npx: installed 10 in 4.419s

"world"

```

## Usage and examples

Basic:

```shell

$ echo '{"hello": "world"}' | jqf 'x => x.hello'

"world"

```

Array processing example with `find` method:

```shell

$ echo '["apple", "orange", "banana"]' | jqf --raw-string-output '

    fruits => fruits

      .find(fruit => fruit[0] === "a")

  '

apple

```

Non JSON output (example if you tried to return a function literal):

```shell

$ echo '{}' | jqf '() => (x => x)'

undefined

```

Merge stdin streams:

```shell

# The merged streams with line-breaks will be placed ordered arguments.

$ cat <(echo '{"value":1}') <(echo '{"value":2}') | \

    jqf '(x, y) => x.value + y.value'

3

```

sub commands:

_NOTE_ sub commands ignore input with multiple streams described above and treat only 1st argument.

```shell

# equivalent with `jqf 'arr => arr.map(num => num + 1)'

$ echo '[1,2]' | jqf map --minify 'num => num + 1'

[2,3]

```

```shell

$ echo '[1,2,3]' | jqf reduce '(prev, val) => prev + val' '0'

```

Security inside sandbox:

```shell

$ echo '{}' | jqf '() => require("fs").readFileSync("/path/to/secret")'

[error] require is not defined

[error] The argument should be a valid executable JavaScript function.

```

NOTE: see also [safe-eval](https://www.npmjs.com/package/safe-eval) package for sandbox features.

### options

```shell

$ jqf -h

Usage: jqf [method] [options] ""

Process stdin JSON string with JavaScript function.

Options:

  -V, --version            output the version number

  -r, --raw-string-output  no quotations with string output

  -m, --minify             minify output JSON

  -h, --help               output usage information

Examples:

  $ jqf             'obj => obj.value'

  $ jqf map         'arr => arr.id'

  $ jqf find        'arr => arr.id === 1'

  $ jqf filter      'arr => !arr'

  $ jqf some        'arr => arr % 2 === 0'

  $ jqf every        'arr => arr % 2 === 0'

  $ jqf reduce      '(prev, item) => /* reduce */' '"value"'

  $ jqf reduceRight '(prev, item) => /* reduce */' '"value"'

  $ jqf flatMap     'arr => arr'

  $ jqf keys

  $ jqf values

  $ jqf entries

  $ jqf fromEntries

```

## development

```shell

$ git clone [email protected]:kamataryo/jqf.git

$ cd jqf

$ bun install

$ bun test

$ bun run build

```

## docs development

```shell

$ cd website

$ bun install

$ bun start

$ bun run build

```

## contributions

[Issues](https://github.com/kamataryo/jqf/issues) and [pull requests](https://github.com/kamataryo/jqf/pulls) are welcome.

## Acknowledgements

This project is inspired by great CLI JSON processing tool, [jq](https://stedolan.github.io/jq/).