@putout/plugin-putout 10.2.0 → 11.1.0

package/README.md

@@ -3,7 +3,7 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-putout.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/plugin-putout"npm"
 
-🐊[`Putout`](https://github.com/coderaiser/putout) plugin helps with plugins development.
+🐊[**Putout**](https://github.com/coderaiser/putout) plugin helps with plugins development.
 
 ## Install
 
@@ -20,6 +20,7 @@ npm i @putout/plugin-putout -D
         "putout/apply-processors-destructuring": "on",
         "putout/apply-async-formatter": "on",
         "putout/add-args": "on",
+        "putout/add-push": "on",
         "putout/convert-putout-test-to-create-test": "on",
         "putout/convert-to-no-transform-code": "on",
         "putout/convert-replace-with": "on",
@@ -47,7 +48,7 @@ npm i @putout/plugin-putout -D
 
 ## apply-processors-destructuring
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 test('', async (t) => {
@@ -56,7 +57,7 @@ test('', async (t) => {
 
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 test('', async ({process}) => {
@@ -66,7 +67,7 @@ test('', async ({process}) => {
 
 ## apply-async-formatter
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 test('formatter: codeframea', (t) => {
@@ -75,7 +76,7 @@ test('formatter: codeframea', (t) => {
 });
 ```
 
-### ✅ Correct code example
+### ✅ Example of correct code
 
 ```js
 test('formatter: codeframea', async ({format}) => {
@@ -85,7 +86,7 @@ test('formatter: codeframea', async ({format}) => {
 
 ## apply-create-test
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 const test = require('@putout/test')({
@@ -93,7 +94,7 @@ const test = require('@putout/test')({
 });
 ```
 
-### ✅ Correct code example
+### ✅ Example of correct code
 
 ```js
 const {createTest} = require('@putout/test');
@@ -102,11 +103,11 @@ const test = createTest({
 });
 ```
 
-## convert-putout-test-to-create-test"
+## convert-putout-test-to-create-test
 
 Fixes results of [@putout/convert-commonjs-to-esm](https://github.com/coderaiser/putout/tree/master/packages/plugin-convert-commonjs-to-esm) work.
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 import putoutTest from '@putout/test';
@@ -116,7 +117,7 @@ const test = putoutTest(__dirname, {
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 import createTest from '@putout/test';
@@ -128,7 +129,7 @@ const test = createTest(__dirname, {
 
 ## convert-to-no-transform-code
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 test('plugin-apply-destructuring: transform: array: destructuring', (t) => {
@@ -139,7 +140,7 @@ test('plugin-apply-destructuring: transform: array: destructuring', (t) => {
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 test('plugin-apply-destructuring: transform: array: destructuring', (t) => {
@@ -152,7 +153,7 @@ test('plugin-apply-destructuring: transform: array: destructuring', (t) => {
 
 ## convert-replace-with
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.fix = (path) => {
@@ -160,7 +161,7 @@ module.exports.fix = (path) => {
 };
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 const {replaceWith} = require('putout').operator;
@@ -172,7 +173,7 @@ module.exports.fix = (path) => {
 
 ## convert-replace-with-multiple
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.fix = (path) => {
@@ -180,7 +181,7 @@ module.exports.fix = (path) => {
 };
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 const {replaceWithMultiple} = require('putout').operator;
@@ -192,7 +193,7 @@ module.exports.fix = (path) => {
 
 ## convert-replace-to-function
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.replace = {
@@ -200,7 +201,7 @@ module.exports.replace = {
 };
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 module.exports.replace = () => ({
@@ -210,7 +211,7 @@ module.exports.replace = () => ({
 
 ## convert-match-to-function
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.match = {
@@ -218,7 +219,7 @@ module.exports.match = {
 };
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 module.exports.match = () => ({
@@ -228,7 +229,7 @@ module.exports.match = () => ({
 
 ## convert-babel-types
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 const {
@@ -239,7 +240,7 @@ const {
 } = require('@babel/types');
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 const {
@@ -252,7 +253,7 @@ const {
 
 ## convert-to-no-transform-code
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.replace = () => ({
@@ -263,7 +264,7 @@ module.exports.replace = () => ({
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 module.exports.replace = () => ({
@@ -276,13 +277,13 @@ module.exports.replace = () => ({
 
 ## convert-node-to-path-in-get-template-values
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 const {__a, __b} = getTemplateValues(path.node, 'const __a = __b');
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 const {__a, __b} = getTemplateValues(path, 'const __a = __b');
@@ -290,13 +291,13 @@ const {__a, __b} = getTemplateValues(path, 'const __a = __b');
 
 ## shorten-imports
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 const parseOptions = require('putout/lib/parse-options');
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 const parseOptions = require('putout/parse-options');
@@ -304,7 +305,7 @@ const parseOptions = require('putout/parse-options');
 
 ## convert-traverse-to-include
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.traverse = ({push}) => ({
@@ -314,7 +315,7 @@ module.exports.traverse = ({push}) => ({
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 module.exports.include = () => [
@@ -324,7 +325,7 @@ module.exports.include = () => [
 
 ## convert-traverse-to-replace
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.traverse = () => ({
@@ -332,7 +333,7 @@ module.exports.traverse = () => ({
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 module.exports.replace = () => ({
@@ -342,14 +343,14 @@ module.exports.replace = () => ({
 
 ## convert-process-to-find
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.preProcess = () => {};
 module.exports.postProcess = () => {};
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 module.exports.branch = (rawSource) => [];
@@ -361,7 +362,7 @@ module.exports.merge = (processedSource, list) => '';
 - property simpler to work with;
 - support of `convert-destructuring-to-identifier` which is `Replacer`, while `convert-method-to-property` is `Includer` (searches for `ObjectMethod` node);
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.match = () => ({
@@ -370,7 +371,7 @@ module.exports.match = () => ({
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 module.exports.match = () => ({
@@ -383,7 +384,7 @@ module.exports.match = () => ({
 
 Checks that [Replacer](https://github.com/coderaiser/putout/tree/master/packages/engine-runner#replacer) transform is possible.
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.replace = () => ({
@@ -399,14 +400,14 @@ This is additional tests, if you forget to test some case (from a big list of ru
 Depend on [@putout/convert-esm-to-commonjs](https://github.com/coderaiser/putout/tree/master/packages/plugin-convert-esm-to-commonjs) and
 [@putout/declare-undefined-variables](https://github.com/coderaiser/putout/tree/master/packages/plugin-declare-undefined-variables)
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 compare(a, 'const __a = __b');
 isIdentifier(a);
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 const {operator, types} = require('putout');
@@ -419,7 +420,7 @@ isIdentifier(a);
 
 ## add-args
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 test('', () => {
@@ -427,7 +428,7 @@ test('', () => {
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 test('', ({comparePlaces}) => {
@@ -435,6 +436,28 @@ test('', ({comparePlaces}) => {
 });
 ```
 
+## add-push
+
+### ❌ Example of incorrect code
+
+```js
+module.exports.traverse = () => ({
+    '__a.replace(/__b/g, __c)': (path) => {
+        push(path);
+    },
+});
+```
+
+### ✅ Example of correct code
+
+```js
+module.exports.traverse = ({push}) => ({
+    '__a.replace(/__b/g, __c)': (path) => {
+        push(path);
+    },
+});
+```
+
 ## convert-add-argument-to-add-args
 
 ```js
@@ -446,7 +469,7 @@ module.exports = addArgument({
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 const {operator} = require('putout');
@@ -470,7 +493,7 @@ const test = createTest(__dirname, {
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 import {createTest} from '@putout/test';
@@ -492,7 +515,7 @@ const test = createTest(import.meta.url, {
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 const {createTest} = require('@putout/test');
@@ -505,7 +528,7 @@ const test = createTest(import.meta.url, {
 
 ## move-require-on-top-level
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 const test = require('@putout/test')(__dirname, {
@@ -520,7 +543,7 @@ test('remove debugger: report', (t) => {
 });
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 const removeDebugger = require('..');
@@ -538,7 +561,7 @@ test('remove debugger: report', (t) => {
 
 ## includer
 
-### ❌ Incorrect code example
+### ❌ Example of incorrect code
 
 ```js
 module.exports.include = () => 'cons __a = __b';
@@ -551,7 +574,7 @@ module.exports.include = ['cons __a = __b'];
 module.exports.exclude = ['var __a = __b'];
 ```
 
-### ✅ Correct code Example
+### ✅ Example of correct code
 
 ```js
 module.exports.include = () => ['cons __a = __b'];

package/lib/add-push/index.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const {
+    types,
+    operator,
+} = require('putout');
+
+const {traverse} = operator;
+
+const {
+    ObjectProperty,
+    ObjectPattern,
+    Identifier,
+} = types;
+
+module.exports.report = () => `Add 'push' argument to 'traverse'`;
+
+module.exports.fix = (path) => {
+    const computed = false;
+    const shorthand = true;
+    const name = Identifier('push');
+    
+    path.node.right.params.push(ObjectPattern([
+        ObjectProperty(name, name, computed, shorthand),
+    ]));
+};
+
+module.exports.traverse = ({push}) => ({
+    'module.exports.traverse = (__args) => __': (traversePath) => {
+        const paramsPaths = traversePath.get('right.params');
+        
+        if (paramsPaths.length)
+            return;
+        
+        traverse(traversePath, {
+            'push(__)': () => {
+                push(traversePath);
+            },
+        });
+    },
+});

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

@@ -1,7 +1,10 @@
 'use strict';
 
 const {operator} = require('putout');
-const {contains} = operator;
+const {
+    contains,
+    traverse,
+} = operator;
 
 module.exports.report = () => 'Replacer should be used instead of Traverser (https://git.io/JqcMn)';
 
@@ -15,6 +18,9 @@ module.exports.match = () => ({
         if (withFix)
             return false;
         
+        if (hasPushCall(path))
+            return false;
+        
         if (!__args.length)
             return true;
         
@@ -22,6 +28,9 @@ module.exports.match = () => ({
             'push',
         ]);
         
+        if (withPush)
+            return false;
+        
         return !withPush;
     },
 });
@@ -30,3 +39,16 @@ module.exports.replace = () => ({
     'module.exports.traverse = (__args) => __a': 'module.exports.replace = (__args) => __a',
 });
 
+function hasPushCall(path) {
+    let is = false;
+    
+    traverse(path, {
+        'push(__a)': (path) => {
+            is = true;
+            path.stop();
+        },
+    });
+    
+    return is;
+}
+

package/lib/declare/operator.js

@@ -10,7 +10,7 @@ module.exports = {
     declare: `const {declare} = operator`,
     isSimpleRegExp: `const {isSimpleRegExp} = operator`,
     getTemplateValues: `const {getTemplateValues} = operator`,
-    addArgument: `const {addArgument} = operator`,
+    addArgs: `const {addArgs} = operator`,
     replaceWith: `const {replaceWith} = operator`,
     replaceWithMultiple: `const {replaceWithMultiple} = operator`,
     isESM: `const {isESM} = operator`,

package/lib/index.js

@@ -31,6 +31,7 @@ module.exports.rules = {
     ...getRule('check-replace-code'),
     ...getRule('declare'),
     ...getRule('add-args'),
+    ...getRule('add-push'),
     ...getRule('move-require-on-top-level'),
     ...getRule('includer'),
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-putout",
-  "version": "10.2.0",
+  "version": "11.1.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "putout plugin helps with plugins development",
@@ -36,22 +36,22 @@
     "putout"
   ],
   "devDependencies": {
-    "@putout/test": "^4.0.0",
+    "@putout/test": "^5.0.0",
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^13.0.0",
+    "eslint-plugin-putout": "^14.0.0",
     "lerna": "^4.0.0",
-    "madrun": "^8.0.1",
+    "madrun": "^9.0.0",
     "montag": "^1.2.1",
     "nodemon": "^2.0.1"
   },
   "peerDependencies": {
-    "putout": ">=24.2"
+    "putout": ">=25"
   },
   "license": "MIT",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "publishConfig": {
     "access": "public"