@putout/plugin-putout 16.9.0 → 17.0.0

package/README.md

@@ -43,6 +43,7 @@ npm i @putout/plugin-putout -D
         "putout/convert-node-to-path-in-get-template-values": "on",
         "putout/convert-traverse-to-include": "on",
         "putout/convert-traverse-to-replace": "on",
+        "putout/convert-traverse-to-scan": "on",
         "putout/convert-process-to-find": "on",
         "putout/convert-method-to-property": "on",
         "putout/convert-add-argument-to-add-args": "on",
@@ -583,6 +584,49 @@ module.exports.replace = () => ({
 });
 ```
 
+## convert-traverse-to-scan
+
+Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/afe988c8e53ae70e50bf26512672f3cd/a6677d53b996e85880a4af18250c00e849322bbe).
+
+### ❌ Example of incorrect code
+
+```js
+module.exports.traverse = ({push, options}) => ({
+    [__filesystem](path) {
+        const {names} = options;
+        
+        for (const name of names) {
+            const files = findFile(path, name);
+            
+            for (const file of files) {
+                push({
+                    name,
+                    path: file,
+                });
+            }
+        }
+    },
+});
+```
+
+### ✅ Example of correct code
+
+```js
+module.exports.scan = (path, {push, options}) => {
+    const {names} = options;
+    
+    for (const name of names) {
+        const files = findFile(path, name);
+        
+        for (const file of files) {
+            push(file, {
+                name,
+            });
+        }
+    }
+};
+```
+
 ## convert-process-to-find
 
 ### ❌ Example of incorrect code

package/lib/convert-get-rule-to-require/index.js

@@ -17,6 +17,7 @@ const {
     ObjectProperty,
     Identifier,
     StringLiteral,
+    ArrayExpression,
 } = types;
 
 module.exports.report = () => `Use top-level 'require()' instead of '...getRule()'`;
@@ -27,14 +28,8 @@ const createRequire = template(REQUIRE, {
 });
 
 module.exports.match = () => ({
-    'getRule(__a)': ({__a}, path) => {
-        const name = __a.value;
-        
-        if (!path.parentPath.isSpreadElement())
-            return false;
-        
-        return !path.scope.getAllBindings()[name];
-    },
+    'getRule(__a)': match,
+    'getRule(__a, __b)': match,
 });
 
 module.exports.replace = () => ({
@@ -45,23 +40,26 @@ module.exports.replace = () => ({
         
         replaceWith(path.parentPath, node);
         
-        const programPath = path.scope.getProgramParent().path;
-        const body = programPath.get('body');
-        const [first] = body;
-        
-        const nodeRequire = createRequire({
-            __a: id,
-            __b: StringLiteral(`./${__a.value}`),
+        addRequire({
+            __a,
+            id,
+            path,
         });
         
-        if (compare(first, REQUIRE)) {
-            const latest = getLatest(body.slice(1));
-            insertBefore(latest, nodeRequire);
-            
-            return path;
-        }
+        return path;
+    },
+    'getRule(__a, __b)': ({__a, __b}, path) => {
+        const name = camel(__a.value);
+        const id = Identifier(name);
+        const node = ObjectProperty(__a, ArrayExpression([__b, id]));
+        
+        replaceWith(path.parentPath, node);
         
-        programPath.node.body.unshift(nodeRequire);
+        addRequire({
+            __a,
+            id,
+            path,
+        });
         
         return path;
     },
@@ -76,3 +74,32 @@ function getLatest(body) {
     
     return path;
 }
+
+function addRequire({__a, id, path}) {
+    const programPath = path.scope.getProgramParent().path;
+    const body = programPath.get('body');
+    const [first] = body;
+    
+    const nodeRequire = createRequire({
+        __a: id,
+        __b: StringLiteral(`./${__a.value}`),
+    });
+    
+    if (compare(first, REQUIRE)) {
+        const latest = getLatest(body.slice(1));
+        insertBefore(latest, nodeRequire);
+        
+        return path;
+    }
+    
+    programPath.node.body.unshift(nodeRequire);
+}
+
+function match({__a}, path) {
+    const name = __a.value;
+    
+    if (!path.parentPath.isSpreadElement())
+        return false;
+    
+    return !path.scope.getAllBindings()[name];
+}

package/lib/convert-traverse-to-scan/index.js

@@ -0,0 +1,128 @@
+'use strict';
+
+const {operator, types} = require('putout');
+const {
+    traverse,
+    remove,
+    rename,
+    getProperty,
+    replaceWith,
+    compare,
+} = operator;
+
+const {
+    Identifier,
+    isReturnStatement,
+    isObjectMethod,
+    isObjectProperty,
+    isObjectExpression,
+} = types;
+
+module.exports.report = () => `Use Scanner instead of Traverser`;
+
+module.exports.fix = ({path, pathProperty}) => {
+    if (path.isObjectMethod()) {
+        replaceWith(path.parentPath, path.get('body'));
+        path.parentPath.parentPath.node.params.unshift(Identifier('path'));
+        
+        path.parentPath.parentPath.parentPath.node.left.property.name = 'scan';
+        return;
+    }
+    
+    if (path.isObjectProperty()) {
+        replaceWith(path.parentPath, path.get('value.body'));
+        path.parentPath.parentPath.node.params.unshift(Identifier('path'));
+        
+        const {left} = path.parentPath.parentPath.parentPath.node;
+        
+        left.property.name = 'scan';
+        return;
+    }
+    
+    if (path.isCallExpression()) {
+        const {value} = pathProperty.node;
+        pathProperty.parentPath.parentPath.node.arguments.unshift(value);
+        
+        const {path: programPath} = path.scope.getProgramParent();
+        
+        traverse(programPath, {
+            'module.exports.fix = (__object) => __': (path) => {
+                const rightPath = path.get('right');
+                const [argPath] = rightPath.get('params');
+                
+                rightPath.node.params.unshift(value);
+                
+                const pathPropertyFix = getProperty(argPath, 'path');
+                rename(pathPropertyFix, 'path', value.name);
+                remove(pathPropertyFix);
+            },
+            'module.exports.report = (__object) => __': (path) => {
+                const rightPath = path.get('right');
+                const [argPath] = rightPath.get('params');
+                
+                rightPath.node.params.unshift(value);
+                
+                const pathPropertyFix = getProperty(argPath, 'path');
+                
+                if (pathPropertyFix) {
+                    rename(pathPropertyFix, 'path', value.name);
+                    remove(pathPropertyFix);
+                }
+            },
+        });
+        
+        remove(pathProperty);
+    }
+};
+
+module.exports.traverse = ({push}) => ({
+    'ObjectMethod|ObjectProperty'(path) {
+        if (!isFilesystemPath(path))
+            return;
+        
+        push({
+            path,
+        });
+    },
+    'push(__a)'(path) {
+        const __aPath = path.get('arguments.0');
+        
+        if (!__aPath.isObjectExpression())
+            return;
+        
+        if (path.find(isReturnStatement))
+            return;
+        
+        if (!path.find(isFilesystemPath) && !path.find(isScan))
+            return;
+        
+        const pathProperty = getProperty(__aPath, 'path');
+        
+        push({
+            path,
+            pathProperty,
+        });
+    },
+});
+
+function isScan(path) {
+    return compare(path, 'module.exports.scan = __');
+}
+
+function isFilesystemPath(path) {
+    if (!isObjectMethod(path) && !isObjectProperty(path))
+        return false;
+    
+    if (isObjectExpression(path.parentPath) && path.parentPath.node.properties.length > 1)
+        return false;
+    
+    const {computed} = path.node;
+    
+    if (!computed)
+        return false;
+    
+    if (path.node.key.name !== '__filesystem')
+        return false;
+    
+    return !path.parentPath.parentPath.isReturnStatement();
+}

package/lib/declare/get-rule.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const getRule = (name, options) => {
+    const plugin = require(`./${name}`);
+    const pluginWithOptions = !options ? plugin : [options, plugin];
+    
+    return {
+        [name]: pluginWithOptions,
+    };
+};
+
+module.exports.getRule = getRule;

package/lib/declare/index.js

@@ -2,10 +2,7 @@
 
 const types = require('./types');
 const operator = require('./operator');
-
-const getRule = (a) => ({
-    [a]: require(`./${a}`),
-});
+const {getRule} = require('./get-rule');
 
 module.exports.declare = () => ({
     template: `import {template} from 'putout'`,

package/lib/index.js

@@ -22,6 +22,7 @@ const convertBabelTypes = require('./convert-babel-types');
 const convertNodeToPathInGetTemplateValues = require('./convert-node-to-path-in-get-template-values');
 const convertTraverseToInclude = require('./convert-traverse-to-include');
 const convertTraverseToReplace = require('./convert-traverse-to-replace');
+const convertTraverseToScan = require('./convert-traverse-to-scan');
 const convertProcessToFind = require('./convert-process-to-find');
 const convertMethodToProperty = require('./convert-method-to-property');
 const convertAddArgumentToAddArgs = require('./convert-add-argument-to-add-args');
@@ -88,4 +89,5 @@ module.exports.rules = {
     'add-index-to-import': addIndexToImport,
     'apply-rename': applyRename,
     'apply-short-processors': applyShortProcessors,
+    'convert-traverse-to-scan': convertTraverseToScan,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-putout",
-  "version": "16.9.0",
+  "version": "17.0.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin helps with plugins development",
@@ -45,7 +45,8 @@
     "lerna": "^6.0.1",
     "madrun": "^9.0.0",
     "montag": "^1.2.1",
-    "nodemon": "^3.0.1"
+    "nodemon": "^3.0.1",
+    "supertape": "^8.7.0"
   },
   "peerDependencies": {
     "putout": ">=33"