chore(docs): update plugins docs

Signed-off-by: Charlike Mike Reagent <[email protected]>

package.json

@@ -14,14 +14,14 @@
     "clean:dist": "rm -rf configs/*/dist packages/*/dist @tunnckocore/*/dist",
     "clean:fresh": "lerna clean -y && rm -rf node_modules",
     "cleanup": "yarn clean:dist && yarn clean:fresh",
+    "cmt": "LOCAL_TESTING=0 CI=1 yarn start test -u && yarn testy && git status --porcelain",
     "cr": "node create-package.js",
     "patch:hela": "cp patches/hela-cli/* node_modules/@hela/cli/dist/build/cjs/",
     "patch:sade": "cp patches/sade/* node_modules/sade/lib/",
     "patch:verb": "cp patches/verb-repo-helpers/index.js node_modules/verb-repo-helpers/index.js",
     "postsetup": "yarn patch:verb && yarn patch:hela && yarn patch:sade",
     "postsetup:ci": "yarn patch:verb && yarn patch:hela && yarn patch:sade",
     "pre-commit": "echo nothing",
-    "cmt": "LOCAL_TESTING=0 CI=1 yarn start test -u && yarn testy && git status --porcelain",
     "refresh": "yarn cleanup && yarn setup",
     "release": "lerna version && lerna publish from-package",
     "setup": "yarn && yarn bootstrap",

packages/parse-function/.verb.md

@@ -67,44 +67,35 @@ Only if you pass really an anonymous function you will get `result.name` equal t
 > _see: the [.use](#use) method, [test/index.js#L305-L317](https://github.com/tunnckoCore/parse-function/blob/master/test/index.js#L305-L317) and [test/index.js#L396-L414](https://github.com/tunnckoCore/parse-function/blob/master/test/index.js#L396-L414)_
 
 A more human description of the plugin mechanism. Plugins are **synchronous** - no support
-and no need for **async** plugins here.
+and no need for **async** plugins here. Plugins MAY or MAY NOT return Result object, so
+don't worry if you miss to return something.
 
 ```js
-const parseFunction = require('parse-function');
-const app = parseFunction();
-
-app.use((self) => {
-  // self is same as `app`
-  console.log(self.use);
-  console.log(self.parse);
-  console.log(self.define);
-
-  self.define(self, 'foo', (bar) => bar + 1);
-});
-
-console.log(app.foo(2)); // => 3
-```
-
-On the other side, if you want to access the AST of the parser, you should return a function
-from that plugin, which function is passed with `(node, result)` signature.
+import { parseFunction } from 'parse-function';
 
-This function is lazy plugin, it is called only when the [.parse](#parse) method is called.
+function someFn(foo, bar) {
+  return foo + bar;
+}
 
-```js
-const parseFunction = require('parse-function');
-const app = parseFunction();
+const plugins = [
+  (node, result) => {
+    return { ...result, zaz: 111 };
+  },
+  (node, result) => {
+    return { qux: result.zaz + 202 };
+  },
+];
 
-app.use((self) => {
-  console.log('immediately called');
+const res = parseFunction(someFn, { plugins });
+console.log(res);
 
-  return (node, result) => {
-    console.log('called only when .parse is invoked');
-    console.log(node);
-    console.log(result);
-  };
-});
+console.log(res.name); // => 'someFn'
+console.log(res.zaz); // => 111
+console.log(res.qux); // => 313
 ```
 
+If you want to access the AST of the parser, use the `node` parameter of the plugin.
+
 Where **1)** the `node` argument is an object - actual and real AST Node coming from the parser
 and **2)** the `result` is an object too - the end [Result](#result), on which
 you can add more properties if you want.

packages/parse-function/README.md

@@ -165,44 +165,35 @@ Only if you pass really an anonymous function you will get `result.name` equal t
 > _see: the [.use](#use) method, [test/index.js#L305-L317](https://github.com/tunnckoCore/parse-function/blob/master/test/index.js#L305-L317) and [test/index.js#L396-L414](https://github.com/tunnckoCore/parse-function/blob/master/test/index.js#L396-L414)_
 
 A more human description of the plugin mechanism. Plugins are **synchronous** - no support
-and no need for **async** plugins here.
+and no need for **async** plugins here. Plugins MAY or MAY NOT return Result object, so
+don't worry if you miss to return something.
 
 ```js
-const parseFunction = require('parse-function');
-const app = parseFunction();
-
-app.use((self) => {
-  // self is same as `app`
-  console.log(self.use);
-  console.log(self.parse);
-  console.log(self.define);
-
-  self.define(self, 'foo', (bar) => bar + 1);
-});
-
-console.log(app.foo(2)); // => 3
-```
-
-On the other side, if you want to access the AST of the parser, you should return a function
-from that plugin, which function is passed with `(node, result)` signature.
+import { parseFunction } from 'parse-function';
 
-This function is lazy plugin, it is called only when the [.parse](#parse) method is called.
+function someFn(foo, bar) {
+  return foo + bar;
+}
 
-```js
-const parseFunction = require('parse-function');
-const app = parseFunction();
+const plugins = [
+  (node, result) => {
+    return { ...result, zaz: 111 };
+  },
+  (node, result) => {
+    return { qux: result.zaz + 202 };
+  },
+];
 
-app.use((self) => {
-  console.log('immediately called');
+const res = parseFunction(someFn, { plugins });
+console.log(res);
 
-  return (node, result) => {
-    console.log('called only when .parse is invoked');
-    console.log(node);
-    console.log(result);
-  };
-});
+console.log(res.name); // => 'someFn'
+console.log(res.zaz); // => 111
+console.log(res.qux); // => 313
 ```
 
+If you want to access the AST of the parser, use the `node` parameter of the plugin.
+
 Where **1)** the `node` argument is an object - actual and real AST Node coming from the parser
 and **2)** the `result` is an object too - the end [Result](#result), on which
 you can add more properties if you want.