chore: add test for eslint v9 (#125)

* chore: add test for eslint v9 * fix * fix * fix * fix
ota-meshi · Jan 16, 2024 · ad02846 · ad02846
1 parent 493e7c2
commit ad02846
Show file tree

Hide file tree

Showing 21 changed files with 78 additions and 42 deletions.
diff --git a/.github/workflows/NodeCI.yml b/.github/workflows/NodeCI.yml
@@ -12,10 +12,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
-        with:
-          node-version: 16
       - name: Install Packages
-        run: npm i --legacy-peer-deps
+        run: npm i -f
       - name: Build
         run: npm run build
       - name: Lint
@@ -35,6 +33,18 @@ jobs:
         run: npm i --legacy-peer-deps
       - name: Test
         run: npm test
+  test-with-eslint9:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - name: Install Target Packages
+        run: |+
+          npm i -D eslint@^9.0.0-0 -f
+          npx rimraf node_modules
+          npm install -f
+      - name: Test
+        run: npm test
   test-with-eslint6:
     runs-on: ubuntu-latest
     steps:

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -15,8 +15,8 @@
   "css.validate": false,
   "typescript.tsdk": "node_modules/typescript/lib",
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true,
-    "source.fixAll.stylelint": true
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.stylelint": "explicit"
   },
   "stylelint.validate": [
     "css",

diff --git a/lib/configs/recommended.ts b/lib/configs/recommended.ts
@@ -1,3 +1,5 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore
+// @ts-ignore -- Backwards compatibility
 export = {
   plugins: ["node-dependencies"],
   overrides: [

diff --git a/lib/index.ts b/lib/index.ts
@@ -15,6 +15,8 @@ const rules = ruleList.reduce(
   {} as { [key: string]: RuleModule },
 );
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore
+// @ts-ignore -- Backwards compatibility
 export = {
   meta,
   configs,

diff --git a/lib/utils/package-json/index.ts b/lib/utils/package-json/index.ts
@@ -1,4 +1,6 @@
+// @ts-expect-error -- I don't know how to set the tsconfig...
 import { createSyncFn } from "synckit";
+// @ts-expect-error -- I don't know how to set the tsconfig...
 import type { AbbreviatedMetadata, Options } from "package-json";
 type SyncPackageJson = (
   packageName: string,

diff --git a/lib/utils/package-json/worker.ts b/lib/utils/package-json/worker.ts
@@ -1,5 +1,8 @@
+// @ts-expect-error -- I don't know how to set the tsconfig...
 import type packageJson from "package-json";
+// @ts-expect-error -- I don't know how to set the tsconfig...
 import type { Options } from "package-json";
+// @ts-expect-error -- I don't know how to set the tsconfig...
 import { runAsWorker } from "synckit";
 // @ts-expect-error -- no types
 import tunnel from "tunnel-agent";

diff --git a/package.json b/package.json
@@ -71,6 +71,7 @@
     "chai": "^5.0.0",
     "env-cmd": "^10.1.0",
     "eslint": "^8.0.0",
+    "eslint-compat-utils": "^0.3.3",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-eslint-plugin": "^5.0.0",

diff --git a/tests/lib/eslint-plugin.ts b/tests/lib/eslint-plugin.ts
@@ -1,7 +1,9 @@
 import path from "path";
 import assert from "assert";
-import { ESLint } from "eslint";
+import { getLegacyESLint } from "eslint-compat-utils/eslint";
 import plugin from "../../lib/index";
+// eslint-disable-next-line @typescript-eslint/naming-convention -- ignore
+const ESLint = getLegacyESLint();
 
 // -----------------------------------------------------------------------------
 // Tests

diff --git a/tests/lib/rules/absolute-version.ts b/tests/lib/rules/absolute-version.ts
@@ -1,9 +1,10 @@
-import { RuleTester } from "eslint";
+import { RuleTester } from "../utils/compat-eslint";
 import rule from "../../../lib/rules/absolute-version";
 
+import * as jsoncParser from "jsonc-eslint-parser";
 const tester = new RuleTester({
-  parser: require.resolve("jsonc-eslint-parser"),
-  parserOptions: {
+  languageOptions: {
+    parser: jsoncParser,
     ecmaVersion: 2020,
     sourceType: "module",
   },

diff --git a/tests/lib/rules/compat-engines.ts b/tests/lib/rules/compat-engines.ts
@@ -1,9 +1,10 @@
-import { RuleTester } from "eslint";
+import { RuleTester } from "../utils/compat-eslint";
 import rule from "../../../lib/rules/compat-engines";
 
+import * as jsoncParser from "jsonc-eslint-parser";
 const tester = new RuleTester({
-  parser: require.resolve("jsonc-eslint-parser"),
-  parserOptions: {
+  languageOptions: {
+    parser: jsoncParser,
     ecmaVersion: 2020,
     sourceType: "module",
   },

diff --git a/tests/lib/rules/no-deprecated.ts b/tests/lib/rules/no-deprecated.ts
@@ -1,9 +1,10 @@
-import { RuleTester } from "eslint";
+import { RuleTester } from "../utils/compat-eslint";
 import rule from "../../../lib/rules/no-deprecated";
 
+import * as jsoncParser from "jsonc-eslint-parser";
 const tester = new RuleTester({
-  parser: require.resolve("jsonc-eslint-parser"),
-  parserOptions: {
+  languageOptions: {
+    parser: jsoncParser,
     ecmaVersion: 2020,
     sourceType: "module",
   },

diff --git a/tests/lib/rules/no-dupe-deps.ts b/tests/lib/rules/no-dupe-deps.ts
@@ -1,9 +1,10 @@
-import { RuleTester } from "eslint";
+import { RuleTester } from "../utils/compat-eslint";
 import rule from "../../../lib/rules/no-dupe-deps";
 
+import * as jsoncParser from "jsonc-eslint-parser";
 const tester = new RuleTester({
-  parser: require.resolve("jsonc-eslint-parser"),
-  parserOptions: {
+  languageOptions: {
+    parser: jsoncParser,
     ecmaVersion: 2020,
     sourceType: "module",
   },

diff --git a/tests/lib/rules/no-restricted-deps.ts b/tests/lib/rules/no-restricted-deps.ts
@@ -1,9 +1,10 @@
-import { RuleTester } from "eslint";
+import { RuleTester } from "../utils/compat-eslint";
 import rule from "../../../lib/rules/no-restricted-deps";
 
+import * as jsoncParser from "jsonc-eslint-parser";
 const tester = new RuleTester({
-  parser: require.resolve("jsonc-eslint-parser"),
-  parserOptions: {
+  languageOptions: {
+    parser: jsoncParser,
     ecmaVersion: 2020,
     sourceType: "module",
   },

diff --git a/tests/lib/rules/prefer-caret-range-version.ts b/tests/lib/rules/prefer-caret-range-version.ts
@@ -1,9 +1,10 @@
-import { RuleTester } from "eslint";
+import { RuleTester } from "../utils/compat-eslint";
 import rule from "../../../lib/rules/prefer-caret-range-version";
 
+import * as jsoncParser from "jsonc-eslint-parser";
 const tester = new RuleTester({
-  parser: require.resolve("jsonc-eslint-parser"),
-  parserOptions: {
+  languageOptions: {
+    parser: jsoncParser,
     ecmaVersion: 2020,
     sourceType: "module",
   },

diff --git a/tests/lib/rules/prefer-tilde-range-version.ts b/tests/lib/rules/prefer-tilde-range-version.ts
@@ -1,9 +1,10 @@
-import { RuleTester } from "eslint";
+import { RuleTester } from "../utils/compat-eslint";
 import rule from "../../../lib/rules/prefer-tilde-range-version";
 
+import * as jsoncParser from "jsonc-eslint-parser";
 const tester = new RuleTester({
-  parser: require.resolve("jsonc-eslint-parser"),
-  parserOptions: {
+  languageOptions: {
+    parser: jsoncParser,
     ecmaVersion: 2020,
     sourceType: "module",
   },

diff --git a/tests/lib/rules/valid-engines.ts b/tests/lib/rules/valid-engines.ts
@@ -1,9 +1,10 @@
-import { RuleTester } from "eslint";
+import { RuleTester } from "../utils/compat-eslint";
 import rule from "../../../lib/rules/valid-engines";
 
+import * as jsoncParser from "jsonc-eslint-parser";
 const tester = new RuleTester({
-  parser: require.resolve("jsonc-eslint-parser"),
-  parserOptions: {
+  languageOptions: {
+    parser: jsoncParser,
     ecmaVersion: 2020,
     sourceType: "module",
   },

diff --git a/tests/lib/rules/valid-semver.ts b/tests/lib/rules/valid-semver.ts
@@ -1,9 +1,9 @@
-import { RuleTester } from "eslint";
+import { RuleTester } from "../utils/compat-eslint";
 import rule from "../../../lib/rules/valid-semver";
-
+import * as jsoncParser from "jsonc-eslint-parser";
 const tester = new RuleTester({
-  parser: require.resolve("jsonc-eslint-parser"),
-  parserOptions: {
+  languageOptions: {
+    parser: jsoncParser,
     ecmaVersion: 2020,
     sourceType: "module",
   },

diff --git a/tests/lib/utils/compat-eslint.ts b/tests/lib/utils/compat-eslint.ts
@@ -0,0 +1,3 @@
+import { getRuleTester } from "eslint-compat-utils/rule-tester";
+// eslint-disable-next-line @typescript-eslint/naming-convention -- class name
+export const RuleTester = getRuleTester();
diff --git a/tools/new-rule.ts b/tools/new-rule.ts
@@ -49,16 +49,17 @@ export default createRule("${ruleId}", {
   );
   fs.writeFileSync(
     testFile,
-    `import { RuleTester } from "eslint"
+    `import { RuleTester } from "../utils/compat-eslint"
 import rule from "../../../lib/rules/${ruleId}"
+import * as jsoncParser from "jsonc-eslint-parser";
 
 const tester = new RuleTester({
-    parser: require.resolve("jsonc-eslint-parser"),
-    parserOptions: {
-        ecmaVersion: 2020,
-        sourceType: "module",
-    },
-})
+  languageOptions: {
+    parser: jsoncParser,
+    ecmaVersion: 2020,
+    sourceType: "module",
+  },
+});
 
 tester.run("${ruleId}", rule as any, {
     valid: [

diff --git a/tools/update-rulesets.ts b/tools/update-rulesets.ts
@@ -4,6 +4,8 @@ import fs from "fs";
 import { rules } from "./lib/load-rules";
 
 const content = `
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore
+// @ts-ignore -- Backwards compatibility
 export = {
     plugins: ["node-dependencies"],
     overrides: [

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "es2015",
-    "module": "commonjs",
+    "module": "node16",
     "lib": ["es2020"],
     "allowJs": true,
     "checkJs": true,