feature: @putout/plugin-putout: convert-include-to-traverse: add

Author: coderaiser

packages/plugin-putout/README.md

@@ -51,6 +51,7 @@ npm i @putout/plugin-putout -D
 - ✅ [convert-replace-with-multiple](#convert-replace-with-multiple);
 - ✅ [convert-report-to-function](#convert-report-to-function);
 - ✅ [convert-to-no-transform-code](#convert-to-no-transform-code);
+- ✅ [convert-include-to-traverse](#convert-include-to-traverse);
 - ✅ [convert-traverse-to-include](#convert-traverse-to-include);
 - ✅ [convert-traverse-to-replace](#convert-traverse-to-replace);
 - ✅ [convert-traverse-to-scan](#convert-traverse-to-scan);
@@ -104,6 +105,7 @@ npm i @putout/plugin-putout -D
         "putout/convert-babel-types": "on",
         "putout/convert-destructuring-to-identifier": "on",
         "putout/convert-node-to-path-in-get-template-values": "on",
+        "putout/convert-include-to-traverse": "on",
         "putout/convert-traverse-to-include": "on",
         "putout/convert-traverse-to-replace": "on",
         "putout/convert-traverse-to-scan": "on",
@@ -623,6 +625,26 @@ const parseOptions = require('putout/lib/parse-options');
 const parseOptions = require('putout/parse-options');
 ```
 
+## convert-include-to-traverse
+
+Checkout in 🐊[**Putout Editor*](https://putout.cloudcmd.io/#/gist/a41b5c943a74b59a6c18f31fc6d31937/d79c6084f49b6444536840bc2fc1fba725ba83f8).
+
+### ❌ Example of incorrect code
+
+```js
+export const include = () => ({
+    ClassDeclaration(path) {},
+});
+```
+
+### ✅ Example of correct code
+
+```js
+export const traverse = () => ({
+    ClassDeclaration(path) {},
+});
+```
+
 ## convert-traverse-to-include
 
 ### ❌ Example of incorrect code

packages/plugin-putout/lib/convert-include-to-traverse/fixture/convert-include-to-traverse-fix.js

@@ -0,0 +1,11 @@
+export const report = () => ``;
+
+export const fix = () => {};
+
+module.exports.traverse = () => ({
+    ClassDeclaration(path) {},
+});
+
+export const traverse = () => ({
+    ClassDeclaration(path) {},
+});

packages/plugin-putout/lib/convert-include-to-traverse/fixture/convert-include-to-traverse.js

@@ -0,0 +1,14 @@
+export const report = () => ``;
+
+export const fix = () => {
+}
+
+module.exports.include = () => ({
+    ClassDeclaration(path) {
+    }
+});
+
+export const include = () => ({
+    ClassDeclaration(path) {
+    }
+});

packages/plugin-putout/lib/convert-include-to-traverse/fixture/not-object.js

@@ -0,0 +1,6 @@
+module.exports.include = () => [
+    'ClassDeclaration',
+];
+export const include = () => [
+    'ClassDeclaration',
+];

packages/plugin-putout/lib/convert-include-to-traverse/index.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const {types} = require('putout');
+const {isObjectExpression} = types;
+
+module.exports.report = () => `Use 'traverse' instead of 'include'`;
+
+const check = ({__a}) => {
+    return isObjectExpression(__a.body);
+};
+
+module.exports.match = () => ({
+    'const include = __a': check,
+    'module.exports.include = __a': check,
+});
+
+module.exports.replace = () => ({
+    'const include = __a': 'const traverse = __a',
+    'module.exports.include = __a': 'module.exports.traverse = __a',
+});

packages/plugin-putout/lib/convert-include-to-traverse/index.spec.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const {createTest} = require('@putout/test');
+const plugin = require('.');
+
+const test = createTest(__dirname, {
+    printer: 'putout',
+    plugins: [
+        ['convert-include-to-traverse', plugin],
+    ],
+});
+
+test('putout: convert-include-to-traverse: report', (t) => {
+    t.report('convert-include-to-traverse', `Use 'traverse' instead of 'include'`);
+    t.end();
+});
+
+test('putout: convert-include-to-traverse: transform', (t) => {
+    t.transform('convert-include-to-traverse');
+    t.end();
+});
+
+test('putout: convert-include-to-traverse: no transform: not-object', (t) => {
+    t.noTransform('not-object');
+    t.end();
+});

packages/plugin-putout/lib/index.js

@@ -53,6 +53,7 @@ const simplifyReplaceTemplate = require('./simplify-replace-template');
 const removeEmptyArrayFromProcess = require('./remove-empty-array-from-process');
 const addPlacesToComparePlaces = require('./add-places-to-compare-places');
 const addPathArgToFix = require('./add-path-arg-to-fix');
+const convertIncludeToTraverse = require('./convert-include-to-traverse');
 
 module.exports.rules = {
     'apply-processors-destructuring': applyProcessorsDestructuring,
@@ -108,4 +109,5 @@ module.exports.rules = {
     'remove-empty-array-from-process': removeEmptyArrayFromProcess,
     'add-places-to-compare-places': addPlacesToComparePlaces,
     'add-path-arg-to-fix': addPathArgToFix,
+    'convert-include-to-traverse': convertIncludeToTraverse,
 };

packages/plugin-putout/test/fixture/convert-include-to-traverse-fix.js

@@ -0,0 +1,11 @@
+export const report = () => ``;
+
+export const fix = () => {};
+
+module.exports.traverse = () => ({
+    ClassDeclaration(path) {},
+});
+
+export const traverse = () => ({
+    ClassDeclaration(path) {},
+});

packages/plugin-putout/test/fixture/convert-include-to-traverse.js

@@ -0,0 +1,14 @@
+export const report = () => ``;
+
+export const fix = () => {
+}
+
+module.exports.include = () => ({
+    ClassDeclaration(path) {
+    }
+});
+
+export const include = () => ({
+    ClassDeclaration(path) {
+    }
+});

packages/plugin-putout/test/putout.js

@@ -262,3 +262,8 @@ test('plugin-putout: transform: add-path-arg-to-fix', (t) => {
     t.transform('add-path-arg-to-fix');
     t.end();
 });
+
+test('plugin-putout: transform: convert-include-to-traverse', (t) => {
+    t.transform('convert-include-to-traverse');
+    t.end();
+});