@putout/engine-runner 11.5.0 → 12.1.1

package/README.md

@@ -1,11 +1,9 @@
-# @putout/engine-runner [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL]
+# @putout/engine-runner [![NPM version][NPMIMGURL]][NPMURL]
 
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/engine-runner.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/engine-runner"npm"
-[DependencyStatusURL]: https://david-dm.org/coderaiser/putout?path=packages/engine-runner
-[DependencyStatusIMGURL]: https://david-dm.org/coderaiser/putout.svg?path=packages/engine-runner
 
-Run putout plugins.
+Run 🐊[`Putout`](https://github.com/coderaiser/putout) plugins.
 
 ## Install
 
@@ -17,7 +15,8 @@ npm i @putout/engine-runner
 
 ### 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:
 
@@ -172,34 +171,40 @@ module.exports.traverse = ({push}) => ({
 });
 ```
 
-#### listStore
+#### Storages
 
-To keep things during traverse in a safe way `listStore` can be used.
+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
+
+To keep things and save them as a list during traverse in a safe way `listStore` can be used for code:
 
 ```js
-module.exports.traverse = ({push, listStore}) => ({
+debugger;
+const hello = '';
+debugger;
+const world = '';
+```
+
+```js
+module.exports.traverse = ({listStore}) => ({
     'debugger'(path) {
         listStore('x');
-        push(path);
     },
     
     Program: {
         exit() {
             console.log(listStore());
             // returns
-            ['x', 'x', 'x'];
+            ['x', 'x'];
             // for code
-            'debugger; debugger; debugger';
+            'debugger; debugger';
         },
     },
 });
 ```
 
-`store` is preferred way of keeping array elements, because of caching of `putout`, `traverse` init function called only once, and any other way
-of handling variables will most likely will lead to bugs.
-
-#### Store
-
 When you need `key-value` storage `store` can be used.
 
 ```js
@@ -227,6 +232,43 @@ module.exports.traverse = ({push, store}) => ({
 });
 ```
 
+#### Upstore
+
+When you need to update already saved values, use `upstore`
+
+```js
+module.exports.traverse = ({push, store}) => ({
+    TSTypeAliasDeclaration(path) {
+        if (path.parentPath.isExportNamedDeclaration())
+            return;
+        
+        store(path.node.id.name, {
+            path,
+        });
+    },
+    
+    ObjectProperty(path) {
+        const {value} = path.node;
+        const {name} = value;
+        
+        store(name, {
+            used: true,
+        });
+    },
+    
+    Program: {
+        exit() {
+            for (const {path, used} of store()) {
+                if (used)
+                    continue;
+                
+                push(path);
+            }
+        },
+    },
+});
+```
+
 ### Finder
 
 `Find plugins` gives you all the control over traversing, but it's the slowest format.

package/lib/index.js

@@ -41,6 +41,8 @@ module.exports.runPlugins = ({ast, shebang, fix, fixCount, plugins, template = r
         
         if (!fix || !places.length)
             return places;
+        
+        replace.clearWatermark(ast);
     }
     
     return places;
@@ -120,6 +122,7 @@ function runWithoutMerge({ast, fix, shebang, template, pluginsFind}) {
                 path: item,
                 rule,
                 position,
+                options,
             });
         }
     }

package/lib/merge-visitors.js

@@ -6,7 +6,11 @@ const {generate} = require('@putout/engine-parser');
 const runFix = require('./run-fix');
 const {getPosition} = require('./get-position');
 const maybeArray = require('./maybe-array');
-const {listStore, mapStore} = require('./store');
+const {
+    listStore,
+    mapStore,
+    upStore,
+} = require('./store');
 
 const shouldSkip = (a) => !a.parent;
 const {merge} = traverse.visitors;
@@ -16,7 +20,7 @@ const parse = (name, plugin, options) => {
     const list = [];
     
     if (plugin[name])
-        list.push(...plugin[name]());
+        list.push(...maybeArray(plugin[name]()));
     
     if (options[name])
         list.push(...maybeArray(options[name]));
@@ -33,6 +37,7 @@ module.exports = (pluginsToMerge, {fix, shebang, template}) => {
             push,
             pull,
             store,
+            upstore,
             listStore,
         } = getStore(plugin, {
             fix,
@@ -48,6 +53,7 @@ module.exports = (pluginsToMerge, {fix, shebang, template}) => {
             push,
             store,
             listStore,
+            upstore,
             generate,
             options,
         });
@@ -82,13 +88,14 @@ module.exports = (pluginsToMerge, {fix, shebang, template}) => {
 function getStore(plugin, {fix, rule, shebang, msg, options}) {
     const store = mapStore();
     const list = listStore();
+    const upstore = upStore();
     const placesStore = listStore();
     
     const push = (path) => {
         const position = getPosition(path, shebang);
         const message = msg || plugin.report(path);
         
-        placesStore ({
+        placesStore({
             message,
             position,
         });
@@ -104,6 +111,7 @@ function getStore(plugin, {fix, rule, shebang, msg, options}) {
     const pull = () => {
         store.clear();
         list.clear();
+        upstore.clear();
         return placesStore.clear();
     };
     
@@ -112,6 +120,7 @@ function getStore(plugin, {fix, rule, shebang, msg, options}) {
         pull,
         store,
         listStore: list,
+        upstore,
     };
 }
 

package/lib/replace/index.js

@@ -26,7 +26,7 @@ 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(a))} ${stringify(keys(b))}`);
+            throw Error(`☝️ Looks like template values not linked: ${stringify(keys(b))} -> ${stringify(keys(a))}`);
     }
 };
 
@@ -61,6 +61,10 @@ module.exports = ({rule, plugin, msg, options}) => {
     };
 };
 
+module.exports.clearWatermark = (ast) => {
+    delete ast.program[watermark.REPLACE_WATERMARK];
+};
+
 const isFn = (a) => typeof a === 'function';
 
 const fix = (from, to, path) => {

package/lib/replace/watermark.js

@@ -30,6 +30,8 @@ module.exports = (from, to, path) => {
     };
 };
 
+module.exports.REPLACE_WATERMARK = name;
+
 module.exports.create = create;
 function create(from, to, path) {
     const watermark = `${from} -> ${to}`;
@@ -52,6 +54,7 @@ function init({path, program}) {
 module.exports.add = add;
 function add({path, program, watermark, highWatermark}) {
     init({path, program});
+    
     path.node[name].add(watermark);
     program.node[name].add(highWatermark);
 }

package/lib/store.js

@@ -5,7 +5,6 @@ const {
     entries,
     assign,
 } = Object;
-const isObject = (a) => typeof a === 'object';
 
 module.exports.listStore = (list = []) => {
     const fn = (...args) => {
@@ -27,33 +26,40 @@ module.exports.listStore = (list = []) => {
     return fn;
 };
 
-module.exports.mapStore = (map = {}) => {
-    const fn = (...args) => {
-        if (!args.length)
-            return values(map);
-        
-        const [name, data] = args;
+module.exports.mapStore = createStore({
+    set(map, name, data) {
+        map[name] = data;
+    },
+});
+
+module.exports.upStore = createStore({
+    set(map, name, data) {
+        map[name] = map[name] || {};
+        assign(map[name], data);
+    },
+});
+
+function createStore({set}) {
+    return (map = {}) => {
+        const fn = (...args) => {
+            if (!args.length)
+                return values(map);
+            
+            const [name, data] = args;
+            
+            if (args.length === 1)
+                return map[name];
+            
+            set(map, name, data);
+        };
         
-        if (args.length === 1)
-            return map[name];
+        fn.clear = () => {
+            map = {};
+        };
         
-        if (isObject(data)) {
-            map[name] = map[name] || {};
-            assign(map[name], data);
-            return;
-        }
+        fn.entries = () => entries(map);
         
-        map[name] = data;
+        return fn;
     };
-    
-    fn.clear = () => {
-        map = {};
-    };
-    
-    fn.entries = () => {
-        return entries(map);
-    };
-    
-    return fn;
-};
+}
 

package/lib/template/index.js

@@ -24,7 +24,7 @@ const {stringify} = JSON;
 module.exports._log = log;
 
 const exclude = ({rule, tmpl, fn, nodesExclude}) => {
-    if (!nodesExclude.length)
+    if (!isFn(fn) || !nodesExclude.length)
         return {
             [tmpl]: fn,
         };

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@putout/engine-runner",
-  "version": "11.5.0",
+  "version": "12.1.1",
+  "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "run putout plugins",
-  "homepage": "http://github.com/coderaiser/putout",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/engine-runner#readme",
   "main": "lib/index.js",
   "release": false,
   "tag": false,
@@ -43,12 +44,13 @@
     "@babel/plugin-codemod-optional-catch-binding": "^7.7.4",
     "@cloudcmd/stub": "^3.0.0",
     "c8": "^7.5.0",
-    "eslint": "^8.0.0-beta.0",
+    "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^10.0.0",
+    "eslint-plugin-putout": "^12.0.0",
     "just-camel-case": "^4.0.2",
     "lerna": "^4.0.0",
     "madrun": "^8.0.1",
+    "mock-require": "^3.0.3",
     "montag": "^1.0.0",
     "nodemon": "^2.0.1",
     "putout": "*",