Chores: Replace CLIEngine with ESLint class. (#218)

* Chores: Replace CLIEngine with ESLint class.

* fix

* fix

Author: ota-meshi

docs/rules/README.md

@@ -35,4 +35,3 @@
 | Rule ID | Description |    |
 |:--------|:------------|:---|
 | [@intlify/vue-i18n/<wbr>prefer-linked-key-with-paren](./prefer-linked-key-with-paren.html) | enforce linked key to be enclosed in parentheses | :black_nib: |
-

lib/rules/no-unused-keys.ts

@@ -560,6 +560,7 @@ export = {
       recommended: false
     },
     fixable: 'code',
+    hasSuggestions: true,
     schema: [
       {
         type: 'object',

lib/utils/collect-keys.ts

@@ -97,7 +97,6 @@ function getParser(
  * Collect the used keys from source code text.
  * @param {string} text
  * @param {string} filename
- * @param {CLIEngine} cliEngine
  * @returns {string[]}
  */
 function collectKeysFromText(

scripts/lib/eslint-compat.ts

@@ -0,0 +1,76 @@
+// @ts-check
+import * as eslint from 'eslint'
+
+// eslint-disable-next-line @typescript-eslint/no-namespace -- ignore
+export namespace ESLint {
+  export type LintResult = eslint.ESLint.LintResult
+}
+export const ESLint = eslint.ESLint || getESLintClassForV6()
+
+function getESLintClassForV6(): typeof eslint.ESLint {
+  class ESLintForV6 {
+    private engine: eslint.CLIEngine
+    static get version() {
+      return eslint.CLIEngine.version
+    }
+
+    constructor(options?: eslint.ESLint.Options) {
+      const {
+        overrideConfig: { plugins, globals, rules, ...overrideConfig } = {
+          plugins: [],
+          globals: {},
+          rules: {}
+        },
+        fix,
+        reportUnusedDisableDirectives,
+        plugins: pluginsMap,
+        ...otherOptions
+      } = options || {}
+      const newOptions: eslint.CLIEngine.Options = {
+        fix: Boolean(fix),
+        reportUnusedDisableDirectives: reportUnusedDisableDirectives
+          ? reportUnusedDisableDirectives !== 'off'
+          : undefined,
+        ...otherOptions,
+
+        globals: globals
+          ? Object.keys(globals).filter(n => globals[n])
+          : undefined,
+        plugins: plugins || [],
+        rules: rules
+          ? Object.entries(rules).reduce((o, [ruleId, opt]) => {
+              if (opt) {
+                o[ruleId] = opt
+              }
+              return o
+            }, {} as NonNullable<eslint.CLIEngine.Options['rules']>)
+          : undefined,
+        ...overrideConfig
+      }
+      this.engine = new eslint.CLIEngine(newOptions)
+
+      for (const [name, plugin] of Object.entries(pluginsMap || {})) {
+        this.engine.addPlugin(name, plugin)
+      }
+    }
+
+    async lintText(
+      ...params: Parameters<eslint.ESLint['lintText']>
+    ): ReturnType<eslint.ESLint['lintText']> {
+      const result = this.engine.executeOnText(params[0], params[1]?.filePath)
+      return result.results
+    }
+
+    async lintFiles(
+      ...params: Parameters<eslint.ESLint['lintFiles']>
+    ): ReturnType<eslint.ESLint['lintFiles']> {
+      const result = this.engine.executeOnFiles(
+        Array.isArray(params[0]) ? params[0] : [params[0]]
+      )
+      return result.results
+    }
+  }
+
+  const eslintClass = ESLintForV6 as never
+  return eslintClass
+}

scripts/lib/utils.ts

@@ -5,12 +5,12 @@
  */
 import { readdirSync, existsSync } from 'fs'
 import { basename, extname, join } from 'path'
-import { CLIEngine } from 'eslint'
-const linter = new CLIEngine({ fix: true })
+import { ESLint } from '../lib/eslint-compat'
+const eslint = new ESLint({ fix: true })
 
-function format(text: string, filename: string): string {
-  const lintResult = linter.executeOnText(text, filename)
-  return lintResult.results[0].output || text
+async function format(text: string, filename: string): Promise<string> {
+  const lintResults = await eslint.lintText(text, { filePath: filename })
+  return lintResults[0].output || text
 }
 
 /**
@@ -20,7 +20,11 @@ function camelCase(str: string) {
   return str.replace(/[-_](\w)/gu, (_, c) => (c ? c.toUpperCase() : ''))
 }
 
-function createIndex(dirPath: string, prefix = '', all = false): string {
+async function createIndex(
+  dirPath: string,
+  prefix = '',
+  all = false
+): Promise<string> {
   const dirName = basename(dirPath)
   const tsFiles = readdirSync(dirPath)
     .filter(

scripts/update-recommended-rules.ts

@@ -8,11 +8,14 @@ import { resolve } from 'path'
 import rules from './lib/rules'
 import { format } from './lib/utils'
 
-// recommended.ts
-writeFileSync(
-  resolve(__dirname, '../lib/configs/recommended.ts'),
-  format(
-    `/** DON'T EDIT THIS FILE; was created by scripts. */
+main()
+
+async function main() {
+  // recommended.ts
+  writeFileSync(
+    resolve(__dirname, '../lib/configs/recommended.ts'),
+    await format(
+      `/** DON'T EDIT THIS FILE; was created by scripts. */
 export = {
   extends: [require.resolve('./base')],
   parserOptions: {
@@ -33,6 +36,7 @@ export = {
       .join('\n        ')}
   },
 }`,
-    resolve(__dirname, '../lib/configs/recommended.ts')
+      resolve(__dirname, '../lib/configs/recommended.ts')
+    )
   )
-)
+}

scripts/update.ts

@@ -15,12 +15,16 @@ import './update-docs-index'
 // recommended rules.
 import './update-recommended-rules'
 
-// indices.
-for (const pairs of [
-  [resolve(__dirname, '../lib/configs')],
-  [resolve(__dirname, '../lib/rules')],
-  [resolve(__dirname, '../lib/utils'), '', true]
-] as const) {
-  const [dirPath, prefix, all] = pairs
-  writeFileSync(`${dirPath}.ts`, createIndex(dirPath, prefix, all))
+main()
+
+async function main() {
+  // indices.
+  for (const pairs of [
+    [resolve(__dirname, '../lib/configs')],
+    [resolve(__dirname, '../lib/rules')],
+    [resolve(__dirname, '../lib/utils'), '', true]
+  ] as const) {
+    const [dirPath, prefix, all] = pairs
+    writeFileSync(`${dirPath}.ts`, await createIndex(dirPath, prefix, all))
+  }
 }

tests-integrations/config-recommended.js

@@ -18,23 +18,20 @@ describe('Integration with "plugin:@intlify/vue-i18n/recommended"', () => {
     process.chdir(originalCwd)
   })
 
-  it('should work with shareable config', () => {
-    const CLIEngine = require('./config-recommended/node_modules/eslint')
-      .CLIEngine
-    const engine = new CLIEngine({
+  it('should work with shareable config', async () => {
+    const ESLint = require('./config-recommended/node_modules/eslint').ESLint
+    const engine = new ESLint({
       cwd: TEST_CWD,
       extensions: ['.js', '.vue', '.json']
     })
-    const result = engine.executeOnFiles(['./src'])
-    const enJson = result.results.find(
-      r => path.basename(r.filePath) === 'en.json'
-    )
+    const results = await engine.lintFiles(['./src'])
+    const enJson = results.find(r => path.basename(r.filePath) === 'en.json')
     assert.strictEqual(enJson.messages.length, 1)
     assert.strictEqual(
       enJson.messages[0].ruleId,
       '@intlify/vue-i18n/no-html-messages'
     )
-    const aVue = result.results.find(r => path.basename(r.filePath) === 'a.vue')
+    const aVue = results.find(r => path.basename(r.filePath) === 'a.vue')
     assert.strictEqual(aVue.messages.length, 1)
     assert.strictEqual(
       aVue.messages[0].ruleId,