@putout/engine-runner 13.6.0 → 14.0.1

package/README.md

@@ -65,6 +65,8 @@ module.exports.report = () => 'debugger should not be used';
 module.exports.replace = () => ({
     debugger: '',
 });
+
+// debugger; alert(); -> alert();
 ```
 
 Templates:
@@ -75,6 +77,8 @@ module.exports.report = () => 'any message here';
 module.exports.replace = () => ({
     'var __a = 1': 'const __a = 1',
 });
+
+// var x = 1; -> const x = 1;
 ```
 
 A couple variables example:
@@ -85,6 +89,8 @@ module.exports.report = () => 'any message here';
 module.exports.replace = () => ({
     'const __a = __b': 'const __b = __a',
 });
+
+// const hello = world; -> const world = hello;
 ```
 
 #### Processing of node using functions
@@ -102,6 +108,8 @@ module.exports.replace = () => ({
         return '';
     },
 });
+
+// for (a of b) {}; alert(); -> alert();
 ```
 
 Update node:
@@ -111,11 +119,13 @@ module.exports.report = () => 'any message here';
 
 module.exports.replace = () => ({
     'for (const __a of __array) __c': ({__a, __array, __c}, path) => {
-        // update __array elements count
+        // update __array elements
         path.node.right.elements = [];
         return path;
     },
 });
+
+// for (const a of [1, 2, 3]) {}; -> for (const a of []) {};
 ```
 
 Update node using template variables:
@@ -129,6 +139,8 @@ module.exports.replace = () => ({
         return 'for (const x of y) z';
     },
 });
+
+// for (const item of array) {}; -> for (const x of y) z;
 ```
 
 ### Includer
@@ -224,8 +236,8 @@ const ast = parse('const m = "hi"; debugger');
 const places = runPlugins({
     ast,
     shebang: false, // default
-    fix: true, // default
-    fixCount: 1, // default
+    fix: false, // default
+    fixCount: 0, // default
     plugins,
     parser: 'babel', // default
 });
@@ -234,9 +246,10 @@ const places = runPlugins({
 ## 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:
+of handling variables will most likely will lead to bugs. There is a couple store types:
 
 - ✅`listStore`;
+- ✅`pathStore`;
 - ✅`store`;
 - ✅`upstore`;
 - ✅`uplist`;
@@ -275,6 +288,34 @@ module.exports.traverse = ({listStore}) => ({
 });
 ```
 
+### `pathStore`
+
+When you want additional check that `path` not removed.
+
+```js
+debugger;
+const hello = '';
+```
+
+Let's process it!
+
+```js
+module.exports.traverse = ({pathStore}) => ({
+    'debugger'(path) {
+        pathStore(path);
+        path.remove();
+    },
+    
+    Program: {
+        exit() {
+            console.log(listStore());
+            // returns
+            [];
+        },
+    },
+});
+```
+
 ### `store`
 
 When you need `key-value` use `store`:
@@ -349,14 +390,14 @@ When you need to update named arrays:
 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;
+        const initPath = fullPath.get('declarations.0.init');
+        const {uid} = initPath.scope;
         
         if (isIdentifier(__a) || isCallExpression(__a)) {
             const {code} = generate(__a);
             const id = `${uid}-${code}`;
             
-            return uplist(id, path);
+            return uplist(id, initPath);
         }
     },
     'Program': {

package/lib/merge-visitors.js

@@ -11,6 +11,7 @@ const {
     mapStore,
     upStore,
     upListStore,
+    pathStore,
 } = require('./store');
 
 const shouldSkip = (a) => !a.parent;
@@ -40,6 +41,7 @@ module.exports = (pluginsToMerge, {fix, shebang, template}) => {
             store,
             upstore,
             listStore,
+            pathStore,
             uplist,
         } = getStore(plugin, {
             fix,
@@ -55,6 +57,7 @@ module.exports = (pluginsToMerge, {fix, shebang, template}) => {
             push,
             store,
             listStore,
+            pathStore,
             upstore,
             uplist,
             generate,
@@ -62,7 +65,7 @@ module.exports = (pluginsToMerge, {fix, shebang, template}) => {
         });
         
         if (!visitor)
-            throw Error(`Visitors cannot be empty in "${rule}"`);
+            throw Error(`☝️ Visitors cannot be empty in "${rule}"`);
         
         assign(options, {
             include: parse('include', plugin, options),
@@ -94,6 +97,7 @@ function getStore(plugin, {fix, rule, shebang, msg, options}) {
     const upstore = upStore();
     const placesStore = listStore();
     const uplist = upListStore();
+    const paths = pathStore();
     
     const push = (path) => {
         const position = getPosition(path, shebang);
@@ -117,6 +121,8 @@ function getStore(plugin, {fix, rule, shebang, msg, options}) {
         list.clear();
         upstore.clear();
         uplist.clear();
+        paths.clear();
+        
         return placesStore.clear();
     };
     
@@ -127,6 +133,7 @@ function getStore(plugin, {fix, rule, shebang, msg, options}) {
         listStore: list,
         upstore,
         uplist,
+        pathStore: paths,
     };
 }
 

package/lib/replace/index.js

@@ -1,8 +1,7 @@
 'use strict';
 
-const isString = (a) => typeof a === 'string';
-
 const {template} = require('@putout/engine-parser');
+
 const {
     remove,
     replaceWith,
@@ -14,9 +13,10 @@ const {
     setValues,
 } = require('@putout/compare');
 const debug = require('debug')('putout:runner:replace');
-
 const maybeArray = require('../maybe-array');
+
 const watermark = require('./watermark');
+const isString = (a) => typeof a === 'string';
 
 const log = (from, path) => {
     debug.enabled && debug(`${from} -> ${path}\n`);

package/lib/run-fix.js

@@ -4,7 +4,9 @@ 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 getPath = (path) => path.path || path;
 
 const tryToFix = (fix, {path, position, options}) => {
     const [e] = tryCatch(fix, path, {options});
@@ -26,7 +28,9 @@ module.exports = (is, fix, {path, rule, position, options}) => {
     if (!is)
         return;
     
-    enabled && debug(`fix: ${rule}`, position, path.toString());
+    if (enabled)
+        debug(`fix: ${rule}`, position, getPath(path).toString());
+    
     validate('fix', fix);
     
     tryToFix(fix, {

package/lib/store.js

@@ -7,26 +7,12 @@ const {
 } = Object;
 
 const toArray = (a) => Array.from(a);
+const isNotRemoved = (a) => a.node;
+const notRemoved = (a) => toArray(a).filter(isNotRemoved);
+const id = (a) => a;
 
-module.exports.listStore = (list = new Set()) => {
-    const fn = (...args) => {
-        if (!args.length)
-            return Array.from(list);
-        
-        const [a] = args;
-        list.add(a);
-        
-        return Array.from(list);
-    };
-    
-    fn.clear = () => {
-        const a = list;
-        list = new Set();
-        return Array.from(a);
-    };
-    
-    return fn;
-};
+module.exports.listStore = createListStore();
+module.exports.pathStore = createListStore(notRemoved);
 
 module.exports.mapStore = createStore({
     get(map) {
@@ -81,3 +67,23 @@ function createStore({set, get}) {
     };
 }
 
+function createListStore(returns = id) {
+    return (list = new Set()) => {
+        const fn = (...args) => {
+            if (!args.length)
+                return returns(toArray(list));
+            
+            const [a] = args;
+            list.add(a);
+        };
+        
+        fn.clear = () => {
+            const a = list;
+            list = new Set();
+            
+            return returns(toArray(a));
+        };
+        
+        return fn;
+    };
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@putout/engine-runner",
-  "version": "13.6.0",
+  "version": "14.0.1",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "run putout plugins",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/engine-runner#readme",
   "main": "lib/index.js",
+  "commitType": "colon",
   "release": false,
   "tag": false,
   "changelog": false,
@@ -44,10 +45,10 @@
     "@babel/plugin-codemod-optional-catch-binding": "^7.7.4",
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
-    "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^15.0.0",
+    "eslint-plugin-n": "^15.2.4",
+    "eslint-plugin-putout": "^16.0.0",
     "just-camel-case": "^4.0.2",
-    "lerna": "^4.0.0",
+    "lerna": "^5.0.0",
     "madrun": "^9.0.0",
     "mock-require": "^3.0.3",
     "montag": "^1.0.0",