From 97664caa651c8d105c39cc4c4d0102f12562d0e2 Mon Sep 17 00:00:00 2001 From: Anton Medvedev Date: Fri, 26 Jan 2018 09:35:58 +0700 Subject: [PATCH] Use single quote in examples --- README.md | 46 ++++++++++++++++++++++++++++++---------------- index.js | 8 ++++---- 2 files changed, 34 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index b5fe842..8226a15 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Pipe into `fx` any JSON and anonymous function for reducing it. $ fx [code ...] ``` -Pretty print JSON: +Pretty print JSON without passing any arguments: ``` $ echo '{"key":"value"}' | fx { @@ -32,34 +32,42 @@ $ echo '{"key":"value"}' | fx } ``` -Use anonymous function: +### Anonymous function + +Use an anonymous function as reducer which gets JSON and processes it: ``` -$ echo '{"foo": [{"bar": "value"}]}' | fx "x => x.foo[0].bar" +$ echo '{"foo": [{"bar": "value"}]}' | fx 'x => x.foo[0].bar' "value" ``` +### This Binding + If you don't pass anonymous function `param => ...`, code will be automatically transformed into anonymous function. And you can get access to JSON by `this` keyword: ``` -$ echo '{"foo": [{"bar": "value"}]}' | fx "this.foo[0].bar" +$ echo '{"foo": [{"bar": "value"}]}' | fx 'this.foo[0].bar' "value" ``` +### Chain + You can pass any number of anonymous functions for reducing JSON: ``` -$ echo '{"foo": [{"bar": "value"}]}' | fx "x => x.foo" "this[0]" "this.bar" +$ echo '{"foo": [{"bar": "value"}]}' | fx 'x => x.foo' 'this[0]' 'this.bar' "value" ``` +### Generator + If passed code contains `yield` keyword, [generator expression](https://github.com/sebmarkbage/ecmascript-generator-expression) will be used: ``` -$ curl ... | fx "for (let user of this) if (user.login.startsWith('a')) yield user" +$ curl ... | fx 'for (let user of this) if (user.login.startsWith("a")) yield user' ``` Access to JSON through `this` keyword: ``` -$ echo '["a", "b"]' | fx "yield* this" +$ echo '["a", "b"]' | fx 'yield* this' [ "a", "b" @@ -67,7 +75,7 @@ $ echo '["a", "b"]' | fx "yield* this" ``` ``` -$ echo '["a", "b"]' | fx "yield* this; yield 'c';" +$ echo '["a", "b"]' | fx 'yield* this; yield "c";' [ "a", "b", @@ -75,18 +83,30 @@ $ echo '["a", "b"]' | fx "yield* this; yield 'c';" ] ``` +### Update + You can update existing JSON using spread operator: ``` -$ echo '{"count": 0}' | fx "{...this, count: 1}" +$ echo '{"count": 0}' | fx '{...this, count: 1}' { "count": 1 } ``` +### Use npm package + +Use any npm package by installing it globally: +``` +$ npm install -g lodash +$ cat package.json | fx 'require("lodash").keys(this.dependencies)' +``` + +### Other examples + Convert object to array: ``` -$ cat package.json | fx "yield* Object.keys(this.dependencies)" +$ cat package.json | fx 'Object.keys(this.dependencies)' [ "cardinal", "get-stdin", @@ -94,12 +114,6 @@ $ cat package.json | fx "yield* Object.keys(this.dependencies)" ] ``` -Use any npm package: -``` -$ npm install -g lodash -$ cat package.json | fx "require('lodash').keys(this.dependencies)" -``` - ## Related diff --git a/index.js b/index.js index b134725..3c7e39c 100755 --- a/index.js +++ b/index.js @@ -10,16 +10,16 @@ const cli = meow(` $ fx [code ...] Examples - $ echo '{"key": "value"}' | fx "x => x.key" + $ echo '{"key": "value"}' | fx 'x => x.key' "value" - $ echo '[1,2,3]' | fx "this.map(x => x * 2)" + $ echo '[1,2,3]' | fx 'this.map(x => x * 2)' [2, 4, 6] - $ echo '{"items": ["one", "two"]}' | fx "this.items" "this[1]" + $ echo '{"items": ["one", "two"]}' | fx 'this.items' 'this[1]' "two" - $ echo '{"count": 0}' | fx "{...this, count: 1}" + $ echo '{"count": 0}' | fx '{...this, count: 1}' {"count": 1} `)