feat: eslint v9.0.0 compatibility (fixes #143) (#144)

aladdin-add · web-flow · commit b075568b34b4 · 2023-12-11T11:04:11.000+08:00
refs: https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/
diff --git a/lib/rules/callback-return.js b/lib/rules/callback-return.js
@@ -26,7 +26,7 @@ module.exports = {
 
     create(context) {
         const callbacks = context.options[0] || ["callback", "cb", "next"]
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
 
         /**
          * Find the closest parent matching a list of types.
diff --git a/lib/rules/exports-style.js b/lib/rules/exports-style.js
@@ -258,7 +258,7 @@ module.exports = {
         const batchAssignAllowed = Boolean(
             context.options[1] != null && context.options[1].allowBatchAssign
         )
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
 
         /**
          * Gets the location info of reports.
@@ -286,8 +286,7 @@ module.exports = {
          *
          * @returns {void}
          */
-        function enforceModuleExports() {
-            const globalScope = context.getScope()
+        function enforceModuleExports(globalScope) {
             const exportsNodes = getExportsNodes(globalScope)
             const assignList = batchAssignAllowed
                 ? createAssignmentList(getModuleExportsNodes(globalScope))
@@ -317,8 +316,7 @@ module.exports = {
          *
          * @returns {void}
          */
-        function enforceExports() {
-            const globalScope = context.getScope()
+        function enforceExports(globalScope) {
             const exportsNodes = getExportsNodes(globalScope)
             const moduleExportsNodes = getModuleExportsNodes(globalScope)
             const assignList = batchAssignAllowed
@@ -370,13 +368,15 @@ module.exports = {
         }
 
         return {
-            "Program:exit"() {
+            "Program:exit"(node) {
+                const scope = sourceCode.getScope?.(node) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
+
                 switch (mode) {
                     case "module.exports":
-                        enforceModuleExports()
+                        enforceModuleExports(scope)
                         break
                     case "exports":
-                        enforceExports()
+                        enforceExports(scope)
                         break
 
                     // no default
diff --git a/lib/rules/file-extension-in-import.js b/lib/rules/file-extension-in-import.js
@@ -57,7 +57,7 @@ module.exports = {
         type: "suggestion",
     },
     create(context) {
-        if (context.getFilename().startsWith("<")) {
+        if ((context.filename ?? context.getFilename()).startsWith("<")) {
             return {}
         }
         const defaultStyle = context.options[0] || "always"
diff --git a/lib/rules/global-require.js b/lib/rules/global-require.js
@@ -64,16 +64,21 @@ module.exports = {
     },
 
     create(context) {
+        const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
+
         return {
             CallExpression(node) {
-                const currentScope = context.getScope()
+                const currentScope =
+                    sourceCode.getScope?.(node) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
 
                 if (
                     node.callee.name === "require" &&
                     !isShadowed(currentScope, node.callee)
                 ) {
-                    const isGoodRequire = context
-                        .getAncestors()
+                    const isGoodRequire = (
+                        sourceCode.getAncestors?.(node) ??
+                        context.getAncestors()
+                    ) // TODO: remove context.getAncestors() when dropping support for ESLint < v9
                         .every(
                             parent =>
                                 ACCEPTABLE_PARENTS.indexOf(parent.type) > -1
diff --git a/lib/rules/handle-callback-err.js b/lib/rules/handle-callback-err.js
@@ -24,6 +24,7 @@ module.exports = {
     },
 
     create(context) {
+        const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
         const errorArgument = context.options[0] || "err"
 
         /**
@@ -69,7 +70,7 @@ module.exports = {
          * @returns {void}
          */
         function checkForError(node) {
-            const scope = context.getScope()
+            const scope = sourceCode.getScope?.(node) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
             const parameters = getParameters(scope)
             const firstParameter = parameters[0]
 
diff --git a/lib/rules/no-deprecated-api.js b/lib/rules/no-deprecated-api.js
@@ -756,9 +756,12 @@ module.exports = {
             })
         }
 
+        const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
         return {
-            "Program:exit"() {
-                const tracker = new ReferenceTracker(context.getScope(), {
+            "Program:exit"(node) {
+                const scope = sourceCode.getScope?.(node) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
+
+                const tracker = new ReferenceTracker(scope, {
                     mode: "legacy",
                 })
 
diff --git a/lib/rules/no-exports-assign.js b/lib/rules/no-exports-assign.js
@@ -50,9 +50,12 @@ module.exports = {
         type: "problem",
     },
     create(context) {
+        const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
+
         return {
             AssignmentExpression(node) {
-                const scope = context.getScope()
+                const scope = sourceCode.getScope?.(node) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
+
                 if (
                     !isExports(node.left, scope) ||
                     // module.exports = exports = {}
diff --git a/lib/rules/no-extraneous-import.js b/lib/rules/no-extraneous-import.js
@@ -34,7 +34,7 @@ module.exports = {
         messages,
     },
     create(context) {
-        const filePath = context.getFilename()
+        const filePath = context.filename ?? context.getFilename()
         if (filePath === "<input>") {
             return {}
         }
diff --git a/lib/rules/no-extraneous-require.js b/lib/rules/no-extraneous-require.js
@@ -36,7 +36,7 @@ module.exports = {
         messages,
     },
     create(context) {
-        const filePath = context.getFilename()
+        const filePath = context.filename ?? context.getFilename()
         if (filePath === "<input>") {
             return {}
         }
diff --git a/lib/rules/no-hide-core-modules.js b/lib/rules/no-hide-core-modules.js
@@ -85,10 +85,11 @@ module.exports = {
         },
     },
     create(context) {
-        if (context.getFilename() === "<input>") {
+        const filename = context.filename ?? context.getFilename()
+        if (filename === "<input>") {
             return {}
         }
-        const filePath = path.resolve(context.getFilename())
+        const filePath = path.resolve(filename)
         const dirPath = path.dirname(filePath)
         const packageJson = getPackageJson(filePath)
         const deps = new Set(
diff --git a/lib/rules/no-missing-import.js b/lib/rules/no-missing-import.js
@@ -36,7 +36,7 @@ module.exports = {
         messages,
     },
     create(context) {
-        const filePath = context.getFilename()
+        const filePath = context.filename ?? context.getFilename()
         if (filePath === "<input>") {
             return {}
         }
diff --git a/lib/rules/no-missing-require.js b/lib/rules/no-missing-require.js
@@ -38,7 +38,7 @@ module.exports = {
         messages,
     },
     create(context) {
-        const filePath = context.getFilename()
+        const filePath = context.filename ?? context.getFilename()
         if (filePath === "<input>") {
             return {}
         }
diff --git a/lib/rules/no-path-concat.js b/lib/rules/no-path-concat.js
@@ -179,8 +179,10 @@ module.exports = {
 
     create(context) {
         return {
-            "Program:exit"() {
-                const globalScope = context.getScope()
+            "Program:exit"(node) {
+                const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
+                const globalScope =
+                    sourceCode.getScope?.(node) ?? context.getScope()
                 const tracker = new ReferenceTracker(globalScope)
                 const sepNodes = new Set()
 
diff --git a/lib/rules/no-unpublished-bin.js b/lib/rules/no-unpublished-bin.js
@@ -56,7 +56,7 @@ module.exports = {
         return {
             Program(node) {
                 // Check file path.
-                let rawFilePath = context.getFilename()
+                let rawFilePath = context.filename ?? context.getFilename()
                 if (rawFilePath === "<input>") {
                     return
                 }
diff --git a/lib/rules/no-unpublished-import.js b/lib/rules/no-unpublished-import.js
@@ -35,7 +35,7 @@ module.exports = {
         messages,
     },
     create(context) {
-        const filePath = context.getFilename()
+        const filePath = context.filename ?? context.getFilename()
         const options = context.options[0] || {}
         const ignoreTypeImport =
             options.ignoreTypeImport === void 0
diff --git a/lib/rules/no-unpublished-require.js b/lib/rules/no-unpublished-require.js
@@ -36,7 +36,7 @@ module.exports = {
         messages,
     },
     create(context) {
-        const filePath = context.getFilename()
+        const filePath = context.filename ?? context.getFilename()
         if (filePath === "<input>") {
             return {}
         }
diff --git a/lib/rules/no-unsupported-features.js b/lib/rules/no-unsupported-features.js
@@ -1085,10 +1085,10 @@ module.exports = {
         },
     },
     create(context) {
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
         const supportInfo = parseOptions(
             context.options[0],
-            getDefaultVersion(context.getFilename())
+            getDefaultVersion(context.filename ?? context.getFilename())
         )
 
         /**
@@ -1098,7 +1098,8 @@ module.exports = {
          * @returns {void}
          */
         function* getReferences(names) {
-            const globalScope = context.getScope()
+            const globalScope =
+                sourceCode.getScope?.(sourceCode.ast) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
 
             for (const name of names) {
                 const variable = globalScope.set.get(name)
@@ -1159,6 +1160,8 @@ module.exports = {
          * @returns {void}
          */
         function report(node, key) {
+            const globalScope =
+                sourceCode.getScope?.(node) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
             const version = supportInfo.version
             const feature = supportInfo.features[key]
             if (feature.supported) {
@@ -1175,7 +1178,7 @@ module.exports = {
                         version,
                     },
                 })
-            } else if (!normalizeScope(context.getScope(), node).isStrict) {
+            } else if (!normalizeScope(globalScope, node).isStrict) {
                 context.report({
                     node,
                     messageId: "unsupported",
@@ -1331,7 +1334,9 @@ module.exports = {
             },
 
             FunctionDeclaration(node) {
-                const scope = context.getScope().upper
+                const scope = (
+                    sourceCode.getScope?.(node) ?? context.getScope()
+                ).upper //TODO: remove context.getScope() when dropping support for ESLint < v9
                 if (!TOPLEVEL_SCOPE_TYPE.test(scope.type)) {
                     report(node, "blockScopedFunctions")
                 }
diff --git a/lib/rules/no-unsupported-features/es-syntax.js b/lib/rules/no-unsupported-features/es-syntax.js
@@ -443,7 +443,9 @@ function normalizeScope(initialScope, node) {
 function defineVisitor(context, options) {
     const testInfoPrototype = {
         get isStrict() {
-            return normalizeScope(context.getScope(), this.node).isStrict
+            const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
+            const scope = sourceCode.getScope?.(this.node) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
+            return normalizeScope(scope, this.node).isStrict
         },
     }
 
diff --git a/lib/rules/prefer-promises/dns.js b/lib/rules/prefer-promises/dns.js
@@ -52,8 +52,9 @@ module.exports = {
 
     create(context) {
         return {
-            "Program:exit"() {
-                const scope = context.getScope()
+            "Program:exit"(node) {
+                const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
+                const scope = sourceCode.getScope?.(node) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
                 const tracker = new ReferenceTracker(scope, { mode: "legacy" })
                 const references = [
                     ...tracker.iterateCjsReferences(trackMap),
diff --git a/lib/rules/prefer-promises/fs.js b/lib/rules/prefer-promises/fs.js
@@ -53,8 +53,9 @@ module.exports = {
 
     create(context) {
         return {
-            "Program:exit"() {
-                const scope = context.getScope()
+            "Program:exit"(node) {
+                const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
+                const scope = sourceCode.getScope?.(node) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
                 const tracker = new ReferenceTracker(scope, { mode: "legacy" })
                 const references = [
                     ...tracker.iterateCjsReferences(trackMap),
diff --git a/lib/rules/shebang.js b/lib/rules/shebang.js
@@ -94,8 +94,8 @@ module.exports = {
         },
     },
     create(context) {
-        const sourceCode = context.getSourceCode()
-        let filePath = context.getFilename()
+        const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
+        let filePath = context.filename ?? context.getFilename()
         if (filePath === "<input>") {
             return {}
         }
diff --git a/lib/util/check-prefer-global.js b/lib/util/check-prefer-global.js
@@ -31,7 +31,10 @@ class Verifier {
      */
     verifyToPreferGlobals() {
         const { context, trackMap } = this
-        const tracker = new ReferenceTracker(context.getScope(), {
+        const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
+        const scope =
+            sourceCode.getScope?.(sourceCode.ast) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
+        const tracker = new ReferenceTracker(scope, {
             mode: "legacy",
         })
 
@@ -51,7 +54,10 @@ class Verifier {
      */
     verifyToPreferModules() {
         const { context, trackMap } = this
-        const tracker = new ReferenceTracker(context.getScope())
+        const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
+        const scope =
+            sourceCode.getScope?.(sourceCode.ast) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
+        const tracker = new ReferenceTracker(scope)
 
         for (const { node } of tracker.iterateGlobalReferences(
             trackMap.globals
diff --git a/lib/util/check-unsupported-builtins.js b/lib/util/check-unsupported-builtins.js
@@ -85,7 +85,9 @@ module.exports.checkUnsupportedBuiltins = function checkUnsupportedBuiltins(
     trackMap
 ) {
     const options = parseOptions(context)
-    const tracker = new ReferenceTracker(context.getScope(), { mode: "legacy" })
+    const sourceCode = context.sourceCode ?? context.getSourceCode() // TODO: just use context.sourceCode when dropping eslint < v9
+    const scope = sourceCode.getScope?.(sourceCode.ast) ?? context.getScope() //TODO: remove context.getScope() when dropping support for ESLint < v9
+    const tracker = new ReferenceTracker(scope, { mode: "legacy" })
     const references = [
         ...tracker.iterateCjsReferences(trackMap.modules || {}),
         ...tracker.iterateEsmReferences(trackMap.modules || {}),
diff --git a/lib/util/get-configured-node-version.js b/lib/util/get-configured-node-version.js
@@ -47,7 +47,7 @@ module.exports = function getConfiguredNodeVersion(context) {
     const version =
         get(context.options && context.options[0]) ||
         get(context.settings && (context.settings.n || context.settings.node))
-    const filePath = context.getFilename()
+    const filePath = context.filename ?? context.getFilename()
 
     return (
         getSemverRange(version) ||
diff --git a/lib/util/get-typescript-extension-map.js b/lib/util/get-typescript-extension-map.js
@@ -112,19 +112,15 @@ function getFromTSConfigFromFile(filename) {
  * @returns {string[]} A list of extensions.
  */
 module.exports = function getTypescriptExtensionMap(context) {
+    const filename =
+        context.physicalFilename ??
+        context.getPhysicalFilename?.() ??
+        context.filename ??
+        context.getFilename?.() // TODO: remove context.get(PhysicalFilename|Filename) when dropping eslint < v10
     return (
         get(context.options?.[0]) ||
         get(context.settings?.n ?? context.settings?.node) ||
-        getFromTSConfigFromFile(
-            // eslint ^8
-            context.physicalFilename ??
-                // eslint ^7.28 (deprecated ^8)
-                context.getPhysicalFilename?.() ??
-                // eslint ^8 (if physicalFilename undefined)
-                context.filename ??
-                // eslint ^7 (deprecated ^8)
-                context.getFilename?.()
-        ) ||
+        getFromTSConfigFromFile(filename) ||
         PRESERVE_MAPPING
     )
 }
diff --git a/lib/util/is-typescript.js b/lib/util/is-typescript.js
diff --git a/lib/util/visit-import.js b/lib/util/visit-import.js
diff --git a/lib/util/visit-require.js b/lib/util/visit-require.js
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ module.exports = {`
`57`	`57`	`type: "suggestion",`
`58`	`58`	`},`
`59`	`59`	`create(context) {`
`60`		`- if (context.getFilename().startsWith("<")) {`
	`60`	`+ if ((context.filename ?? context.getFilename()).startsWith("<")) {`
`61`	`61`	`return {}`
`62`	`62`	`}`
`63`	`63`	`const defaultStyle = context.options[0] \|\| "always"`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ module.exports = {`
`34`	`34`	`messages,`
`35`	`35`	`},`
`36`	`36`	`create(context) {`
`37`		`- const filePath = context.getFilename()`
	`37`	`+ const filePath = context.filename ?? context.getFilename()`
`38`	`38`	`if (filePath === "<input>") {`
`39`	`39`	`return {}`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ module.exports = {`
`36`	`36`	`messages,`
`37`	`37`	`},`
`38`	`38`	`create(context) {`
`39`		`- const filePath = context.getFilename()`
	`39`	`+ const filePath = context.filename ?? context.getFilename()`
`40`	`40`	`if (filePath === "<input>") {`
`41`	`41`	`return {}`
`42`	`42`	`}`