feat: Resolve getAncestors and getScope calls in eslint v9 (#466)

Co-authored-by: 唯然 <[email protected]>
eslint-community · May 27, 2024 · c0c716b · c0c716b
1 parent 7d33c30
commit c0c716b
Show file tree

Hide file tree

Showing 27 changed files with 220 additions and 55 deletions.
diff --git a/__tests__/always-return.js b/__tests__/always-return.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/always-return')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 11,

diff --git a/__tests__/avoid-new.js b/__tests__/avoid-new.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/avoid-new')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 6,

diff --git a/__tests__/catch-or-return.js b/__tests__/catch-or-return.js
@@ -1,8 +1,12 @@
 'use strict'
 
 const rule = require('../rules/catch-or-return')
-const RuleTester = require('eslint').RuleTester
-const ruleTester = new RuleTester()
+const { RuleTester } = require('./rule-tester')
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 6,
+  },
+})
 
 const catchMessage = 'Expected catch() or return'
 const doneMessage = 'Expected done() or return'
@@ -19,10 +23,7 @@ ruleTester.run('catch-or-return', rule, {
     'frank.then(to).finally(fn).catch(jail)',
 
     // arrow function use case
-    {
-      code: 'postJSON("/smajobber/api/reportJob.json")\n\t.then(()=>this.setState())\n\t.catch(()=>this.setState())',
-      parserOptions: { ecmaVersion: 6 },
-    },
+    'postJSON("/smajobber/api/reportJob.json")\n\t.then(()=>this.setState())\n\t.catch(()=>this.setState())',
 
     // return
     'function a() { return frank().then(go) }',

diff --git a/__tests__/no-callback-in-promise.js b/__tests__/no-callback-in-promise.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/no-callback-in-promise')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 6,

diff --git a/__tests__/no-multiple-resolved.js b/__tests__/no-multiple-resolved.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/no-multiple-resolved')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 2020,

diff --git a/__tests__/no-native.js b/__tests__/no-native.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/no-native')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const parserOptions = {
   ecmaVersion: 6,
   sourceType: 'module',

diff --git a/__tests__/no-nesting.js b/__tests__/no-nesting.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/no-nesting')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 6,

diff --git a/__tests__/no-new-statics.js b/__tests__/no-new-statics.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/no-new-statics')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester()
 
 ruleTester.run('no-new-statics', rule, {

diff --git a/__tests__/no-promise-in-callback.js b/__tests__/no-promise-in-callback.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/no-promise-in-callback')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 6,

diff --git a/__tests__/no-return-in-finally.js b/__tests__/no-return-in-finally.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const rule = require('../rules/no-return-in-finally')
 const ruleTester = new RuleTester({
   parserOptions: {

diff --git a/__tests__/no-return-wrap.js b/__tests__/no-return-wrap.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/no-return-wrap')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 6,

diff --git a/__tests__/param-names.js b/__tests__/param-names.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/param-names')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 6,

diff --git a/__tests__/prefer-await-to-callbacks.js b/__tests__/prefer-await-to-callbacks.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/prefer-await-to-callbacks')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 8,

diff --git a/__tests__/prefer-await-to-then.js b/__tests__/prefer-await-to-then.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/prefer-await-to-then')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 8,

diff --git a/__tests__/rule-tester.js b/__tests__/rule-tester.js
@@ -0,0 +1,68 @@
+/**
+ * @fileoverview Helpers for tests.
+ * @author 唯然<[email protected]>
+ */
+'use strict'
+const { version } = require('eslint/package.json')
+const { RuleTester } = require('eslint')
+const globals = require('globals')
+
+const majorVersion = Number.parseInt(version.split('.')[0], 10)
+
+function convertConfig(config) {
+  if (config instanceof Object === false) {
+    return config
+  }
+
+  if (config.languageOptions == null) {
+    config.languageOptions = {}
+  }
+
+  if (config.parserOptions) {
+    Object.assign(config.languageOptions, config.parserOptions)
+    delete config.parserOptions
+  }
+
+  if (typeof config.parser === 'string') {
+    config.languageOptions.parser = require(config.parser)
+    delete config.parser
+  }
+
+  if (config.globals instanceof Object) {
+    config.languageOptions.globals = config.globals
+    delete config.globals
+  }
+
+  if (config.env instanceof Object) {
+    if (config.languageOptions.globals == null) {
+      config.languageOptions.globals = {}
+    }
+
+    for (const key in config.env) {
+      Object.assign(config.languageOptions.globals, globals[key])
+    }
+
+    delete config.env
+  }
+
+  delete config.parserOptions
+  delete config.parser
+
+  return config
+}
+
+exports.RuleTester = function (config = {}) {
+  if (majorVersion <= 8) {
+    return new RuleTester(config)
+  }
+
+  const ruleTester = new RuleTester(convertConfig(config))
+  const $run = ruleTester.run.bind(ruleTester)
+  ruleTester.run = function (name, rule, tests) {
+    tests.valid = tests.valid.map(convertConfig)
+    tests.invalid = tests.invalid.map(convertConfig)
+
+    $run(name, rule, tests)
+  }
+  return ruleTester
+}
diff --git a/__tests__/valid-params.js b/__tests__/valid-params.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const rule = require('../rules/valid-params')
-const RuleTester = require('eslint').RuleTester
+const { RuleTester } = require('./rule-tester')
 const ruleTester = new RuleTester({
   parserOptions: {
     ecmaVersion: 6,

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -55,7 +55,15 @@
         "lines": 100,
         "statements": 100
       }
-    }
+    },
+    "collectCoverageFrom": [
+      "rules/*.js",
+      "rules/*/*.js",
+      "!rules/lib/eslint-compat.js"
+    ],
+    "testPathIgnorePatterns": [
+      "__tests__/rule-tester.js"
+    ]
   },
   "devDependencies": {
     "@typescript-eslint/parser": "^5.45.0",
@@ -67,6 +75,7 @@
     "eslint-plugin-jest": "^26.9.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.2.1",
+    "globals": "^14.0.0",
     "husky": "^7.0.4",
     "jest": "^28.1.3",
     "lint-staged": "^12.5.0",
@@ -75,7 +84,7 @@
     "typescript": "^4.9.3"
   },
   "peerDependencies": {
-    "eslint": "^7.0.0 || ^8.0.0"
+    "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0"
   },
   "engines": {
     "node": "^12.22.0 || ^14.17.0 || >=16.0.0"