fix: Add react-refresh/only-export-components support and fix eslint-plugin-n rule aliases (#342)

* Add a snapshot test for the result from using the react-refresh plugin.

* Disallow react-refresh as a JS Plugin in the migrator, as we support its only rule natively.

* Update comment.

* Add comment.

* fix: Add `react-refresh/only-export-components` to the generated rules list.

I still need to implement the logic for renaming it back to just `react/` elsewhere, but this is necessary for the rule to be recognized as a supported rule.

I should probably also make the same change to `eslint-plugin-oxlint` later.

* Fix the node plugin name for the generated rules list.

This ensures that we can correctly match eslint-plugin-n rules when migrating :)

Need to port this change to eslint-plugin-oxlint as well.

* Set up the react-reflesh plugin name swap logic.

Now it correctly sets the rule scope to just `react/` :)

* Fix typecheck.

Author: connorshea

integration_test/__snapshots__/autoprefixer.spec.ts.snap

@@ -27,11 +27,21 @@ exports[`autoprefixer > autoprefixer 1`] = `
         ],
         "rules": {
           "no-unused-expressions": "off",
+          "node/global-require": "off",
+        },
+      },
+      {
+        "files": [
+          "bin/autoprefixer",
+        ],
+        "rules": {
+          "node/global-require": "off",
         },
       },
     ],
     "plugins": [
       "import",
+      "node",
       "promise",
     ],
     "rules": {
@@ -206,6 +216,9 @@ exports[`autoprefixer > autoprefixer 1`] = `
       "no-var": "warn",
       "no-void": "error",
       "no-with": "error",
+      "node/global-require": "error",
+      "node/no-exports-assign": "error",
+      "node/no-new-require": "error",
       "prefer-exponentiation-operator": "error",
       "prefer-promise-reject-errors": "error",
       "prefer-rest-params": "error",
@@ -267,13 +280,10 @@ exports[`autoprefixer > autoprefixer 1`] = `
       "camelcase",
       "dot-notation",
       "func-name-matching",
-      "n/global-require",
       "n/handle-callback-err",
       "n/no-deprecated-api",
-      "n/no-exports-assign",
       "n/no-extraneous-require",
       "n/no-missing-require",
-      "n/no-new-require",
       "n/no-path-concat",
       "n/no-unpublished-require",
       "n/no-unsupported-features/es-builtins",
@@ -324,13 +334,10 @@ exports[`autoprefixer > autoprefixer 1`] = `
     "unsupported rule: func-name-matching",
     "unsupported rule, but available as a nursery rule: getter-return",
     "unsupported rule, but available as a nursery rule: import-x/export",
-    "unsupported rule: n/global-require",
     "unsupported rule: n/handle-callback-err",
     "unsupported rule: n/no-deprecated-api",
-    "unsupported rule: n/no-exports-assign",
     "unsupported rule: n/no-extraneous-require",
     "unsupported rule: n/no-missing-require",
-    "unsupported rule: n/no-new-require",
     "unsupported rule: n/no-path-concat",
     "unsupported rule: n/no-unpublished-require",
     "unsupported rule: n/no-unsupported-features/es-builtins",
@@ -390,11 +397,21 @@ exports[`autoprefixer --js-plugins > autoprefixer--js-plugins 1`] = `
         ],
         "rules": {
           "no-unused-expressions": "off",
+          "node/global-require": "off",
+        },
+      },
+      {
+        "files": [
+          "bin/autoprefixer",
+        ],
+        "rules": {
+          "node/global-require": "off",
         },
       },
     ],
     "plugins": [
       "import",
+      "node",
       "promise",
     ],
     "rules": {
@@ -569,6 +586,9 @@ exports[`autoprefixer --js-plugins > autoprefixer--js-plugins 1`] = `
       "no-var": "warn",
       "no-void": "error",
       "no-with": "error",
+      "node/global-require": "error",
+      "node/no-exports-assign": "error",
+      "node/no-new-require": "error",
       "perfectionist/sort-array-includes": [
         "warn",
         {
@@ -774,13 +794,10 @@ exports[`autoprefixer --js-plugins > autoprefixer--js-plugins 1`] = `
       "camelcase",
       "dot-notation",
       "func-name-matching",
-      "n/global-require",
       "n/handle-callback-err",
       "n/no-deprecated-api",
-      "n/no-exports-assign",
       "n/no-extraneous-require",
       "n/no-missing-require",
-      "n/no-new-require",
       "n/no-path-concat",
       "n/no-unpublished-require",
       "n/no-unsupported-features/es-builtins",
@@ -809,13 +826,10 @@ exports[`autoprefixer --js-plugins > autoprefixer--js-plugins 1`] = `
     "unsupported rule: func-name-matching",
     "unsupported rule, but available as a nursery rule: getter-return",
     "unsupported rule, but available as a nursery rule: import-x/export",
-    "unsupported rule: n/global-require",
     "unsupported rule: n/handle-callback-err",
     "unsupported rule: n/no-deprecated-api",
-    "unsupported rule: n/no-exports-assign",
     "unsupported rule: n/no-extraneous-require",
     "unsupported rule: n/no-missing-require",
-    "unsupported rule: n/no-new-require",
     "unsupported rule: n/no-path-concat",
     "unsupported rule: n/no-unpublished-require",
     "unsupported rule: n/no-unsupported-features/es-builtins",
@@ -870,11 +884,21 @@ exports[`autoprefixer --type-aware > autoprefixer--type-aware 1`] = `
         ],
         "rules": {
           "no-unused-expressions": "off",
+          "node/global-require": "off",
+        },
+      },
+      {
+        "files": [
+          "bin/autoprefixer",
+        ],
+        "rules": {
+          "node/global-require": "off",
         },
       },
     ],
     "plugins": [
       "import",
+      "node",
       "promise",
     ],
     "rules": {
@@ -1049,6 +1073,9 @@ exports[`autoprefixer --type-aware > autoprefixer--type-aware 1`] = `
       "no-var": "warn",
       "no-void": "error",
       "no-with": "error",
+      "node/global-require": "error",
+      "node/no-exports-assign": "error",
+      "node/no-new-require": "error",
       "prefer-exponentiation-operator": "error",
       "prefer-promise-reject-errors": "error",
       "prefer-rest-params": "error",
@@ -1110,13 +1137,10 @@ exports[`autoprefixer --type-aware > autoprefixer--type-aware 1`] = `
       "camelcase",
       "dot-notation",
       "func-name-matching",
-      "n/global-require",
       "n/handle-callback-err",
       "n/no-deprecated-api",
-      "n/no-exports-assign",
       "n/no-extraneous-require",
       "n/no-missing-require",
-      "n/no-new-require",
       "n/no-path-concat",
       "n/no-unpublished-require",
       "n/no-unsupported-features/es-builtins",
@@ -1167,13 +1191,10 @@ exports[`autoprefixer --type-aware > autoprefixer--type-aware 1`] = `
     "unsupported rule: func-name-matching",
     "unsupported rule, but available as a nursery rule: getter-return",
     "unsupported rule, but available as a nursery rule: import-x/export",
-    "unsupported rule: n/global-require",
     "unsupported rule: n/handle-callback-err",
     "unsupported rule: n/no-deprecated-api",
-    "unsupported rule: n/no-exports-assign",
     "unsupported rule: n/no-extraneous-require",
     "unsupported rule: n/no-missing-require",
-    "unsupported rule: n/no-new-require",
     "unsupported rule: n/no-path-concat",
     "unsupported rule: n/no-unpublished-require",
     "unsupported rule: n/no-unsupported-features/es-builtins",
@@ -1230,11 +1251,21 @@ exports[`autoprefixer merge > autoprefixer--merge 1`] = `
         ],
         "rules": {
           "no-unused-expressions": "off",
+          "node/global-require": "off",
+        },
+      },
+      {
+        "files": [
+          "bin/autoprefixer",
+        ],
+        "rules": {
+          "node/global-require": "off",
         },
       },
     ],
     "plugins": [
       "import",
+      "node",
       "promise",
     ],
     "rules": {
@@ -1368,6 +1399,9 @@ exports[`autoprefixer merge > autoprefixer--merge 1`] = `
       "no-useless-return": "error",
       "no-var": "warn",
       "no-void": "error",
+      "node/global-require": "error",
+      "node/no-exports-assign": "error",
+      "node/no-new-require": "error",
       "prefer-exponentiation-operator": "error",
       "prefer-promise-reject-errors": "error",
       "prefer-rest-params": "error",
@@ -1428,13 +1462,10 @@ exports[`autoprefixer merge > autoprefixer--merge 1`] = `
       "camelcase",
       "dot-notation",
       "func-name-matching",
-      "n/global-require",
       "n/handle-callback-err",
       "n/no-deprecated-api",
-      "n/no-exports-assign",
       "n/no-extraneous-require",
       "n/no-missing-require",
-      "n/no-new-require",
       "n/no-path-concat",
       "n/no-unpublished-require",
       "n/no-unsupported-features/es-builtins",
@@ -1485,13 +1516,10 @@ exports[`autoprefixer merge > autoprefixer--merge 1`] = `
     "unsupported rule: func-name-matching",
     "unsupported rule, but available as a nursery rule: getter-return",
     "unsupported rule, but available as a nursery rule: import-x/export",
-    "unsupported rule: n/global-require",
     "unsupported rule: n/handle-callback-err",
     "unsupported rule: n/no-deprecated-api",
-    "unsupported rule: n/no-exports-assign",
     "unsupported rule: n/no-extraneous-require",
     "unsupported rule: n/no-missing-require",
-    "unsupported rule: n/no-new-require",
     "unsupported rule: n/no-path-concat",
     "unsupported rule: n/no-unpublished-require",
     "unsupported rule: n/no-unsupported-features/es-builtins",

integration_test/__snapshots__/eslint-plugin-react-refresh.spec.ts.snap

@@ -0,0 +1,106 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`eslint-plugin-react-refresh > eslint-plugin-react-refresh 1`] = `
+{
+  "config": {
+    "$schema": "./node_modules/oxlint/configuration_schema.json",
+    "categories": {
+      "correctness": "off",
+    },
+    "env": {
+      "builtin": true,
+    },
+    "plugins": [
+      "react",
+    ],
+    "rules": {
+      "react/only-export-components": "error",
+    },
+  },
+  "skipped": {
+    "nursery": [],
+    "type-aware": [],
+    "unsupported": [],
+  },
+  "warnings": [],
+}
+`;
+
+exports[`eslint-plugin-react-refresh --js-plugins > eslint-plugin-react-refresh--js-plugins 1`] = `
+{
+  "config": {
+    "$schema": "./node_modules/oxlint/configuration_schema.json",
+    "categories": {
+      "correctness": "off",
+    },
+    "env": {
+      "builtin": true,
+    },
+    "plugins": [
+      "react",
+    ],
+    "rules": {
+      "react/only-export-components": "error",
+    },
+  },
+  "skipped": {
+    "nursery": [],
+    "type-aware": [],
+    "unsupported": [],
+  },
+  "warnings": [],
+}
+`;
+
+exports[`eslint-plugin-react-refresh --type-aware > eslint-plugin-react-refresh--type-aware 1`] = `
+{
+  "config": {
+    "$schema": "./node_modules/oxlint/configuration_schema.json",
+    "categories": {
+      "correctness": "off",
+    },
+    "env": {
+      "builtin": true,
+    },
+    "plugins": [
+      "react",
+    ],
+    "rules": {
+      "react/only-export-components": "error",
+    },
+  },
+  "skipped": {
+    "nursery": [],
+    "type-aware": [],
+    "unsupported": [],
+  },
+  "warnings": [],
+}
+`;
+
+exports[`eslint-plugin-react-refresh merge > eslint-plugin-react-refresh--merge 1`] = `
+{
+  "config": {
+    "$schema": "./node_modules/oxlint/configuration_schema.json",
+    "categories": {
+      "correctness": "error",
+      "perf": "error",
+    },
+    "env": {
+      "builtin": true,
+    },
+    "plugins": [
+      "react",
+    ],
+    "rules": {
+      "react/only-export-components": "error",
+    },
+  },
+  "skipped": {
+    "nursery": [],
+    "type-aware": [],
+    "unsupported": [],
+  },
+  "warnings": [],
+}
+`;

integration_test/eslint-plugin-react-refresh.spec.ts

@@ -0,0 +1,4 @@
+import react_refresh_test from './projects/eslint-plugin-react-refresh.eslint.config.js';
+import { testProject } from './utils.js';
+
+testProject('eslint-plugin-react-refresh', react_refresh_test);

integration_test/projects/eslint-plugin-react-refresh.eslint.config.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from 'eslint/config';
+import reactRefresh from 'eslint-plugin-react-refresh';
+
+// This should result in an oxlint config with `react/only-export-components` enabled.
+export default defineConfig(reactRefresh.configs.recommended);

package.json

@@ -67,6 +67,7 @@
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.0.1",
     "eslint-plugin-react-perf": "^3.3.3",
+    "eslint-plugin-react-refresh": "^0.4.26",
     "eslint-plugin-regexp": "^2.9.0",
     "eslint-plugin-tsdoc": "^0.5.0",
     "eslint-plugin-unicorn": "^62.0.0",