@putout/engine-runner 13.0.0 → 13.2.0

package/README.md

@@ -3,7 +3,7 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/engine-runner.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/engine-runner"npm"
 
-Run 🐊[`Putout`](https://github.com/coderaiser/putout) plugins.
+Run 🐊[**Putout**](https://github.com/coderaiser/putout) plugins.
 
 ## Install
 
@@ -13,20 +13,20 @@ npm i @putout/engine-runner
 
 ## Supported Plugin Types
 
-There is a couple plugin types supported by 🐊`Putout`:
+There is a couple plugin types supported by 🐊**Putout**:
 
 - ✅[`Replacer`](#replacer)
 - ✅[`Includer`](#includer)
 - ✅[`Traverser`](#traverser)
 - ✅[`Finder`](#finder)
 
-All of them supports subset of `JavaScript` 🦎[`PutoutScript`](https://github.com/coderaiser/putout/blob/master/docs/putout-script.md#-putoutscript) described in [@putout/compare](https://github.com/coderaiser/putout/tree/master/packages/compare#readme).
+All of them supports subset of **JavaScript** 🦎[**PutoutScript**](https://github.com/coderaiser/putout/blob/master/docs/putout-script.md#-putoutscript) described in [`@putout/compare`](https://github.com/coderaiser/putout/tree/master/packages/compare#readme).
 
-They goes from simplest to hardest. Let's start from `Replacer`.
+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
+**Replacer** converts code in declarative way. Simplest possible form, no need to use `fix`. Just `from` and `to` parts
 according to [`template variables syntax`](https://github.com/coderaiser/putout/tree/master/packages/compare#supported-template-variables).
 
 Simplest replace example:
@@ -63,7 +63,7 @@ Simplest remove example:
 module.exports.report = () => 'debugger should not be used';
 
 module.exports.replace = () => ({
-    'debugger': '',
+    debugger: '',
 });
 ```
 
@@ -210,8 +210,8 @@ const {runPlugins} = require('@putout/engine-runner');
 const {parse} = require('@putout/engin-parser');
 
 const plugins = [{
-    rule: "remove-debugger",
-    msg: "",        // optional
+    rule: 'remove-debugger',
+    msg: '',        // optional
     options: {},    // optional
     plugin: {
         include: () => ['debugger'],
@@ -233,12 +233,13 @@ const places = runPlugins({
 
 ## Stores
 
-Stores is preferred way of keeping 🐊`Putout` data, `traverse` init function called only once, and any other way
+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:
 
 - ✅`listStore`;
 - ✅`store`;
 - ✅`upstore`;
+- ✅`uplist`;
 
 Let's talk about each of them.
 
@@ -340,6 +341,43 @@ module.exports.traverse = ({push, store}) => ({
 });
 ```
 
+### `uplist`
+
+When you need to update named arrays:
+
+```js
+module.exports.traverse = ({uplist, push}) => ({
+    'const __object = __a.__b': (fullPath) => {
+        const {__a, __b} = getTemplateValues(fullPath, 'const __object = __a.__b');
+        const path = fullPath.get('declarations.0.init');
+        const {uid} = path.scope;
+        
+        if (isIdentifier(__a) || isCallExpression(__a)) {
+            const {code} = generate(__a);
+            const id = `${uid}-${code}`;
+            
+            return uplist(id, path);
+        }
+    },
+    'Program': {
+        exit: () => {
+            for (const items of uplist()) {
+                if (items.length < 2)
+                    continue;
+                
+                const index = items.length - 1;
+                const path = items[index];
+                
+                push({
+                    path,
+                    items,
+                });
+            }
+        },
+    },
+});
+```
+
 ## Logs
 
 To see logs, use:

package/lib/include.js

@@ -17,8 +17,8 @@ module.exports = ({rule, plugin, msg, options}) => {
         filter = good,
     } = plugin;
     
-    if (!isFn(include))
-        throw Error(`☝️ Looks like "include" is not a function: ${stringify(include)}. More on using Includer: https://git.io/JqcMn`);
+    validate('include', include);
+    validate('report', report);
     
     const traverse = getTraverse(include(), filter, rule);
     
@@ -64,3 +64,7 @@ const getTraverse = (include, filter, rule) => ({push, options}) => {
     return result;
 };
 
+function validate(name, fn) {
+    if (!isFn(fn))
+        throw Error(`☝️ Looks like '${name}' is not a 'function' but '${typeof fn}' with value: '${stringify(fn)}'. More on using Includer: https://git.io/JqcMn`);
+}

package/lib/merge-visitors.js

@@ -10,6 +10,7 @@ const {
     listStore,
     mapStore,
     upStore,
+    upListStore,
 } = require('./store');
 
 const shouldSkip = (a) => !a.parent;
@@ -39,6 +40,7 @@ module.exports = (pluginsToMerge, {fix, shebang, template}) => {
             store,
             upstore,
             listStore,
+            uplist,
         } = getStore(plugin, {
             fix,
             rule,
@@ -54,6 +56,7 @@ module.exports = (pluginsToMerge, {fix, shebang, template}) => {
             store,
             listStore,
             upstore,
+            uplist,
             generate,
             options,
         });
@@ -90,6 +93,7 @@ function getStore(plugin, {fix, rule, shebang, msg, options}) {
     const list = listStore();
     const upstore = upStore();
     const placesStore = listStore();
+    const uplist = upListStore();
     
     const push = (path) => {
         const position = getPosition(path, shebang);
@@ -121,6 +125,7 @@ function getStore(plugin, {fix, rule, shebang, msg, options}) {
         store,
         listStore: list,
         upstore,
+        uplist,
     };
 }
 

package/lib/run-fix.js

@@ -3,6 +3,8 @@
 const tryCatch = require('try-catch');
 const debug = require('debug')('putout:runner:fix');
 const {enabled} = debug;
+const {stringify} = JSON;
+const isFn = (a) => typeof a === 'function';
 
 const tryToFix = (fix, {path, position, options}) => {
     const [e] = tryCatch(fix, path, {options});
@@ -25,6 +27,7 @@ module.exports = (is, fix, {path, rule, position, options}) => {
         return;
     
     enabled && debug(`fix: ${rule}`, position, path.toString());
+    validate('fix', fix);
     
     tryToFix(fix, {
         path,
@@ -33,3 +36,8 @@ module.exports = (is, fix, {path, rule, position, options}) => {
     });
 };
 
+function validate(name, fn) {
+    if (!isFn(fn))
+        throw Error(`☝️ Looks like '${name}' is not a 'function' but '${typeof fn}' with value: '${stringify(fn)}'. More on writing 🐊Putout Plugins: https://git.io/JqcMn`);
+}
+

package/lib/store.js

@@ -6,6 +6,8 @@ const {
     assign,
 } = Object;
 
+const toArray = (a) => Array.from(a);
+
 module.exports.listStore = (list = []) => {
     const fn = (...args) => {
         if (!args.length)
@@ -27,23 +29,39 @@ module.exports.listStore = (list = []) => {
 };
 
 module.exports.mapStore = createStore({
+    get(map) {
+        return values(map);
+    },
     set(map, name, data) {
         map[name] = data;
     },
 });
 
 module.exports.upStore = createStore({
+    get(map) {
+        return values(map);
+    },
     set(map, name, data) {
         map[name] = map[name] || {};
         assign(map[name], data);
     },
 });
 
-function createStore({set}) {
+module.exports.upListStore = createStore({
+    get(map) {
+        return values(map).map(toArray);
+    },
+    set(map, name, data) {
+        map[name] = map[name] || new Set();
+        map[name].add(data);
+    },
+});
+
+function createStore({set, get}) {
     return (map = {}) => {
         const fn = (...args) => {
             if (!args.length)
-                return values(map);
+                return get(map);
             
             const [name, data] = args;
             

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/engine-runner",
-  "version": "13.0.0",
+  "version": "13.2.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "run putout plugins",
@@ -26,7 +26,7 @@
   "dependencies": {
     "@babel/traverse": "^7.12.7",
     "@babel/types": "^7.12.7",
-    "@putout/compare": "^8.0.0",
+    "@putout/compare": "^9.0.0",
     "@putout/engine-parser": "^5.0.0",
     "@putout/operate": "^7.0.0",
     "debug": "^4.1.1",