@putout/plugin-putout 11.1.0 → 11.3.0

package/README.md

@@ -19,6 +19,7 @@ npm i @putout/plugin-putout -D
         "putout/apply-create-test": "on",
         "putout/apply-processors-destructuring": "on",
         "putout/apply-async-formatter": "on",
+        "putout/apply-remove": "on",
         "putout/add-args": "on",
         "putout/add-push": "on",
         "putout/convert-putout-test-to-create-test": "on",
@@ -41,7 +42,8 @@ npm i @putout/plugin-putout -D
         "putout/check-replace-code": "on",
         "putout/declare": "on",
         "putout/includer": "on",
-        "putout/move-require-on-top-level": "on"
+        "putout/move-require-on-top-level": "on",
+        "putout/replace-test-message": "on"
     }
 }
 ```
@@ -65,6 +67,30 @@ test('', async ({process}) => {
 });
 ```
 
+## apply-remove
+
+Better to use [`remove(path)`](https://github.com/coderaiser/putout/tree/master/packages/operate#removepath) method of `operator`.
+It helps to preserve comments.
+
+### ❌ Example of incorrect code
+
+```js
+export const fix = (path) => {
+    path.remove();
+};
+```
+
+### ✅ Example of correct code
+
+```js
+import {operator} from 'putout';
+const {remove} = operator;
+
+export const fix = (path) => {
+    remove(path);
+};
+```
+
 ## apply-async-formatter
 
 ### ❌ Example of incorrect code
@@ -120,7 +146,7 @@ const test = putoutTest(__dirname, {
 ### ✅ Example of correct code
 
 ```js
-import createTest from '@putout/test';
+import {createTest} from '@putout/test';
 
 const test = createTest(__dirname, {
     'remove-unused-variables': rmVars,
@@ -392,7 +418,7 @@ module.exports.replace = () => ({
 });
 ```
 
-There is no `fix` for this rule, it used internally to be more confident about `test coverage`, because of declaration form, transforms cannon be checked by `nyc` and `c8`, and uncovered lines can find unfixable false possitives when running on code.
+There is no `fix` for this rule, it used internally to be more confident about `test coverage`, because of declaration form, transforms cannon be checked by `nyc` and `c8`, and uncovered lines can find unfixable false positives when running on code.
 This is additional tests, if you forget to test some case (from a big list of rules that is supported) it will be checked with this `rule` and make transforms more stable.
 
 ## declare
@@ -460,6 +486,8 @@ module.exports.traverse = ({push}) => ({
 
 ## convert-add-argument-to-add-args
 
+### ❌ Example of incorrect code
+
 ```js
 const {operator} = require('putout');
 const {addArgument} = operator;
@@ -482,6 +510,8 @@ module.exports = addArgs({
 
 ## convert-dirname-to-url
 
+### ❌ Example of incorrect code
+
 ```js
 import {createTest} from '@putout/test';
 import plugin from '@putout/plugin-debugger';
@@ -506,11 +536,13 @@ const test = createTest(import.meta.url, {
 
 ## convert-url-to-dirname-
 
+### ❌ Example of incorrect code
+
 ```js
 const {createTest} = require('@putout/test');
 const plugin = require('@putout/plugin-debugger');
 
-const test = createTest(import.meta.url, {
+const test = createTest(__dirname, {
     'remove-debugger': plugin,
 });
 ```
@@ -587,6 +619,39 @@ module.exports.include = () => ['cons __a = __b'];
 module.exports.exclude = () => ['var __a = __b'];
 ```
 
+## replace-test-message
+
+Checks that `test message` and used `operator` are synchronized.
+Check it out in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/d9c6972ea848ba8e7e745d2479727b65/199c30b986ce7d544397c344ebfc5031c4b53181).
+
+### ❌ Example of incorrect code
+
+```js
+test('plugin-putout: rename-operate-to-operator: transform: operator exist', (t) => {
+    t.noTransform('operator');
+    t.end();
+});
+
+test('plugin-putout: rename-operate-to-operator: report: operator exist', (t) => {
+    t.noReport('operator');
+    t.end();
+});
+```
+
+### ✅ Example of correct code
+
+```js
+test('plugin-putout: rename-operate-to-operator: no transform: operator exist', (t) => {
+    t.noTransform('operator');
+    t.end();
+});
+
+test('plugin-putout: rename-operate-to-operator: no report: operator exist', (t) => {
+    t.noReport('operator');
+    t.end();
+});
+```
+
 ## License
 
 MIT

package/lib/add-args/index.js

@@ -4,7 +4,17 @@ const {operator} = require('putout');
 const {addArgs} = operator;
 
 module.exports = addArgs({
-    comparePlaces: ['{comparePlaces}', 'test("__a", (__args) => __body)'],
-    compare: ['{compare}', 'test("__a", (__args) => __body)'],
+    comparePlaces: ['{comparePlaces}', [
+        'test("__a", async (__args) => __body)',
+        'test.skip("__a", async (__args) => __body)',
+        'test.only("__a", async (__args) => __body)',
+    ],
+    ],
+    process: ['{process}', [
+        'test("__a", async (__args) => __body)',
+        'test.skip("__a", async (__args) => __body)',
+        'test.only("__a", async (__args) => __body)',
+    ],
+    ],
 });
 

package/lib/apply-remove/index.js

@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports.report = () => `Use 'remove(path)' instead of 'path.remove()'`;
+
+module.exports.replace = () => ({
+    'path.remove()': 'remove(path)',
+});
+

package/lib/convert-putout-test-to-create-test/index.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const {assign} = Object;
+
 module.exports.report = () => `Use 'createTest' instead of 'putoutTest'`;
 
 module.exports.filter = ({scope}) => !scope.bindings.createTest;
@@ -9,6 +11,14 @@ module.exports.include = () => [
 ];
 
 module.exports.fix = (path) => {
+    const [first] = path.node.specifiers;
+    
+    assign(first, {
+        type: 'ImportSpecifier',
+        kind: 'value',
+        imported: first.local,
+    });
+    
     path.scope.rename('putoutTest', 'createTest');
 };
 

package/lib/declare/operator.js

@@ -13,6 +13,7 @@ module.exports = {
     addArgs: `const {addArgs} = operator`,
     replaceWith: `const {replaceWith} = operator`,
     replaceWithMultiple: `const {replaceWithMultiple} = operator`,
+    remove: 'const {remove} = operator',
     isESM: `const {isESM} = operator`,
     getProperty: `const {getProperty} = operator`,
     getProperties: `const {getProperties} = operator`,

package/lib/index.js

@@ -8,6 +8,7 @@ module.exports.rules = {
     ...getRule('apply-processors-destructuring'),
     ...getRule('apply-async-formatter'),
     ...getRule('apply-create-test'),
+    ...getRule('apply-remove'),
     ...getRule('convert-putout-test-to-create-test'),
     ...getRule('convert-to-no-transform-code'),
     ...getRule('convert-find-to-traverse'),
@@ -25,6 +26,7 @@ module.exports.rules = {
     ...getRule('convert-add-argument-to-add-args'),
     ...getRule('convert-dirname-to-url'),
     ...getRule('convert-url-to-dirname'),
+    ...getRule('replace-test-message'),
     ...getRule('rename-operate-to-operator'),
     ...getRule('replace-operate-with-operator'),
     ...getRule('shorten-imports'),

package/lib/replace-test-message/index.js

@@ -0,0 +1,74 @@
+'use strict';
+
+const {types} = require('putout');
+
+const {isCallExpression} = types;
+
+module.exports.report = ({correct, operatorPath}) => {
+    const calleePath = operatorPath.get('callee');
+    return `Use '${correct}' in test message when using '${calleePath}()'`;
+};
+
+module.exports.fix = ({path, incorrect, correct}) => {
+    path.node.value = path.node.value.replace(incorrect, correct);
+};
+
+module.exports.traverse = ({push}) => ({
+    't.transform(__a)': convert({
+        push,
+        incorrect: /: no transform/,
+        correct: ': transform',
+    }),
+    't.noTransform(__a)': convert({
+        push,
+        incorrect: /: transform/,
+        correct: ': no transform',
+    }),
+    't.report(__a)': convert({
+        push,
+        incorrect: /: no report/,
+        correct: ': report',
+    }),
+    't.noReport(__a)': convert({
+        push,
+        incorrect: /: (report|transform|no transform)/,
+        correct: ': no report',
+    }),
+});
+
+const convert = ({push, correct, incorrect}) => (path) => {
+    const [is, messagePath] = isCorrect({
+        incorrect,
+        path,
+    });
+    
+    if (is)
+        return;
+    
+    push({
+        path: messagePath,
+        operatorPath: path,
+        incorrect,
+        correct,
+    });
+};
+
+const CORRECT = true;
+
+function isCorrect({path, incorrect}) {
+    const calleePath = path.findParent(isCallExpression);
+    
+    if (!calleePath)
+        return [CORRECT];
+    
+    const messagePath = calleePath.get('arguments.0');
+    
+    if (!messagePath.isStringLiteral())
+        return [CORRECT];
+    
+    const {value} = messagePath.node;
+    const is = !incorrect.test(value);
+    
+    return [is, messagePath];
+}
+

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@putout/plugin-putout",
-  "version": "11.1.0",
+  "version": "11.3.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
-  "description": "putout plugin helps with plugins development",
+  "description": "🐊Putout plugin helps with plugins development",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/plugin-putout#readme",
   "main": "lib/index.js",
   "release": false,
@@ -40,7 +40,7 @@
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^14.0.0",
+    "eslint-plugin-putout": "^15.0.0",
     "lerna": "^4.0.0",
     "madrun": "^9.0.0",
     "montag": "^1.2.1",