[Tests] test rules with ESLint v9

Author: mdjermanovic

.github/workflows/node-18+.yml

@@ -26,6 +26,7 @@ jobs:
       matrix:
         node-version: ${{ fromJson(needs.matrix.outputs.latest) }}
         eslint:
+          - 9
           - 8
           - 7
           - 6

tests/helpers/ruleTester.js

@@ -0,0 +1,109 @@
+'use strict';
+
+const ESLintRuleTester = require('eslint').RuleTester;
+const semver = require('semver');
+const eslintPkg = require('eslint/package.json');
+
+// `item` can be a config passed to the constructor, or a test case object/string
+function convertToFlat(item, plugins) {
+  if (typeof item === 'string') {
+    return item;
+  }
+
+  if (typeof item !== 'object' || item === null) {
+    throw new TypeError('Invalid value for "item" option. Expected an object or a string.');
+  }
+
+  const newItem = Object.assign({}, item, { languageOptions: {} });
+
+  if (newItem.parserOptions) {
+    newItem.languageOptions.parserOptions = newItem.parserOptions;
+
+    if (newItem.parserOptions.ecmaVersion) {
+      newItem.languageOptions.ecmaVersion = newItem.parserOptions.ecmaVersion;
+    }
+
+    if (newItem.parserOptions.sourceType) {
+      newItem.languageOptions.sourceType = newItem.parserOptions.sourceType;
+    }
+
+    delete newItem.parserOptions;
+  }
+
+  if (newItem.parser) {
+    newItem.languageOptions.parser = require(newItem.parser); // eslint-disable-line global-require, import/no-dynamic-require
+    delete newItem.parser;
+  }
+
+  if (newItem.globals) {
+    newItem.languageOptions.globals = newItem.globals;
+    delete newItem.globals;
+  }
+
+  if (plugins) {
+    newItem.plugins = plugins;
+  }
+
+  return newItem;
+}
+
+let RuleTester = ESLintRuleTester;
+
+if (semver.major(eslintPkg.version) >= 9) {
+  const PLUGINS = Symbol('eslint-plugin-react plugins');
+  const RULE_DEFINER = Symbol.for('react.RuleTester.RuleDefiner');
+
+  RuleTester = class extends ESLintRuleTester {
+    constructor(config) {
+      if ((typeof config !== 'object' && typeof config !== 'undefined') || config === null) {
+        throw new TypeError('Invalid value for "config" option. Expected an object or undefined.');
+      }
+
+      const newConfig = convertToFlat(config || {});
+
+      if (!newConfig.languageOptions.ecmaVersion) {
+        newConfig.languageOptions.ecmaVersion = 5; // old default
+      }
+
+      if (!newConfig.languageOptions.sourceType) {
+        newConfig.languageOptions.sourceType = 'script'; // old default
+      }
+
+      super(newConfig);
+
+      this[RULE_DEFINER] = {
+        defineRule: (ruleId, rule) => {
+          if (!this[PLUGINS]) {
+            this[PLUGINS] = {};
+          }
+
+          const ruleIdSplit = ruleId.split('/');
+
+          if (ruleIdSplit.length !== 2) {
+            throw new Error('ruleId should be in the format: plugin-name/rule-name');
+          }
+
+          const pluginName = ruleIdSplit[0];
+          const ruleName = ruleIdSplit[1];
+
+          if (!this[PLUGINS][pluginName]) {
+            this[PLUGINS][pluginName] = { rules: {} };
+          }
+
+          this[PLUGINS][pluginName].rules[ruleName] = rule;
+        },
+      };
+    }
+
+    run(ruleName, rule, tests) {
+      const newTests = {
+        valid: tests.valid.map((test) => convertToFlat(test, this[PLUGINS])),
+        invalid: tests.invalid.map((test) => convertToFlat(test, this[PLUGINS])),
+      };
+
+      super.run(ruleName, rule, newTests);
+    }
+  };
+}
+
+module.exports = RuleTester;

tests/lib/rules/boolean-prop-naming.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/boolean-prop-naming');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/button-has-type.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/button-has-type');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/checked-requires-onchange-or-readonly.js

@@ -5,7 +5,7 @@
 
 'use strict';
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/checked-requires-onchange-or-readonly');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/default-props-match-prop-types.js

@@ -10,7 +10,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/default-props-match-prop-types');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/destructuring-assignment.js

@@ -4,9 +4,9 @@
 
 'use strict';
 
-const RuleTester = require('eslint').RuleTester;
 const semver = require('semver');
 const eslintPkg = require('eslint/package.json');
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/destructuring-assignment');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/display-name.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/display-name');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/forbid-component-props.js

@@ -8,7 +8,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/forbid-component-props');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/forbid-dom-props.js

@@ -8,7 +8,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/forbid-dom-props');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/forbid-elements.js

@@ -8,7 +8,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/forbid-elements');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/forbid-foreign-prop-types.js

@@ -8,7 +8,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/forbid-foreign-prop-types');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/forbid-prop-types.js

@@ -10,7 +10,7 @@
 
 const babelEslintVersion = require('babel-eslint/package.json').version;
 const semver = require('semver');
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 
 const rule = require('../../../lib/rules/forbid-prop-types');
 

tests/lib/rules/function-component-definition.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/function-component-definition');
 
 const parserOptions = {

tests/lib/rules/hook-use-state.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/hook-use-state');
 const parsers = require('../../helpers/parsers');
 

tests/lib/rules/iframe-missing-sandbox.js

@@ -8,7 +8,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/iframe-missing-sandbox');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-boolean-value.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-boolean-value');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-child-element-spacing.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-child-element-spacing');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-closing-bracket-location.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-closing-bracket-location');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-closing-tag-location.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-closing-tag-location');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-curly-brace-presence.js

@@ -11,9 +11,9 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
 const semver = require('semver');
 const eslintPkg = require('eslint/package.json');
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-curly-brace-presence');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-curly-newline.js

@@ -8,7 +8,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-curly-newline');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-curly-spacing.js

@@ -10,7 +10,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-curly-spacing');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-equals-spacing.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-equals-spacing');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-filename-extension.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-filename-extension');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-first-prop-new-line.js

@@ -9,7 +9,7 @@
 // Requirements
 // -----------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-first-prop-new-line');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-fragments.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-fragments');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-handler-names.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-handler-names');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-indent-props.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-indent-props');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-indent.js

@@ -9,9 +9,9 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
 const semver = require('semver');
 const eslintVersion = require('eslint/package.json').version;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-indent');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-key.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-key');
 
 const parsers = require('../../helpers/parsers');

tests/lib/rules/jsx-max-depth.js

@@ -9,7 +9,7 @@
 // Requirements
 // ------------------------------------------------------------------------------
 
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('../../helpers/ruleTester');
 const rule = require('../../../lib/rules/jsx-max-depth');
 
 const parsers = require('../../helpers/parsers');