Replace ESLint CLIEngine with @eslint/eslintrc (#206)

Author: ota-meshi

docs/.vuepress/config.js

@@ -18,6 +18,10 @@ module.exports = {
           module: require.resolve('./shim/module'),
           glob: require.resolve('./shim/glob'),
           eslint: path.resolve(__dirname, './shim/eslint'),
+          '@eslint/eslintrc$': path.resolve(
+            __dirname,
+            './shim/@eslint/eslintrc'
+          ),
           fs: require.resolve('./shim/fs'),
           [path.resolve(
             __dirname,

docs/.vuepress/shim/@eslint/eslintrc/index.js

@@ -0,0 +1,19 @@
+class CascadingConfigArrayFactory {
+  getConfigArrayForFile() {
+    return this
+  }
+  extractConfig() {
+    return this
+  }
+  toCompatibleObjectAsConfigFileContent() {
+    return {
+      parser: 'vue-eslint-parser',
+      parserOptions: {
+        sourceType: 'module'
+      }
+    }
+  }
+}
+export const Legacy = {
+  CascadingConfigArrayFactory
+}

docs/.vuepress/shim/eslint/index.js

@@ -1,13 +1,2 @@
 import { SourceCode } from '../../../../node_modules/eslint/lib/source-code'
 export { SourceCode }
-export class CLIEngine {
-  addPlugin() {}
-  getConfigForFile() {
-    return {
-      parser: 'vue-eslint-parser',
-      parserOptions: {
-        sourceType: 'module'
-      }
-    }
-  }
-}

files/empty.json

@@ -0,0 +1 @@
+{}

lib/utils/collect-keys.ts

@@ -2,7 +2,7 @@
  * @fileoverview Collect localization keys
  * @author kazuya kawaguchi (a.k.a. kazupon)
  */
-import { CLIEngine } from 'eslint'
+import type { Linter } from 'eslint'
 import { parseForESLint, AST as VAST } from 'vue-eslint-parser'
 import { readFileSync } from 'fs'
 import { resolve, extname } from 'path'
@@ -12,7 +12,10 @@ import { CacheLoader } from './cache-loader'
 import { defineCacheFunction } from './cache-function'
 import debugBuilder from 'debug'
 import type { VisitorKeys } from '../types'
+// @ts-expect-error -- ignore
+import { Legacy } from '@eslint/eslintrc'
 const debug = debugBuilder('eslint-plugin-vue-i18n:collect-keys')
+const { CascadingConfigArrayFactory } = Legacy
 
 /**
  *
@@ -100,11 +103,11 @@ function getParser(
 function collectKeysFromText(
   text: string,
   filename: string,
-  cliEngine: CLIEngine
+  getConfigForFile: (filePath: string) => Linter.Config<Linter.RulesRecord>
 ) {
   const effectiveFilename = filename || '<text>'
   debug(`collectKeysFromFile ${effectiveFilename}`)
-  const config = cliEngine.getConfigForFile(effectiveFilename)
+  const config = getConfigForFile(effectiveFilename)
   const parser = getParser(config.parser)
 
   const parserOptions = Object.assign({}, config.parserOptions, {
@@ -132,12 +135,15 @@ function collectKeysFromText(
  * Collect the used keys from files.
  * @returns {ResourceLoader[]}
  */
-function collectKeyResourcesFromFiles(fileNames: string[]) {
+function collectKeyResourcesFromFiles(fileNames: string[], cwd: string) {
   debug('collectKeysFromFiles', fileNames)
 
-  const cliEngine = new CLIEngine({})
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-  cliEngine.addPlugin('@intlify/vue-i18n', require('../index')) // for Test
+  const configArrayFactory = new CascadingConfigArrayFactory({
+    additionalPluginPool: new Map([['@intlify/vue-i18n', require('../index')]]),
+    cwd,
+    eslintRecommendedPath: require.resolve('../../files/empty.json'),
+    eslintAllPath: require.resolve('../../files/empty.json')
+  })
 
   const results = []
 
@@ -148,12 +154,20 @@ function collectKeyResourcesFromFiles(fileNames: string[]) {
     results.push(
       new ResourceLoader(resolve(filename), () => {
         const text = readFileSync(resolve(filename), 'utf8')
-        return collectKeysFromText(text, filename, cliEngine)
+        return collectKeysFromText(text, filename, getConfigForFile)
       })
     )
   }
 
   return results
+
+  function getConfigForFile(filePath: string) {
+    const absolutePath = resolve(cwd, filePath)
+    return configArrayFactory
+      .getConfigArrayForFile(absolutePath)
+      .extractConfig(absolutePath)
+      .toCompatibleObjectAsConfigFileContent()
+  }
 }
 
 /**
@@ -246,9 +260,11 @@ class UsedKeysCache {
         .filter(f => !f.ignored && extensions.includes(extname(f.filename)))
         .map(f => f.filename)
     })
-    this._collectKeyResourcesFromFiles = defineCacheFunction(fileNames => {
-      return collectKeyResourcesFromFiles(fileNames)
-    })
+    this._collectKeyResourcesFromFiles = defineCacheFunction(
+      (fileNames, cwd) => {
+        return collectKeyResourcesFromFiles(fileNames, cwd)
+      }
+    )
   }
   /**
    * Collect the used keys from files.

package.json

@@ -24,6 +24,7 @@
     }
   },
   "dependencies": {
+    "@eslint/eslintrc": "^0.4.2",
     "@intlify/message-compiler": "^9.1.6",
     "@intlify/message-resolver": "^9.1.6",
     "debug": "^4.3.1",
@@ -75,7 +76,8 @@
     "node": ">=10.13.0 || >=12.0.0 || >= 14.0.0"
   },
   "files": [
-    "dist"
+    "dist",
+    "files"
   ],
   "homepage": "https://github.com/intlify/eslint-plugin-vue-i18n#readme",
   "keywords": [

yarn.lock

@@ -977,6 +977,21 @@
     minimatch "^3.0.4"
     strip-json-comments "^3.1.1"
 
+"@eslint/eslintrc@^0.4.2":
+  version "0.4.2"
+  resolved "https://registry.yarnpkg.com/@eslint/eslintrc/-/eslintrc-0.4.2.tgz#f63d0ef06f5c0c57d76c4ab5f63d3835c51b0179"
+  integrity sha512-8nmGq/4ycLpIwzvhI4tNDmQztZ8sp+hI7cyG8i1nQDhkAbRzHpXPidRAHlNvCZQpJTKw5ItIpMw9RSToGF00mg==
+  dependencies:
+    ajv "^6.12.4"
+    debug "^4.1.1"
+    espree "^7.3.0"
+    globals "^13.9.0"
+    ignore "^4.0.6"
+    import-fresh "^3.2.1"
+    js-yaml "^3.13.1"
+    minimatch "^3.0.4"
+    strip-json-comments "^3.1.1"
+
 "@intlify/message-compiler@^9.1.6":
   version "9.1.6"
   resolved "https://registry.yarnpkg.com/@intlify/message-compiler/-/message-compiler-9.1.6.tgz#e3e99165c1e6ecc496211017799ae59e15b05a18"
@@ -5186,6 +5201,13 @@ globals@^12.1.0:
   dependencies:
     type-fest "^0.8.1"
 
+globals@^13.9.0:
+  version "13.9.0"
+  resolved "https://registry.yarnpkg.com/globals/-/globals-13.9.0.tgz#4bf2bf635b334a173fb1daf7c5e6b218ecdc06cb"
+  integrity sha512-74/FduwI/JaIrr1H8e71UbDE+5x7pIPs1C2rrwC52SszOo043CsWOZEMW7o2Y58xwm9b+0RBKDxY5n2sUpEFxA==
+  dependencies:
+    type-fest "^0.20.2"
+
 globby@^10.0.1:
   version "10.0.2"
   resolved "https://registry.yarnpkg.com/globby/-/globby-10.0.2.tgz#277593e745acaa4646c3ab411289ec47a0392543"
@@ -10471,6 +10493,11 @@ type-fest@^0.11.0:
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.11.0.tgz#97abf0872310fed88a5c466b25681576145e33f1"
   integrity sha512-OdjXJxnCN1AvyLSzeKIgXTXxV+99ZuXl3Hpo9XpJAv9MBcHrrJOQ5kV7ypXOuQie+AmWG25hLbiKdwYTifzcfQ==
 
+type-fest@^0.20.2:
+  version "0.20.2"
+  resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.20.2.tgz#1bf207f4b28f91583666cb5fbd327887301cd5f4"
+  integrity sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==
+
 type-fest@^0.8.0, type-fest@^0.8.1:
   version "0.8.1"
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.8.1.tgz#09e249ebde851d3b1e48d27c105444667f17b83d"