Chore: add test for eslint v9 (#2368)

Author: ota-meshi

.github/workflows/CI.yml

@@ -26,8 +26,18 @@ jobs:
     name: Test
     strategy:
       matrix:
-        node: [17, 18, 20]
+        node: [18, 20]
         os: [ubuntu-latest]
+        eslint: [8]
+        include:
+          # On next ESLint version
+          - eslint: ^9.0.0-0
+            node: 20
+            os: ubuntu-latest
+          # On old Node version
+          - eslint: 8
+            node: 17
+            os: ubuntu-latest
 
     runs-on: ${{ matrix.os }}
     steps:
@@ -39,6 +49,8 @@ jobs:
         node-version: ${{ matrix.node }}
     - name: Install Packages
       run: npm install --legacy-peer-deps
+    - name: Install ESLint v${{ matrix.eslint }}
+      run: npm install --save-dev eslint@${{ matrix.eslint }} --legacy-peer-deps
     - name: Test
       run: npm test
 

lib/utils/index.js

@@ -673,6 +673,7 @@ module.exports = {
    */
   wrapCoreRule,
   wrapStylisticOrCoreRule,
+  getCoreRule,
   /**
    * Checks whether the given value is defined.
    * @template T

tests/eslint-compat.js

@@ -1,15 +1,66 @@
 // @ts-check
 const eslint = require('eslint')
+const semver = require('semver')
+
+let ESLint = eslint.ESLint
+let Linter = eslint.Linter
+let RuleTester = eslint.RuleTester
+if (semver.lt(eslint.Linter.version, '9.0.0-0')) {
+  ESLint = eslint.ESLint ? getESLintClassForV8() : getESLintClassForV6()
+  Linter = getLinterClassForV8()
+  RuleTester = getRuleTesterClassForV8()
+}
 
 module.exports = {
-  ESLint: eslint.ESLint || getESLintClassForV6(),
-  RuleTester: eslint.RuleTester
+  ESLint,
+  RuleTester,
+  Linter
 }
 
+/** @returns {typeof eslint.ESLint} */
+function getESLintClassForV8(BaseESLintClass = eslint.ESLint) {
+  return class ESLintForV8 extends BaseESLintClass {
+    static get version() {
+      return BaseESLintClass.version
+    }
+    constructor(options) {
+      super(adjustOptions(options))
+    }
+  }
+
+  // eslint-disable-next-line unicorn/consistent-function-scoping
+  function adjustOptions(options) {
+    const newOptions = {
+      ...options,
+      useEslintrc: false
+    }
+    if (newOptions.overrideConfig) {
+      newOptions.overrideConfig = { ...newOptions.overrideConfig }
+      let plugins
+      if (newOptions.overrideConfig.plugins) {
+        plugins = newOptions.overrideConfig.plugins
+        delete newOptions.overrideConfig.plugins
+      }
+      newOptions.overrideConfig = processCompatibleConfig(
+        newOptions.overrideConfig
+      )
+      if (plugins) {
+        newOptions.overrideConfig.plugins = Object.keys(plugins)
+        newOptions.plugins = plugins
+      }
+
+      // adjust
+      delete newOptions.overrideConfig.files
+      delete newOptions.overrideConfig.processor
+    }
+    return newOptions
+  }
+}
 /** @returns {typeof eslint.ESLint} */
 function getESLintClassForV6() {
   class ESLintForV6 {
     static get version() {
+      // @ts-expect-error
       return eslint.CLIEngine.version
     }
 
@@ -26,7 +77,7 @@ function getESLintClassForV6() {
         plugins: pluginsMap,
         ...otherOptions
       } = options || {}
-      /** @type {eslint.CLIEngine.Options} */
+
       const newOptions = {
         fix: Boolean(fix),
         reportUnusedDisableDirectives: reportUnusedDisableDirectives
@@ -47,6 +98,8 @@ function getESLintClassForV6() {
           : undefined,
         ...overrideConfig
       }
+
+      // @ts-expect-error
       this.engine = new eslint.CLIEngine(newOptions)
 
       for (const [name, plugin] of Object.entries(pluginsMap || {})) {
@@ -59,12 +112,105 @@ function getESLintClassForV6() {
      * @returns {ReturnType<eslint.ESLint['lintText']>}
      */
     async lintText(...params) {
-      const result = this.engine.executeOnText(params[0], params[1].filePath)
+      const result = this.engine.executeOnText(params[0], params[1]?.filePath)
       return result.results
     }
   }
 
   /** @type {typeof eslint.ESLint} */
   const eslintClass = /** @type {any} */ (ESLintForV6)
-  return eslintClass
+  return getESLintClassForV8(eslintClass)
+}
+
+/** @returns {typeof eslint.Linter} */
+function getLinterClassForV8() {
+  return class LinterForV8 extends eslint.Linter {
+    static get version() {
+      return eslint.Linter.version
+    }
+    verify(code, config, option) {
+      return super.verify(code, processCompatibleConfig(config, this), option)
+    }
+  }
+}
+
+function getRuleTesterClassForV8() {
+  return class RuleTesterForV8 extends eslint.RuleTester {
+    constructor(options) {
+      const defineRules = []
+      super(
+        processCompatibleConfig(options, {
+          defineRule(...args) {
+            defineRules.push(args)
+          }
+        })
+      )
+      for (const args of defineRules) {
+        // @ts-expect-error
+        this.linter.defineRule(...args)
+      }
+    }
+    run(name, rule, tests) {
+      super.run(name, rule, {
+        valid: (tests.valid || []).map((test) =>
+          typeof test === 'string' ? test : adjustOptions(test)
+        ),
+        invalid: (tests.invalid || []).map((test) => adjustOptions(test))
+      })
+    }
+  }
+  // eslint-disable-next-line unicorn/consistent-function-scoping
+  function adjustOptions(test) {
+    return processCompatibleConfig(test)
+  }
+}
+
+function processCompatibleConfig(config, linter) {
+  const newConfig = { ...config }
+  if (newConfig.languageOptions) {
+    const languageOptions = newConfig.languageOptions
+    delete newConfig.languageOptions
+    newConfig.parserOptions = {
+      ...newConfig.parserOptions,
+      ...languageOptions,
+      ...languageOptions.parserOptions
+    }
+    if (languageOptions.globals) {
+      newConfig.globals = {
+        ...newConfig.globals,
+        ...languageOptions.globals
+      }
+    }
+    if (languageOptions.parser) {
+      newConfig.parser = getParserName(languageOptions.parser)
+      if (!languageOptions.parserOptions?.parser) {
+        delete newConfig.parserOptions.parser
+      }
+      linter?.defineParser?.(newConfig.parser, require(newConfig.parser))
+    }
+  }
+  if (newConfig.plugins) {
+    const plugins = newConfig.plugins
+    delete newConfig.plugins
+    for (const [pluginName, plugin] of Object.entries(plugins)) {
+      for (const [ruleName, rule] of Object.entries(plugin.rules || {})) {
+        linter.defineRule(`${pluginName}/${ruleName}`, rule)
+      }
+    }
+  }
+  newConfig.env = { ...newConfig.env, es6: true }
+  return newConfig
+}
+
+function getParserName(parser) {
+  const name = parser.meta?.name || parser.name
+  if (name === 'typescript-eslint/parser') {
+    return require.resolve('@typescript-eslint/parser')
+  } else if (
+    name == null &&
+    // @ts-expect-error
+    parser === require('@typescript-eslint/parser')
+  )
+    return require.resolve('@typescript-eslint/parser')
+  return require.resolve(name)
 }

tests/fixtures/script-indent/jsx-01.vue

@@ -1,4 +1,4 @@
-<!--{ "parserOptions": { "ecmaFeatures": { "jsx": true } } }-->
+<!--{ "languageOptions": { "parserOptions": {"ecmaFeatures": { "jsx": true }} } }-->
 <script>
 // Not yet supported.
 const jsx = <

tests/fixtures/script-indent/jsx-02.vue

@@ -1,4 +1,4 @@
-<!--{ "parserOptions": { "ecmaFeatures": { "jsx": true } } }-->
+<!--{ "languageOptions": { "parserOptions": {"ecmaFeatures": { "jsx": true }} } }-->
 <script>
 // Not yet supported.
 const jsx = <

tests/fixtures/script-indent/ts-abstract-accessor-property-01.vue

@@ -1,4 +1,4 @@
-<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}, "requirements": { "@typescript-eslint/parser": ">=5.44.1-alpha.15"}}-->
+<!--{"languageOptions": {"parserOptions": {"parser":"@typescript-eslint/parser"}}, "requirements": { "@typescript-eslint/parser": ">=5.44.1-alpha.15"}}-->
 <script lang="ts">
 abstract class Foo {
   abstract accessor

tests/fixtures/script-indent/ts-abstract-class-property-01.vue

@@ -1,4 +1,4 @@
-<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<!--{"languageOptions": {"parserOptions": {"parser":"@typescript-eslint/parser"}}}-->
 <script lang="ts">
 abstract class A {
   abstract a;

tests/fixtures/script-indent/ts-abstract-class-property-02.vue

@@ -1,4 +1,4 @@
-<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<!--{"languageOptions": {"parserOptions": {"parser":"@typescript-eslint/parser"}}}-->
 <script lang="ts">
 abstract class A {
   a

tests/fixtures/script-indent/ts-abstract-method-definition-01.vue

@@ -1,4 +1,4 @@
-<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<!--{"languageOptions": {"parserOptions": {"parser":"@typescript-eslint/parser"}}}-->
 <script lang="ts">
 abstract class A {
   abstract a ();

tests/fixtures/script-indent/ts-accessor-property-01.vue

@@ -1,4 +1,4 @@
-<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}, "requirements": { "@typescript-eslint/parser": ">=5.44.1-alpha.15"}}-->
+<!--{"languageOptions": {"parserOptions": {"parser":"@typescript-eslint/parser"}}, "requirements": { "@typescript-eslint/parser": ">=5.44.1-alpha.15"}}-->
 <script lang="ts">
 class Foo {
   accessor