@putout/plugin-tape 3.7.1 → 3.11.0

package/README.md

@@ -20,6 +20,10 @@ npm i @putout/plugin-tape -D
     "rules": {
         "tape/apply-stub-operator": "on",
         "tape/apply-with-name": "on",
+        "tape/add-t-end": "on",
+        "tape/add-stop-all": "on",
+        "tape/remove-useless-t-end": "on",
+        "tape/sync-with-name": "on",
         "tape/switch-expected-with-result": "on",
         "tape/convert-tape-to-supertape": "on",
         "tape/convert-throws-to-try-catch": "on",
@@ -343,6 +347,31 @@ test('should call init before show', (t) => {
 });
 ```
 
+## sync-with-name
+
+### ❌ Incorrect code example
+
+```js
+test('should call init before show', (t) => {
+    const init = stub().withName('show');
+    const show = stub().withName('show');
+    
+    t.calledInOrder([init, show]);
+    t.end();
+});
+```
+
+### ✅ Correct code example
+
+```js
+test('should call init before show', (t) => {
+    const init = stub().withName('init');
+    const show = stub().withName('show');
+    
+    t.calledInOrder([init, show]);
+    t.end();
+});
+```
 
 ## declare-stub
 
@@ -388,6 +417,70 @@ test('xxx', (t) => {
 });
 ```
 
+## add-t-end
+
+### ❌ Incorrect code example
+
+```js
+test('xxx', () => {
+});
+```
+
+### ✅ Correct code example
+
+```js
+test('xxx', (t) => {
+    t.end();
+});
+```
+
+## add-stop-all
+
+### ❌ Incorrect code example
+
+```js
+test('stop-all: should be called', () => {
+    mockImport('fs/promises', {
+        readFile: stub(),
+    });
+    
+    t.end();
+});
+```
+
+### ✅ Correct code example
+
+```js
+test('stop-all: should be called', () => {
+    mockImport('fs/promises', {
+        readFile: stub(),
+    });
+    
+    stopAll();
+    
+    t.end();
+});
+```
+
+## remove-useless-t-end
+
+### ❌ Incorrect code example
+
+```js
+test('test: remove me', () => {
+    t.end();
+    t.end();
+});
+```
+
+### ✅ Correct code example
+
+```js
+test('test: remove me', () => {
+    t.end();
+});
+```
+
 ## convert-ok-to-match
 
 ### ❌ Incorrect code example

package/lib/add-stop-all/index.js

@@ -0,0 +1,85 @@
+'use strict';
+
+const {
+    types,
+    operator,
+    template,
+} = require('putout');
+
+const {
+    traverse,
+    compare,
+} = operator;
+
+const {ExpressionStatement} = types;
+
+module.exports.report = () => `Call 'stopAll()' at the end of test when 'mockImport()' used`;
+
+module.exports.fix = (path) => {
+    const assertionPath = getAssertionsPath(path);
+    const stopAllNode = template.ast('stopAll()');
+    
+    assertionPath.insertBefore(ExpressionStatement(stopAllNode));
+};
+
+const TEST = 'test("__a", (t) => __body)';
+
+module.exports.traverse = ({push}) => ({
+    [TEST]: (path) => {
+        const {
+            hasMockImport,
+            hasStopAll,
+            hasAssertions,
+        } = check(path);
+        
+        if (!hasMockImport)
+            return;
+        
+        if (!hasAssertions)
+            return;
+        
+        if (hasStopAll)
+            return;
+        
+        push(path);
+    },
+});
+
+function check(path) {
+    let hasStopAll = false;
+    let hasMockImport = false;
+    let hasAssertions = false;
+    
+    traverse(path, {
+        'mockImport(__a, __b)': (path) => {
+            hasMockImport = true;
+        },
+        'stopAll()': () => {
+            hasStopAll = true;
+        },
+        't.__(__args)': () => {
+            hasAssertions = true;
+        },
+    });
+    
+    return {
+        hasStopAll,
+        hasMockImport,
+        hasAssertions,
+    };
+}
+
+function getAssertionsPath(path) {
+    const bodyPath = path.get('arguments.1.body.body');
+    let resultPath = null;
+    
+    for (const pathEl of bodyPath) {
+        if (compare(pathEl, 't.__(__args)')) {
+            resultPath = pathEl;
+            break;
+        }
+    }
+    
+    return resultPath;
+}
+

package/lib/add-t-end/index.js

@@ -0,0 +1,30 @@
+'use strict';
+
+const {
+    types,
+    template,
+    operator,
+} = require('putout');
+const {compare} = operator;
+const {ExpressionStatement} = types;
+
+module.exports.report = () => `'t.end()' is missing at the end of the test`;
+
+module.exports.match = () => ({
+    'test(__a, (t) => __body)': ({__body}) => {
+        const {body} = __body;
+        const {length} = body;
+        
+        if (!length)
+            return true;
+        
+        return !compare(body[length - 1], 't.end()');
+    },
+});
+
+module.exports.replace = () => ({
+    'test(__a, (t) => __body)': ({__body}, path) => {
+        __body.body.push(ExpressionStatement(template.ast('t.end()')));
+        return path;
+    },
+});

package/lib/index.js

@@ -6,6 +6,7 @@ const getRule = (a) => ({
 
 module.exports.rules = {
     ...getRule('apply-with-name'),
+    ...getRule('sync-with-name'),
     ...getRule('convert-tape-to-supertape'),
     ...getRule('convert-throws-to-try-catch'),
     ...getRule('convert-does-not-throw-to-try-catch'),
@@ -25,5 +26,8 @@ module.exports.rules = {
     ...getRule('remove-useless-not-called-args'),
     ...getRule('switch-expected-with-result'),
     ...getRule('apply-stub-operator'),
+    ...getRule('add-t-end'),
+    ...getRule('add-stop-all'),
+    ...getRule('remove-useless-t-end'),
 };
 

package/lib/remove-useless-t-end/index.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const {operator} = require('putout');
+
+const {traverse} = operator;
+
+module.exports.report = () => `Avoid useless 't.end()'`;
+
+module.exports.fix = (path) => {
+    path.remove();
+};
+
+const TEST = 'test("__a", (t) => __body)';
+
+module.exports.traverse = ({push}) => ({
+    [TEST]: (path) => {
+        const paths = [];
+        
+        traverse(path, {
+            't.end()': (path) => {
+                paths.push(path);
+            },
+        });
+        
+        if (paths.length > 1)
+            push(paths.pop());
+    },
+});
+

package/lib/sync-with-name/index.js

@@ -0,0 +1,14 @@
+'use strict';
+
+module.exports.report = () => `'stub().withName(name)' should synced with variable name`;
+
+module.exports.match = () => ({
+    'const __a = stub().withName(__b)': ({__a, __b}) => __b.value !== __a.name,
+});
+
+module.exports.replace = () => ({
+    'const __a = stub().withName(__b)': ({__a, __b}, path) => {
+        __b.value = __a.name;
+        return path;
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-tape",
-  "version": "3.7.1",
+  "version": "3.11.0",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "putout plugin helps with tests",
   "homepage": "http://github.com/coderaiser/putout",
@@ -39,6 +39,7 @@
     "eslint-plugin-putout": "^10.0.0",
     "lerna": "^4.0.0",
     "madrun": "^8.0.1",
+    "montag": "^1.2.1",
     "nodemon": "^2.0.1"
   },
   "peerDependencies": {