feature: @putout/plugin-putout: add-path-arg-to-visitors: add

Author: coderaiser

packages/plugin-putout/README.md

@@ -17,6 +17,7 @@ npm i @putout/plugin-putout -D
 - ✅ [add-index-to-import](#add-index-to-import);
 - ✅ [add-places-to-compare-places](#add-places-to-compare-places);
 - ✅ [add-path-arg-to-fix](#add-path-arg-to-fix);
+- ✅ [add-path-arg-to-visitors](#add-path-arg-to-visitors);
 - ✅ [add-test-args](#add-test-args);
 - ✅ [add-traverse-args](#add-traverse-args);
 - ✅ [add-track-file](#add-track-file);
@@ -76,6 +77,7 @@ npm i @putout/plugin-putout -D
     "rules": {
         "putout/add-places-to-compare-places": "on",
         "putout/add-path-arg-to-fix": "on",
+        "putout/add-path-arg-to-visitors": "on",
         "putout/add-test-args": "on",
         "putout/add-traverse-args": "on",
         "putout/add-track-file": "on",
@@ -866,6 +868,30 @@ export const fix = (path) => {
 };
 ```
 
+## add-path-arg-to-visitors
+
+Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/e20eb16668b2ebbceca1a03cde859e93/fee08d6dbb6aa4d835adacc8e9de4d994fd34848).
+
+### ❌ Example of incorrect code
+
+```js
+export const traverse = () => ({
+    TSUnionType() {
+        console.log(path);
+    },
+});
+```
+
+### ✅ Example of correct code
+
+```js
+export const traverse = () => ({
+    TSUnionType(path) {
+        console.log(path);
+    },
+});
+```
+
 ## add-test-args
 
 ### ❌ Example of incorrect code

packages/plugin-putout/lib/add-path-arg-to-visitors/fixture/add-path-arg-to-visitors-fix.js

@@ -0,0 +1,18 @@
+export const traverse = () => ({
+    TSUnionType(path) {
+        console.log(path);
+    },
+});
+
+module.exports.traverse = () => ({
+    TSUnionType(path) {
+        console.log(path);
+    },
+});
+
+module.exports.traverse = () => ({
+    [`export const traverse = ${TRAVERSE}`]: traverseMethods({
+        where: 'declaration.declarations.0.init',
+        push,
+    }),
+});

packages/plugin-putout/lib/add-path-arg-to-visitors/fixture/add-path-arg-to-visitors.js

@@ -0,0 +1,20 @@
+export const traverse = () => ({
+    TSUnionType() {
+        console.log(path);
+    }
+});
+
+
+module.exports.traverse = () => ({
+    TSUnionType() {
+        console.log(path);
+    }
+});
+
+
+module.exports.traverse = () => ({
+    [`export const traverse = ${TRAVERSE}`]: traverseMethods({
+        where: 'declaration.declarations.0.init',
+        push,
+    }),
+});

packages/plugin-putout/lib/add-path-arg-to-visitors/fixture/not-referenced.js

@@ -0,0 +1,4 @@
+ export const traverse = () => ({
+     'module.exports = __a'(path) {
+     }
+ });

packages/plugin-putout/lib/add-path-arg-to-visitors/fixture/property-fix.js

@@ -0,0 +1,5 @@
+export const traverse = () => ({
+    'module.exports = __a': (path) => {
+        console.log(path);
+    },
+});

packages/plugin-putout/lib/add-path-arg-to-visitors/fixture/property.js

@@ -0,0 +1,5 @@
+ export const traverse = () => ({
+     'module.exports = __a': () => {
+         console.log(path);
+     }
+ });

packages/plugin-putout/lib/add-path-arg-to-visitors/index.js

@@ -0,0 +1,46 @@
+'use strict';
+
+const {types} = require('putout');
+const {Identifier} = types;
+
+module.exports.report = () => `Add 'path' argument to 'traverse' visitors`;
+
+const TRAVERSE = '(__args) => __object';
+
+module.exports.fix = (path) => {
+    path.node.params.push(Identifier('path'));
+};
+
+module.exports.traverse = ({push}) => ({
+    [`export const traverse = ${TRAVERSE}`]: traverseMethods({
+        where: 'declaration.declarations.0.init',
+        push,
+    }),
+    [`module.exports.traverse = ${TRAVERSE}`]: traverseMethods({
+        where: 'right',
+        push,
+    }),
+});
+
+const traverseMethods = ({where, push}) => (path) => {
+    const initPath = path.get(where);
+    const objectPath = initPath.get('body');
+    
+    for (let prop of objectPath.get('properties')) {
+        if (prop.isObjectProperty())
+            prop = prop.get('value');
+        
+        if (!prop.isFunction())
+            continue;
+        
+        if (prop.node.params.length)
+            continue;
+        
+        prop.traverse({
+            ReferencedIdentifier(path) {
+                if (path.node.name === 'path')
+                    push(prop);
+            },
+        });
+    }
+};

packages/plugin-putout/lib/add-path-arg-to-visitors/index.spec.js

@@ -0,0 +1,30 @@
+'use strict';
+
+const {createTest} = require('@putout/test');
+const plugin = require('.');
+
+const test = createTest(__dirname, {
+    plugins: [
+        ['add-path-arg-to-visitors', plugin],
+    ],
+});
+
+test('putout: add-path-arg-to-visitors: report', (t) => {
+    t.report('add-path-arg-to-visitors', `Add 'path' argument to 'traverse' visitors`);
+    t.end();
+});
+
+test('putout: add-path-arg-to-visitors: transform', (t) => {
+    t.transform('add-path-arg-to-visitors');
+    t.end();
+});
+
+test('putout: add-path-arg-to-visitors: transform: property', (t) => {
+    t.transform('property');
+    t.end();
+});
+
+test('putout: add-path-arg-to-visitors: no report: not referenced', (t) => {
+    t.noReport('not-referenced');
+    t.end();
+});

packages/plugin-putout/lib/index.js

@@ -55,6 +55,7 @@ const addPlacesToComparePlaces = require('./add-places-to-compare-places');
 const addPathArgToFix = require('./add-path-arg-to-fix');
 const convertIncludeToTraverse = require('./convert-include-to-traverse');
 const removeUselessPrinterOption = require('./remove-useless-printer-option');
+const addPathArgToVisitors = require('./add-path-arg-to-visitors');
 
 module.exports.rules = {
     'apply-processors-destructuring': applyProcessorsDestructuring,
@@ -112,4 +113,5 @@ module.exports.rules = {
     'add-path-arg-to-fix': addPathArgToFix,
     'convert-include-to-traverse': convertIncludeToTraverse,
     'remove-useless-printer-option': removeUselessPrinterOption,
+    'add-path-arg-to-visitors': addPathArgToVisitors,
 };

packages/plugin-putout/test/fixture/add-path-arg-to-visitors-fix.js

@@ -0,0 +1,18 @@
+export const traverse = () => ({
+    TSUnionType(path) {
+        console.log(path);
+    },
+});
+
+module.exports.traverse = () => ({
+    TSUnionType(path) {
+        console.log(path);
+    },
+});
+
+module.exports.traverse = ({push}) => ({
+    [`export const traverse = ${TRAVERSE}`]: traverseMethods({
+        where: 'declaration.declarations.0.init',
+        push,
+    }),
+});