feat: add no-manual-cleanup rule

README.md

@@ -23,7 +23,9 @@
 [![Tweet][tweet-badge]][tweet-url]
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
 [![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)
+
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 ## Installation
@@ -142,6 +144,7 @@ To enable this configuration use the `extends` property in your
 | [no-debug](docs/rules/no-debug.md)                                                                  | Disallow the use of `debug`                                                 | ![angular-badge][] ![react-badge][] ![vue-badge][]                        |                    |
 | [no-dom-import](docs/rules/no-dom-import.md)                                                        | Disallow importing from DOM Testing Library                                 | ![angular-badge][] ![react-badge][] ![vue-badge][]                        | ![fixable-badge][] |
 | [no-get-by-for-checking-element-not-present](docs/rules/no-get-by-for-checking-element-not-present) | Disallow the use of `getBy*` queries when checking elements are not present |                                                                           |                    |
+| [no-manual-cleanup](docs/rules/no-manual-cleanup.md)                                                | Disallow the use of `cleanup`                                               | ![react-badge][] ![vue-badge][]                                           |                    |
 | [prefer-explicit-assert](docs/rules/prefer-explicit-assert.md)                                      | Suggest using explicit assertions rather than just `getBy*` queries         |                                                                           |                    |
 
 [build-badge]: https://img.shields.io/travis/testing-library/eslint-plugin-testing-library?style=flat-square
@@ -190,6 +193,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- markdownlint-enable -->
 <!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

docs/rules/no-manual-cleanup.md

@@ -0,0 +1,23 @@
+# Disallow the use of `cleanup` (no-manual-cleanup)
+
+TODO: SUMMARY
+
+## Rule Details
+
+TODO: DETAILS
+
+Examples of **incorrect** code for this rule:
+
+```js
+// TODO: EXAMPLES
+```
+
+Examples of **correct** code for this rule:
+
+```js
+// TODO: EXAMPLES
+```
+
+## Further Reading
+
+- [cleanup API in React Testing Library](https://testing-library.com/docs/react-testing-library/api#cleanup)

lib/index.js

@@ -9,6 +9,7 @@ const rules = {
   'no-debug': require('./rules/no-debug'),
   'no-dom-import': require('./rules/no-dom-import'),
   'no-get-by-for-checking-element-not-present': require('./rules/no-get-by-for-checking-element-not-present'),
+  'no-manual-cleanup': require('./rules/no-manual-cleanup'),
   'prefer-explicit-assert': require('./rules/prefer-explicit-assert'),
 };
 
@@ -39,6 +40,7 @@ module.exports = {
         ...recommendedRules,
         'testing-library/no-debug': 'warn',
         'testing-library/no-dom-import': ['error', 'react'],
+        'testing-library/no-manual-cleanup': 'warn',
       },
     },
     vue: {
@@ -48,6 +50,7 @@ module.exports = {
         'testing-library/await-fire-event': 'error',
         'testing-library/no-debug': 'warn',
         'testing-library/no-dom-import': ['error', 'vue'],
+        'testing-library/no-manual-cleanup': 'warn',
       },
     },
   },

lib/rules/no-manual-cleanup.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const { getDocsUrl } = require('../utils');
+
+const findCleanupSpecifier = specifiers => {
+  return specifiers.find(specifier => specifier.imported.name === 'cleanup');
+};
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: ' Disallow the use of `cleanup`',
+      category: 'Best Practices',
+      recommended: false,
+      url: getDocsUrl('no-manual-cleanup'),
+    },
+    messages: {
+      noManualCleanup:
+        "`cleanup` is performed automatically after each test by {{library}}, you don't need manual cleanups.",
+    },
+    fixable: null,
+    schema: [],
+  },
+
+  create: function(context) {
+    return {
+      ImportDeclaration(node) {
+        const testingLibraryWithCleanup = node.source.value.match(
+          /@testing-library\/(react|vue)/
+        );
+
+        // Early return if the library doesn't support `cleanup`
+        if (!testingLibraryWithCleanup) {
+          return;
+        }
+
+        const cleanupSpecifier = findCleanupSpecifier(node.specifiers);
+
+        if (cleanupSpecifier) {
+          context.report({
+            node: cleanupSpecifier,
+            messageId: 'noManualCleanup',
+            data: {
+              library: testingLibraryWithCleanup[0],
+            },
+          });
+        }
+      },
+    };
+  },
+};

tests/__snapshots__/index.test.js.snap

@@ -32,6 +32,7 @@ Object {
       "error",
       "react",
     ],
+    "testing-library/no-manual-cleanup": "warn",
   },
 }
 `;
@@ -64,6 +65,7 @@ Object {
       "error",
       "vue",
     ],
+    "testing-library/no-manual-cleanup": "warn",
   },
 }
 `;

tests/lib/rules/no-manual-cleanup.js

@@ -0,0 +1,43 @@
+'use strict';
+
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+
+const rule = require('../../../lib/rules/no-manual-cleanup');
+const RuleTester = require('eslint').RuleTester;
+
+// ------------------------------------------------------------------------------
+// Tests
+// ------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+});
+
+ruleTester.run('no-manual-cleanup', rule, {
+  valid: [
+    {
+      code: `import { render } from "@testing-library/react"`,
+    },
+  ],
+  invalid: [
+    {
+      code: `import { render, cleanup } from "@testing-library/react"`,
+      errors: [
+        {
+          line: 1,
+          column: 18, // error points to `cleanup`
+          message:
+            "`cleanup` is performed automatically after each test by @testing-library/react, you don't need manual cleanups.",
+        },
+      ],
+    },
+  ],
+});