[Tests] inject tape into RuleTester so test cases are logged properly

ljharb · ljharb · commit 2d9ad55c9726 · 2025-06-05T10:36:22.000-07:00
Fixes jsx-eslint#1049
diff --git a/__tests__/__util__/RuleTester.js b/__tests__/__util__/RuleTester.js
@@ -0,0 +1,29 @@
+import test from 'tape';
+import mockProperty from 'mock-property';
+import { RuleTester } from 'eslint';
+
+const orig = RuleTester.prototype.run;
+RuleTester.prototype.run = function (name, rule, tests) {
+  test(`RuleTester: ${name}`, (t) => {
+    t.teardown(mockProperty(RuleTester.describe, 't', { value: t }));
+    orig.call(this, name, rule, tests);
+
+    t.end();
+  });
+};
+
+RuleTester.describe = function (text, method) {
+  RuleTester.it.title = text;
+  const self = this;
+  RuleTester.describe.t.test(text, (t) => {
+    t.teardown(mockProperty(RuleTester.it, 't', { value: t }));
+    method.call(self);
+    t.end();
+  });
+};
+
+RuleTester.it = function (text, method) {
+  RuleTester.it.t.doesNotThrow(method, `${RuleTester.it.title}: ${text}`);
+};
+
+export default RuleTester;
diff --git a/__tests__/src/rules/accessible-emoji-test.js b/__tests__/src/rules/accessible-emoji-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import rule from '../../../src/rules/accessible-emoji';
 import parsers from '../../__util__/helpers/parsers';
diff --git a/__tests__/src/rules/alt-text-test.js b/__tests__/src/rules/alt-text-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/alt-text';
diff --git a/__tests__/src/rules/anchor-ambiguous-text-test.js b/__tests__/src/rules/anchor-ambiguous-text-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/anchor-ambiguous-text';
diff --git a/__tests__/src/rules/anchor-has-content-test.js b/__tests__/src/rules/anchor-has-content-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/anchor-has-content';
diff --git a/__tests__/src/rules/anchor-is-valid-test.js b/__tests__/src/rules/anchor-is-valid-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/anchor-is-valid';
diff --git a/__tests__/src/rules/aria-activedescendant-has-tabindex-test.js b/__tests__/src/rules/aria-activedescendant-has-tabindex-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/aria-activedescendant-has-tabindex';
diff --git a/__tests__/src/rules/aria-props-test.js b/__tests__/src/rules/aria-props-test.js
@@ -8,7 +8,7 @@
 // -----------------------------------------------------------------------------
 
 import { aria } from 'aria-query';
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/aria-props';
diff --git a/__tests__/src/rules/aria-proptypes-test.js b/__tests__/src/rules/aria-proptypes-test.js
@@ -8,7 +8,7 @@
 // -----------------------------------------------------------------------------
 
 import { aria } from 'aria-query';
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import test from 'tape';
 
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
diff --git a/__tests__/src/rules/aria-role-test.js b/__tests__/src/rules/aria-role-test.js
@@ -8,7 +8,7 @@
 // -----------------------------------------------------------------------------
 
 import { roles } from 'aria-query';
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/aria-role';
diff --git a/__tests__/src/rules/aria-unsupported-elements-test.js b/__tests__/src/rules/aria-unsupported-elements-test.js
@@ -9,7 +9,7 @@
 // -----------------------------------------------------------------------------
 
 import { dom } from 'aria-query';
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/aria-unsupported-elements';
diff --git a/__tests__/src/rules/autocomplete-valid-test.js b/__tests__/src/rules/autocomplete-valid-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import { axeFailMessage } from '../../__util__/axeMapping';
 import parsers from '../../__util__/helpers/parsers';
diff --git a/__tests__/src/rules/click-events-have-key-events-test.js b/__tests__/src/rules/click-events-have-key-events-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/click-events-have-key-events';
diff --git a/__tests__/src/rules/control-has-associated-label-test.js b/__tests__/src/rules/control-has-associated-label-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import { configs } from '../../../src/index';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
diff --git a/__tests__/src/rules/heading-has-content-test.js b/__tests__/src/rules/heading-has-content-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/heading-has-content';
diff --git a/__tests__/src/rules/html-has-lang-test.js b/__tests__/src/rules/html-has-lang-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/html-has-lang';
diff --git a/__tests__/src/rules/iframe-has-title-test.js b/__tests__/src/rules/iframe-has-title-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/iframe-has-title';
diff --git a/__tests__/src/rules/img-redundant-alt-test.js b/__tests__/src/rules/img-redundant-alt-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import semver from 'semver';
 import { version as eslintVersion } from 'eslint/package.json';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
diff --git a/__tests__/src/rules/interactive-supports-focus-test.js b/__tests__/src/rules/interactive-supports-focus-test.js
@@ -8,7 +8,7 @@
 // -----------------------------------------------------------------------------
 
 import includes from 'array-includes';
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import {
   eventHandlers,
   eventHandlersByType,
diff --git a/__tests__/src/rules/label-has-associated-control-test.js b/__tests__/src/rules/label-has-associated-control-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/label-has-associated-control';
diff --git a/__tests__/src/rules/label-has-for-test.js b/__tests__/src/rules/label-has-for-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import assign from 'object.assign';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
diff --git a/__tests__/src/rules/lang-test.js b/__tests__/src/rules/lang-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/lang';
diff --git a/__tests__/src/rules/media-has-caption-test.js b/__tests__/src/rules/media-has-caption-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/media-has-caption';
diff --git a/__tests__/src/rules/mouse-events-have-key-events-test.js b/__tests__/src/rules/mouse-events-have-key-events-test.js
@@ -8,7 +8,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/mouse-events-have-key-events';
diff --git a/__tests__/src/rules/no-access-key-test.js b/__tests__/src/rules/no-access-key-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/no-access-key';
diff --git a/__tests__/src/rules/no-aria-hidden-on-focusable-test.js b/__tests__/src/rules/no-aria-hidden-on-focusable-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/no-aria-hidden-on-focusable';
diff --git a/__tests__/src/rules/no-autofocus-test.js b/__tests__/src/rules/no-autofocus-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/no-autofocus';
diff --git a/__tests__/src/rules/no-distracting-elements-test.js b/__tests__/src/rules/no-distracting-elements-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/no-distracting-elements';
diff --git a/__tests__/src/rules/no-interactive-element-to-noninteractive-role-test.js b/__tests__/src/rules/no-interactive-element-to-noninteractive-role-test.js
@@ -8,7 +8,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import { configs } from '../../../src/index';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
diff --git a/__tests__/src/rules/no-noninteractive-element-interactions-test.js b/__tests__/src/rules/no-noninteractive-element-interactions-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import { configs } from '../../../src/index';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
diff --git a/__tests__/src/rules/no-noninteractive-element-to-interactive-role-test.js b/__tests__/src/rules/no-noninteractive-element-to-interactive-role-test.js
@@ -9,7 +9,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import { configs } from '../../../src/index';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
diff --git a/__tests__/src/rules/no-noninteractive-tabindex-test.js b/__tests__/src/rules/no-noninteractive-tabindex-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import { configs } from '../../../src/index';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
diff --git a/__tests__/src/rules/no-onchange-test.js b/__tests__/src/rules/no-onchange-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/no-onchange';
diff --git a/__tests__/src/rules/no-redundant-roles-test.js b/__tests__/src/rules/no-redundant-roles-test.js
@@ -8,7 +8,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/no-redundant-roles';
diff --git a/__tests__/src/rules/no-static-element-interactions-test.js b/__tests__/src/rules/no-static-element-interactions-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import { configs } from '../../../src/index';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
diff --git a/__tests__/src/rules/prefer-tag-over-role-test.js b/__tests__/src/rules/prefer-tag-over-role-test.js
@@ -1,4 +1,4 @@
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/prefer-tag-over-role';
diff --git a/__tests__/src/rules/role-has-required-aria-props-test.js b/__tests__/src/rules/role-has-required-aria-props-test.js
@@ -9,7 +9,7 @@
 // -----------------------------------------------------------------------------
 
 import { roles } from 'aria-query';
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
diff --git a/__tests__/src/rules/role-supports-aria-props-test.js b/__tests__/src/rules/role-supports-aria-props-test.js
@@ -11,7 +11,7 @@ import {
   aria,
   roles,
 } from 'aria-query';
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import { version as eslintVersion } from 'eslint/package.json';
 import semver from 'semver';
 
diff --git a/__tests__/src/rules/scope-test.js b/__tests__/src/rules/scope-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/scope';
diff --git a/__tests__/src/rules/tabindex-no-positive-test.js b/__tests__/src/rules/tabindex-no-positive-test.js
@@ -7,7 +7,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/tabindex-no-positive';
diff --git a/package.json b/package.json
@@ -61,6 +61,7 @@
     "jackspeak": "=2.1.1",
     "jscodeshift": "^17.0.0",
     "minimist": "^1.2.8",
+    "mock-property": "^1.1.0",
     "npmignore": "^0.3.1",
     "object.assign": "^4.1.5",
     "object.entries": "^1.1.8",
diff --git a/scripts/boilerplate/test.js b/scripts/boilerplate/test.js
@@ -7,7 +7,7 @@ const testBoilerplate = (name, author, description) => `/**
 // Requirements
 // -----------------------------------------------------------------------------
 
-import { RuleTester } from 'eslint';
+import RuleTester from '../../__util__/RuleTester';
 import parserOptionsMapper from '../../__util__/parserOptionsMapper';
 import parsers from '../../__util__/helpers/parsers';
 import rule from '../../../src/rules/${name}';
