@putout/plugin-putout 19.4.0 → 19.5.0

package/README.md

@@ -13,6 +13,59 @@ npm i @putout/plugin-putout -D
 
 ## Rules
 
+- ✅ [add-args](#add-args);
+- ✅ [add-await-to-progress](#add-await-to-progress);
+- ✅ [add-index-to-import](#add-index-to-import);
+- ✅ [add-push](#add-push);
+- ✅ [add-store](#add-store);
+- ✅ [add-track-file](#add-track-file);
+- ✅ [apply-async-formatter](#apply-async-formatter);
+- ✅ [apply-create-test](#apply-create-test);
+- ✅ [apply-declare](#apply-declare);
+- ✅ [apply-for-of-to-track-file](#apply-for-of-to-track-file);
+- ✅ [apply-insert-after](#apply-insert-after);
+- ✅ [apply-insert-before](#apply-insert-before);
+- ✅ [apply-namespace-specifier](#apply-namespace-specifier);
+- ✅ [apply-processors-destructuring](#apply-processors-destructuring);
+- ✅ [apply-remove](#apply-remove);
+- ✅ [apply-rename](#apply-rename);
+- ✅ [apply-short-processors](#apply-short-processors);
+- ✅ [check-match](#check-match);
+- ✅ [check-replace-code](#check-replace-code);
+- ✅ [convert-add-argument-to-add-args](#convert-add-argument-to-add-args);
+- ✅ [convert-babel-types](#convert-babel-types);
+- ✅ [convert-destructuring-to-identifier](#convert-destructuring-to-identifier);
+- ✅ [convert-dirname-to-url](#convert-dirname-to-url);
+- ✅ [convert-find-to-traverse](#convert-find-to-traverse);
+- ✅ [convert-get-rule-to-require](#convert-get-rule-to-require);
+- ✅ [convert-match-to-function](#convert-match-to-function);
+- ✅ [convert-method-to-property](#convert-method-to-property);
+- ✅ [convert-node-to-path-in-get-template-values](#convert-node-to-path-in-get-template-values);
+- ✅ [convert-number-to-numeric](#convert-number-to-numeric);
+- ✅ [convert-process-to-find](#convert-process-to-find);
+- ✅ [convert-progress-to-track-file](#convert-progress-to-track-file);
+- ✅ [convert-putout-test-to-create-test](#convert-putout-test-to-create-test);
+- ✅ [convert-replace-to-function](#convert-replace-to-function);
+- ✅ [convert-replace-with](#convert-replace-with);
+- ✅ [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-traverse-to-include](#convert-traverse-to-include);
+- ✅ [convert-traverse-to-replace](#convert-traverse-to-replace);
+- ✅ [convert-traverse-to-scan](#convert-traverse-to-scan);
+- ✅ [convert-url-to-dirname](#convert-url-to-dirname);
+- ✅ [create-test](#create-test);
+- ✅ [declare](#declare);
+- ✅ [includer](#includer);
+- ✅ [move-require-on-top-level](#move-require-on-top-level);
+- ✅ [remove-unused-get-properties-argument](#remove-unused-get-properties-argument);
+- ✅ [rename-operate-to-operator](#rename-operate-to-operator);
+- ✅ [replace-operate-with-operator](#replace-operate-with-operator);
+- ✅ [replace-test-message](#replace-test-message);
+- ✅ [shorten-imports](#shorten-imports);
+
+## Config
+
 ```json
 {
     "rules": {
@@ -29,6 +82,7 @@ npm i @putout/plugin-putout -D
         "putout/apply-for-of-to-track-file": "on",
         "putout/add-args": "on",
         "putout/add-push": "on",
+        "putout/add-store": "on",
         "putout/add-track-file": "on",
         "putout/add-await-to-progress": "on",
         "putout/add-index-to-import": "on",
@@ -781,6 +835,34 @@ module.exports.traverse = ({push}) => ({
 });
 ```
 
+## add-store
+
+### ❌ Example of incorrect code
+
+```js
+module.exports.traverse = () => ({
+    ImportDeclaration(path) {
+        const {node} = path;
+        const {name} = node.specifiers[0].local;
+        
+        store('name', name);
+    },
+});
+```
+
+### ✅ Example of correct code
+
+```js
+module.exports.traverse = ({store}) => ({
+    ImportDeclaration(path) {
+        const {node} = path;
+        const {name} = node.specifiers[0].local;
+        
+        store('name', name);
+    },
+});
+```
+
 ## add-await-to-progress
 
 Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/978d70945edfa369390ea059654ff04d/89225c04039b9c0e9057aad34852c9428264f119).

package/lib/add-arg.js

@@ -0,0 +1,103 @@
+'use strict';
+
+const {types, operator} = require('putout');
+const {traverse} = operator;
+
+const {
+    ObjectProperty,
+    ObjectPattern,
+    Identifier,
+} = types;
+
+module.exports = function addArg(name) {
+    return {
+        report: createReport(name),
+        fix: createFix(name),
+        traverse: createTraverse(name),
+    };
+};
+
+const createReport = (name) => () => `Add '${name}' argument to 'traverse'`;
+
+const createFix = (mainName) => ({fn}) => {
+    const computed = false;
+    const shorthand = true;
+    const name = Identifier(mainName);
+    const property = ObjectProperty(name, name, computed, shorthand);
+    
+    if (!fn.params.length) {
+        fn.params.push(ObjectPattern([property]));
+        return;
+    }
+    
+    fn.params[0].properties.push(property);
+};
+
+const createTraverse = (name) => ({push}) => {
+    const check = checkArgs(name, push);
+    
+    return {
+        'export const traverse = (__args) => __': check,
+        'module.exports.traverse = (__args) => __': check,
+    };
+};
+
+const isArgExists = (mainName, fn) => {
+    if (!fn.params.length)
+        return false;
+    
+    for (const prop of fn.params[0].properties) {
+        if (prop.key.name === mainName)
+            return true;
+    }
+    
+    return false;
+};
+
+const checkArgs = (mainName, push) => (path) => {
+    const fn = parseFn(path);
+    
+    if (isArgExists(mainName, fn))
+        return false;
+    
+    traverse(path, {
+        ReferencedIdentifier(path) {
+            if (path.node.name !== mainName)
+                return;
+            
+            if (isCallee(mainName, path))
+                return;
+            
+            push({
+                path,
+                fn,
+            });
+        },
+        [`${mainName}(__args)`]: (currentPath) => {
+            const bindings = currentPath.scope.getAllBindings();
+            
+            if (bindings[mainName])
+                return;
+            
+            push({
+                path,
+                fn,
+            });
+        },
+    });
+};
+
+function parseFn(path) {
+    if (path.isAssignmentExpression())
+        return path.get('right').node;
+    
+    return path.get('declaration.declarations.0.init').node;
+}
+
+function isCallee(name, {parentPath}) {
+    return parentPath
+        .get('callee')
+        .isIdentifier({
+            name,
+        });
+}

package/lib/add-push/index.js

@@ -1,76 +1,5 @@
 'use strict';
 
-const {types, operator} = require('putout');
-const {traverse} = operator;
-const {
-    ObjectProperty,
-    ObjectPattern,
-    Identifier,
-} = types;
+const addArg = require('../add-arg.js');
 
-module.exports.report = () => `Add 'push' argument to 'traverse'`;
-
-module.exports.fix = ({fn}) => {
-    const computed = false;
-    const shorthand = true;
-    const name = Identifier('push');
-    
-    fn.params.push(ObjectPattern([
-        ObjectProperty(name, name, computed, shorthand),
-    ]));
-};
-
-module.exports.traverse = ({push}) => {
-    const check = checkArgs(push);
-    
-    return {
-        'export const traverse = (__args) => __': check,
-        'module.exports.traverse = (__args) => __': check,
-    };
-};
-
-const checkArgs = (push) => (path) => {
-    const fn = parseFn(path);
-    
-    if (fn.params.length)
-        return;
-    
-    traverse(path, {
-        ReferencedIdentifier(path) {
-            if (path.node.name !== 'push')
-                return;
-            
-            if (isCalleePush(path))
-                return;
-            
-            push({
-                path,
-                fn,
-            });
-        },
-        'push(__)': (currentPath) => {
-            if (currentPath.scope.getAllBindings().push)
-                return;
-            
-            push({
-                path,
-                fn,
-            });
-        },
-    });
-};
-
-function parseFn(path) {
-    if (path.isAssignmentExpression())
-        return path.get('right').node;
-    
-    return path.get('declaration.declarations.0.init').node;
-}
-
-function isCalleePush({parentPath}) {
-    return parentPath
-        .get('callee')
-        .isIdentifier({
-            name: 'push',
-        });
-}
+module.exports = addArg('push');

package/lib/add-store/index.js

@@ -0,0 +1,5 @@
+'use strict';
+
+const addArg = require('../add-arg');
+
+module.exports = addArg('store');

package/lib/index.js

@@ -49,6 +49,7 @@ const convertProgressToTrackFile = require('./convert-progress-to-track-file');
 const addAwaitToProgress = require('./add-await-to-progress');
 const applyForOfToTrackFile = require('./apply-for-of-to-track-file');
 const removeUnusedGetPropertiesArgument = require('./remove-unused-get-properties-argument');
+const addStore = require('./add-store');
 
 module.exports.rules = {
     'apply-processors-destructuring': applyProcessorsDestructuring,
@@ -100,4 +101,5 @@ module.exports.rules = {
     'add-await-to-progress': addAwaitToProgress,
     'apply-for-of-to-track-file': applyForOfToTrackFile,
     'remove-unused-get-properties-argument': removeUnusedGetPropertiesArgument,
+    'add-store': addStore,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-putout",
-  "version": "19.4.0",
+  "version": "19.5.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin helps with plugins development",