feat!: update dependency to eslint v9 @W-17445058 (#176)

ravijayaramappa · ravijayaramappa · commit 57b991eb4099 · 2025-01-03T17:03:03.000-08:00
* feat!: update dependency to eslint v9 @W-17445058
BREAKING CHANGE: dropping support for ESLint v7 and v8. The only supported option is ESLint v9

* fix: lock file update

* fix: update ci config

* feat: migrate rule to ESLint v9

* fix: address PR feedback
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,6 +1,6 @@
 version: 2.1
 
-supported-eslint-versions: &supported-eslint-versions ["local", "7"]
+supported-eslint-versions: &supported-eslint-versions ["local", "9"]
 
 deploy_filters: &deploy_filters
   filters:
diff --git a/.eslintrc b/.eslintrc
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,22 @@
+'use strict';
+
+const globals = require('globals');
+const js = require('@eslint/js');
+
+module.exports = [
+    js.configs.recommended,
+    {
+        languageOptions: {
+            globals: {
+                ...globals.mocha,
+                ...globals.node,
+            },
+
+            sourceType: 'commonjs',
+        },
+
+        rules: {
+            strict: ['error', 'global'],
+        },
+    },
+];
diff --git a/lib/rule-helpers.js b/lib/rule-helpers.js
@@ -8,6 +8,7 @@
 const { analyze } = require('./analyze-component');
 const { isSSREscape } = require('./util/ssr');
 const { isGlobalIdentifier } = require('./util/scope');
+const { getAncestors, getScope } = require('./util/context');
 
 /**
  * Visitors for detecting methods/functions that are reachable during SSR
@@ -133,7 +134,7 @@ const noReferenceParentQualifiers = new Set([
 const globalAccessQualifiers = new Set(['CallExpression', 'MemberExpression']);
 
 function inModuleScope(node, context) {
-    for (const ancestor of context.getAncestors()) {
+    for (const ancestor of getAncestors(context, node)) {
         if (moduleScopeDisqualifiers.has(ancestor.type)) {
             return false;
         }
@@ -168,7 +169,7 @@ function noReferenceDuringSSR(forbiddenGlobalNames, messageIds, context) {
                     node.object.name === 'window') &&
                 node.property.type === 'Identifier' &&
                 forbiddenGlobalNames.has(node.property.name) &&
-                isGlobalIdentifier(node.object, context.getScope())
+                isGlobalIdentifier(node.object, getScope(context, node))
             ) {
                 // Prevents expressions like:
                 // globalThis.document.addEventListener('click', () => { ... });
@@ -193,7 +194,7 @@ function noReferenceDuringSSR(forbiddenGlobalNames, messageIds, context) {
                 node.object.name === 'globalThis' &&
                 node.property.type === 'Identifier' &&
                 forbiddenGlobalNames.has(node.property.name) &&
-                isGlobalIdentifier(node.object, context.getScope())
+                isGlobalIdentifier(node.object, getScope(context, node))
             ) {
                 // Prevents expressions like:
                 // globalThis.addEventListener('click', () => { ... });
@@ -214,7 +215,7 @@ function noReferenceDuringSSR(forbiddenGlobalNames, messageIds, context) {
                 node.parent.type !== 'MemberExpression' &&
                 node.object.type === 'Identifier' &&
                 forbiddenGlobalNames.has(node.object.name) &&
-                isGlobalIdentifier(node.object, context.getScope())
+                isGlobalIdentifier(node.object, getScope(context, node))
             ) {
                 // Prevents expressions like:
                 // window.addEventListener('click', () => { ... });
@@ -244,7 +245,7 @@ function noReferenceDuringSSR(forbiddenGlobalNames, messageIds, context) {
             if (
                 noReferenceParentQualifiers.has(node.parent.type) &&
                 forbiddenGlobalNames.has(node.name) &&
-                isGlobalIdentifier(node, context.getScope())
+                isGlobalIdentifier(node, getScope(context, node))
             ) {
                 // Prevents expressions like:
                 // doSomethingWith(window);
@@ -264,7 +265,7 @@ function noReferenceDuringSSR(forbiddenGlobalNames, messageIds, context) {
                 node.parent.operator === 'instanceof' &&
                 node.parent.right === node &&
                 forbiddenGlobalNames.has(node.name) &&
-                isGlobalIdentifier(node, context.getScope())
+                isGlobalIdentifier(node, getScope(context, node))
             ) {
                 // Prevents expressions like:
                 // if (value instanceof Element) { ... }
@@ -284,7 +285,7 @@ function noReferenceDuringSSR(forbiddenGlobalNames, messageIds, context) {
                 node.expression.type === 'CallExpression' &&
                 node.expression.callee.type === 'Identifier' &&
                 forbiddenGlobalNames.has(node.expression.callee.name) &&
-                isGlobalIdentifier(node, context.getScope())
+                isGlobalIdentifier(node, getScope(context, node))
             ) {
                 // Prevents global expressions like:
                 // addEventListener('resize', () => {...});
diff --git a/lib/rules/consistent-component-name.js b/lib/rules/consistent-component-name.js
@@ -10,6 +10,7 @@ const path = require('path');
 
 const { docUrl } = require('../util/doc-url');
 const { isComponent } = require('../util/component');
+const { getSourceCode } = require('../util/context');
 
 module.exports = {
     meta: {
@@ -25,8 +26,8 @@ module.exports = {
         schema: [],
     },
     create(context) {
-        const fileName = context.getFilename();
-        const sourceCode = context.getSourceCode();
+        const sourceCode = getSourceCode(context);
+        const fileName = context.filename ?? context.getFilename();
 
         const fileBasename = path.basename(fileName, path.extname(fileName));
         const expectComponentName = fileBasename.charAt(0).toUpperCase() + fileBasename.slice(1);
diff --git a/lib/rules/no-async-operation.js b/lib/rules/no-async-operation.js
@@ -6,6 +6,7 @@
  */
 'use strict';
 
+const { getScope } = require('../util/context');
 const { docUrl } = require('../util/doc-url');
 const { isGlobalIdentifier } = require('../util/scope');
 
@@ -29,7 +30,7 @@ module.exports = {
         return {
             CallExpression(node) {
                 const { callee } = node;
-                const scope = context.getScope();
+                const scope = getScope(context, node);
 
                 // Check for direct invocation of global restricted APIs.
                 // eg. setTimeout() or requestAnimationFrame();
diff --git a/lib/rules/no-leaky-event-listeners.js b/lib/rules/no-leaky-event-listeners.js
@@ -6,6 +6,7 @@
  */
 'use strict';
 
+const { getScope } = require('../util/context');
 const { docUrl } = require('../util/doc-url');
 const { isGlobalIdentifier } = require('../util/scope');
 
@@ -83,7 +84,7 @@ module.exports = {
         return {
             CallExpression(node) {
                 const { callee } = node;
-                const scope = context.getScope();
+                const scope = getScope(context, node);
 
                 // Handle cases where the method is attached on the global object:
                 // - addEventListener('click', () => {});
diff --git a/lib/rules/no-unexpected-wire-adapter-usages.js b/lib/rules/no-unexpected-wire-adapter-usages.js
@@ -9,6 +9,7 @@
 const { Minimatch } = require('minimatch');
 const { docUrl } = require('../util/doc-url');
 const { isWireDecorator } = require('../util/decorator');
+const { getScope } = require('../util/context');
 
 function getImportedIdentifier(specifierNode) {
     // Namespace imports are not analyzed because it is impossible to track accurately the usage of
@@ -66,7 +67,7 @@ module.exports = {
 
         return {
             ImportDeclaration(node) {
-                const scope = context.getScope();
+                const scope = getScope(context, node);
                 const moduleIdentifier = node.source.value;
 
                 for (const specifier of node.specifiers) {
diff --git a/lib/rules/no-unknown-wire-adapters.js b/lib/rules/no-unknown-wire-adapters.js
@@ -9,6 +9,7 @@
 const { Minimatch } = require('minimatch');
 
 const { docUrl } = require('../util/doc-url');
+const { getScope } = require('../util/context');
 
 module.exports = {
     meta: {
@@ -76,7 +77,7 @@ module.exports = {
                 const adapterName = adapterNode.name;
 
                 // Let's resolve the reference to the wire adapter identifier in the current scope.
-                const scope = context.getScope();
+                const scope = getScope(context, node);
                 const adapterVariable = scope.references.find(
                     (r) => r.identifier === adapterNode,
                 ).resolved;
diff --git a/lib/rules/prefer-custom-event.js b/lib/rules/prefer-custom-event.js
@@ -6,6 +6,7 @@
  */
 'use strict';
 
+const { getScope } = require('../util/context');
 const { docUrl } = require('../util/doc-url');
 const { isGlobalIdentifier } = require('../util/scope');
 
@@ -25,7 +26,7 @@ module.exports = {
         return {
             NewExpression(node) {
                 const { callee } = node;
-                const scope = context.getScope();
+                const scope = getScope(context, node);
 
                 if (
                     callee.type === 'Identifier' &&
diff --git a/lib/util/component.js b/lib/util/component.js
@@ -6,6 +6,8 @@
  */
 'use strict';
 
+const { getAncestors } = require('./context');
+
 /**
  * Returns true if the node is a LWC component.
  *
@@ -19,7 +21,7 @@ function isComponent(node, context) {
         return false;
     }
 
-    const program = context.getAncestors(node).find(({ type }) => type === 'Program');
+    const program = getAncestors(context, node).find(({ type }) => type === 'Program');
 
     const importDeclaration = program.body
         .filter(({ type }) => type === 'ImportDeclaration')
diff --git a/lib/util/context.js b/lib/util/context.js
@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
+'use strict';
+
+/**
+ * Get the source code AST for the rule context.
+ * @param {RuleContext} context The context for the ESLint rule
+ * @returns {SourceCode} Object representing the source code AST
+ */
+function getSourceCode(context) {
+    return context.sourceCode ?? context.getSourceCode();
+}
+
+/**
+ * Get the ancestor nodes of a given node.
+ * @param {RuleContext} context The context for the ESLint rule
+ * @param {ASTNode} node An AST node
+ * @returns {ASTNode[]} Anscestor nodes
+ */
+function getAncestors(context, node) {
+    const sourceCode = getSourceCode(context);
+    return sourceCode.getAncestors ? sourceCode.getAncestors(node) : context.getAncestors();
+}
+
+/**
+ * Get the scope for a given node.
+ * @param {RuleContext} context The context for the ESLint rule
+ * @param {ASTNode} node An AST node
+ * @returns {Scope} The scope for a given node
+ */
+function getScope(context, node) {
+    const sourceCode = getSourceCode(context);
+    return sourceCode.getScope ? sourceCode.getScope(node) : context.getScope();
+}
+
+module.exports = {
+    getAncestors,
+    getScope,
+    getSourceCode,
+};
diff --git a/package.json b/package.json
@@ -20,10 +20,11 @@
     "release:publish": "npm publish --registry=https://registry.npmjs.org"
   },
   "devDependencies": {
-    "@babel/core": "^7.24.4",
-    "@babel/eslint-parser": "^7.24.1",
+    "@babel/core": "^7.26.0",
+    "@babel/eslint-parser": "^7.25.9",
     "@babel/preset-typescript": "^7.24.6",
-    "eslint": "^8.57.0",
+    "@eslint/js": "^9.17.0",
+    "eslint": "^9.17.0",
     "husky": "^9.0.11",
     "lint-staged": "^15.2.2",
     "mocha": "^10.4.0",
@@ -37,7 +38,7 @@
   },
   "peerDependencies": {
     "@babel/eslint-parser": "^7",
-    "eslint": "^7 || ^8"
+    "eslint": "^9"
   },
   "repository": {
     "type": "git",
diff --git a/test/integration.js b/test/integration.js
@@ -6,39 +6,16 @@
  */
 'use strict';
 
-const fs = require('fs');
-const path = require('path');
 const assert = require('assert');
 const eslint = require('eslint');
 
-const SCOPE_DIRECTORY = path.resolve(__dirname, '../node_modules/@lwc');
-const PACKAGE_DIRECTORY = path.resolve(SCOPE_DIRECTORY, 'eslint-plugin-lwc');
-
-before(() => {
-    if (!fs.existsSync(SCOPE_DIRECTORY)) {
-        fs.mkdirSync(SCOPE_DIRECTORY);
-    }
-
-    if (!fs.existsSync(PACKAGE_DIRECTORY)) {
-        fs.symlinkSync(path.resolve(__dirname, '..'), PACKAGE_DIRECTORY, 'dir');
-    }
-});
-
-after(() => {
-    if (fs.existsSync(PACKAGE_DIRECTORY)) {
-        fs.unlinkSync(PACKAGE_DIRECTORY);
-    }
-
-    if (fs.existsSync(SCOPE_DIRECTORY)) {
-        fs.rmdirSync(SCOPE_DIRECTORY);
-    }
-});
+const local = require('../lib/index');
 
 it('should resolve plugin rules', async () => {
     const cli = new eslint.ESLint({
-        useEslintrc: false,
+        overrideConfigFile: true,
         overrideConfig: {
-            plugins: ['@lwc/eslint-plugin-lwc'],
+            plugins: { '@lwc/lwc': local },
             rules: {
                 '@lwc/lwc/no-document-query': 'error',
                 '@lwc/lwc/no-inner-html': 'warn',
diff --git a/test/lib/rules/no-leaky-event-listeners.js b/test/lib/rules/no-leaky-event-listeners.js
@@ -6,6 +6,7 @@
  */
 'use strict';
 
+const globals = require('globals');
 const { testRule } = require('../shared');
 
 function buildCases({ handlers }) {
@@ -94,8 +95,10 @@ testRule('no-leaky-event-listeners', {
             code: `
                 addEventListener('test', () => handleTest());
             `,
-            env: {
-                browser: true,
+            languageOptions: {
+                globals: {
+                    ...globals.browser,
+                },
             },
             errors: [
                 {
diff --git a/test/lib/rules/no-node-env-ssr.js b/test/lib/rules/no-node-env-ssr.js
diff --git a/test/lib/rules/prefer-custom-event.js b/test/lib/rules/prefer-custom-event.js
diff --git a/test/lib/rules/ssr/ssr-no-node-env.js b/test/lib/rules/ssr/ssr-no-node-env.js
diff --git a/test/lib/rules/valid-wire.js b/test/lib/rules/valid-wire.js
diff --git a/test/lib/shared.js b/test/lib/shared.js
diff --git a/yarn.lock b/yarn.lock
