@putout/engine-runner 12.3.0 → 12.6.0

package/README.md

@@ -13,6 +13,15 @@ npm i @putout/engine-runner
 
 ## Supported Plugin Types
 
+There is a couple plugin types supported by 🐊`Putout`:
+
+- ✅[`Replacer`](#replacer)
+- ✅[`Includer`](#includer)
+- ✅[`Traverser`](#traverser)
+- ✅[`Finder`](#finder)
+
+They goes from simplest to hardest. Let's start from `Replacer`.
+
 ### Replacer
 
 `Replacer` converts code in declarative way. Simplest possible form, no need to use `fix`. Just `from` and `to` parts
@@ -171,14 +180,70 @@ module.exports.traverse = ({push}) => ({
 });
 ```
 
-#### Storages
+### Finder
+
+`Find plugins` gives you all the control over traversing, but it's the slowest format.
+Because `traversers` not merged in contrast with other plugin formats.
+
+```js
+module.exports.report = () => 'debugger statement should not be used';
+
+module.exports.fix = (path) => {
+    path.remove();
+};
+
+module.exports.find = (ast, {push, traverse}) => {
+    traverse(ast, {
+        'debugger'(path) {
+            push(path);
+        },
+    });
+};
+```
+
+## Example
+
+```js
+const {runPlugins} = require('@putout/engine-runner');
+const {parse} = require('@putout/engin-parser');
+
+const plugins = [{
+    rule: "remove-debugger",
+    msg: "",        // optional
+    options: {},    // optional
+    plugin: {
+        include: () => ['debugger'],
+        fix: (path) => path.remove(),
+        report: () => `debugger should not be used`,
+    },
+}];
+
+const ast = parse('const m = "hi"; debugger');
+const places = runPlugins({
+    ast,
+    shebang: false,     // default
+    fix: true,          // default
+    fixCount: 1,        // default
+    plugins,
+    parser: 'babel',    // default
+});
+```
+
+## Stores
+
+Stores is preferred way of keeping 🐊`Putout` data, `traverse` init function called only once, and any other way
+of handling variables will most likely will lead to bugs. There is 3 store types:
 
-Storages is preferred way of keeping data 🐊`Putout`, `traverse` init function called only once, and any other way
-of handling variables will most likely will lead to bugs.
+- ✅`listStore`;
+- ✅`store`;
+- ✅`upstore`;
 
-##### listStore
+Let's talk about each of them.
 
-To keep things and save them as a list during traverse in a safe way `listStore` can be used for code:
+### `listStore`
+
+To save things as a list use `listStore`.
+Let's suppose you have such code:
 
 ```js
 debugger;
@@ -187,6 +252,8 @@ debugger;
 const world = '';
 ```
 
+Let's process it!
+
 ```js
 module.exports.traverse = ({listStore}) => ({
     'debugger'(path) {
@@ -205,7 +272,9 @@ module.exports.traverse = ({listStore}) => ({
 });
 ```
 
-When you need `key-value` storage `store` can be used.
+### `store`
+
+When you need `key-value` use `store`:
 
 ```js
 module.exports.traverse = ({push, store}) => ({
@@ -232,9 +301,9 @@ module.exports.traverse = ({push, store}) => ({
 });
 ```
 
-#### Upstore
+### `upstore`
 
-When you need to update already saved values, use `upstore`
+When you need to update already saved values, use `upstore`:
 
 ```js
 module.exports.traverse = ({push, store}) => ({
@@ -269,65 +338,15 @@ module.exports.traverse = ({push, store}) => ({
 });
 ```
 
-### Finder
-
-`Find plugins` gives you all the control over traversing, but it's the slowest format.
-Because `traversers` not merged in contrast with other plugin formats.
-
-```js
-module.exports.report = () => 'debugger statement should not be used';
-
-module.exports.fix = (path) => {
-    path.remove();
-};
-
-module.exports.find = (ast, {push, traverse}) => {
-    traverse(ast, {
-        'debugger'(path) {
-            push(path);
-        },
-    });
-};
-```
-
-## Example
-
-```js
-const {runPlugins} = require('@putout/engine-runner');
-const {parse} = require('@putout/engin-parser');
-
-const plugins = [{
-    rule: "remove-debugger",
-    msg: "",        // optional
-    options: {},    // optional
-    plugin: {
-        include: () => ['debugger'],
-        fix: (path) => path.remove(),
-        report: () => `debugger should not be used`,
-    },
-}];
-
-const ast = parse('const m = "hi"; debugger');
-const places = runPlugins({
-    ast,
-    shebang: false,     // default
-    fix: true,          // default
-    fixCount: 1,        // default
-    plugins,
-    parser: 'babel',    // default
-});
-```
-
 ## Logs
 
 To see logs, use:
 
-```sh
-DEBUG=putout:runner:*
-DEBUG=putout:runner:fix
-DEBUG=putout:runner:find
-DEBUG=putout:runner:template
-```
+- ✅ `DEBUG=putout:runner:*`
+- ✅ `DEBUG=putout:runner:fix`
+- ✅ `DEBUG=putout:runner:find`
+- ✅ `DEBUG=putout:runner:template`
+- ✅ `DEBUG=putout:runner:replace`
 
 ## License
 

package/lib/index.js

@@ -24,9 +24,7 @@ module.exports.runPlugins = ({ast, shebang, fix, fixCount, plugins, template = r
     const {
         pluginsFind,
         pluginsTraverse,
-    } = splitPlugins(plugins, {
-        template,
-    });
+    } = splitPlugins(plugins);
     
     for (let i = 0; i < fixCount; i++) {
         places = run({
@@ -130,23 +128,25 @@ function runWithoutMerge({ast, fix, shebang, template, pluginsFind}) {
     return places;
 }
 
-function splitPlugins(plugins, {template}) {
+function splitPlugins(plugins) {
     const pluginsFind = [];
     const pluginsTraverse = [];
     
     for (const item of plugins) {
         const {plugin} = item;
         
-        if (plugin.find)
+        if (plugin.find) {
             pluginsFind.push(item);
+            continue;
+        }
         
-        if (plugin.traverse)
+        if (plugin.traverse) {
             pluginsTraverse.push(item);
+            continue;
+        }
         
         if (plugin.replace) {
-            pluginsTraverse.push(include(replace(item, {
-                template,
-            })));
+            pluginsTraverse.push(include(replace(item)));
             continue;
         }
         

package/lib/replace/index.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const isString = (a) => typeof a === 'string';
+
 const {template} = require('@putout/engine-parser');
 const {
     remove,
@@ -11,10 +13,15 @@ const {
     getValues,
     setValues,
 } = require('@putout/compare');
+const debug = require('debug')('putout:runner:replace');
 
 const maybeArray = require('../maybe-array');
 const watermark = require('./watermark');
 
+const log = (from, path) => {
+    debug.enabled && debug(`${from} -> ${path}\n`);
+};
+
 const {keys, entries} = Object;
 const {stringify} = JSON;
 
@@ -23,13 +30,6 @@ const stubMatch = () => ({});
 const packKeys = (a) => () => keys(a);
 const isObj = (a) => typeof a === 'object';
 
-const validateTemplateValues = (a, b) => {
-    for (const key of keys(a)) {
-        if (!b[key])
-            throw Error(`☝️ Looks like template values not linked: ${stringify(keys(b))} -> ${stringify(keys(a))}`);
-    }
-};
-
 module.exports = ({rule, plugin, msg, options}) => {
     const {
         report,
@@ -89,8 +89,10 @@ const fix = (from, to, path) => {
     
     const nodeTo = parseTo(to, values, path);
     
-    if (!nodeTo)
+    if (!nodeTo) {
+        log(from, `''`);
         return remove(path);
+    }
     
     const waysTo = findVarsWays(nodeTo);
     const newPath = replaceWith(path, nodeTo);
@@ -105,7 +107,8 @@ const fix = (from, to, path) => {
     
     mark.add();
     path.scope.getBlockParent().crawl();
-    path.scope.getProgramParent().crawl();
+    
+    log(from, newPath);
 };
 
 const getFix = (items) => (path) => {
@@ -116,7 +119,7 @@ const getFix = (items) => (path) => {
 const getFilter = (match = stubMatch, options) => (path) => {
     const all = entries(match({options}));
     
-    for (const [from, fn] of all) {
+    for (const [from, matchProperty] of all) {
         const nodeFrom = template.ast(from);
         
         if (!compare(path.node, nodeFrom)) {
@@ -131,7 +134,9 @@ const getFilter = (match = stubMatch, options) => (path) => {
             node,
         });
         
-        return fn(values, path);
+        validateMatchProperty(matchProperty);
+        
+        return matchProperty(values, path);
     }
     
     return true;
@@ -143,9 +148,24 @@ function parseTo(to, values, path) {
     if (!toStr)
         return null;
     
-    if (isObj(toStr))
+    if (isObj(toStr) && toStr.type)
         return toStr;
     
+    if (!isString(toStr))
+        throw Error(`☝️ Looks like you passed 'replace' value with a wrong type. Allowed: 'string', 'node' and 'path'. Received: '${typeof toStr}' with value '${toStr}'.`);
+    
     return template.ast.fresh(toStr);
 }
 
+function validateMatchProperty(match) {
+    if (!isFn(match))
+        throw Error(`☝️ Looks like 'match' property value is not a 'function', but '${typeof match}' with value '${match}'.`);
+}
+
+const validateTemplateValues = (a, b) => {
+    for (const key of keys(a)) {
+        if (!b[key])
+            throw Error(`☝️ Looks like template values not linked: ${stringify(keys(b))} -> ${stringify(keys(a))}`);
+    }
+};
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/engine-runner",
-  "version": "12.3.0",
+  "version": "12.6.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "run putout plugins",