feat(eslint-plugin-fluid): update APIs for cross 8/9 ESLint compat

common/build/eslint-plugin-fluid/package.json

@@ -19,17 +19,24 @@
 		"format": "npm run prettier:fix",
 		"prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
 		"prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
-		"test": "mocha \"src/test/**/*.test.*js\""
+		"test": "npm run test:both",
+		"test:both": "npm run test:eslint8 && npm run test:eslint9",
+		"test:eslint8": "cross-env ESLINT_PACKAGE=eslint8 npm run test:mocha",
+		"test:eslint9": "cross-env ESLINT_PACKAGE=eslint npm run test:mocha",
+		"test:mocha": "mocha \"src/test/**/*.test.*js\""
 	},
 	"dependencies": {
 		"@microsoft/tsdoc": "^0.15.1",
-		"@typescript-eslint/parser": "~7.18.0",
+		"@typescript-eslint/parser": "~8.46.0",
+		"@typescript-eslint/utils": "~8.46.0",
 		"ts-morph": "^22.0.0"
 	},
 	"devDependencies": {
 		"@fluid-tools/markdown-magic": "file:../../../tools/markdown-magic",
 		"@fluidframework/build-common": "^2.0.3",
-		"eslint": "^8.57.0",
+		"cross-env": "^7.0.3",
+		"eslint": "~9.37.0",
+		"eslint8": "npm:eslint@~8.57.1",
 		"mocha": "^10.8.2",
 		"mocha-multi-reporters": "^1.5.1",
 		"prettier": "~3.6.2",

common/build/eslint-plugin-fluid/src/rules/no-unchecked-record-access.js

@@ -23,7 +23,8 @@ module.exports = {
 		schema: [],
 	},
 	create(context) {
-		const parserServices = context.parserServices;
+		// ESLint 9+ uses context.sourceCode.parserServices, earlier versions use context.parserServices
+		const parserServices = context.sourceCode?.parserServices ?? context.parserServices;
 
 		// Check if we have the necessary TypeScript services
 		if (!parserServices || !parserServices.program || !parserServices.esTreeNodeToTSNodeMap) {
@@ -37,6 +38,15 @@ module.exports = {
 			return {};
 		}
 
+		// Helper to get scope in both ESLint 8 and 9
+		// In ESLint 9, getScope requires a node argument
+		const getScope = (node) => {
+			if (context.sourceCode?.getScope) {
+				return context.sourceCode.getScope(node);
+			}
+			return context.getScope();
+		};
+
 		// Main function to run on every member access (e.g., obj.a or obj["a"])
 		function checkPropertyAccess(node) {
 			if (!isIndexSignatureType(parserServices, node)) {
@@ -93,7 +103,11 @@ module.exports = {
 					});
 				}
 
-				if (isStrictlyTypedVariable(getVariableType(parentNode.left, context.getScope()))) {
+				if (
+					isStrictlyTypedVariable(
+						getVariableType(parentNode.left, getScope(parentNode.left)),
+					)
+				) {
 					// This defect occurs when an index signature type is assigned to a strictly typed variable after its declaration
 					return context.report({
 						node,
@@ -132,7 +146,7 @@ module.exports = {
 				}
 				const functionDeclaration = findFunctionDeclaration(
 					parentNode.callee.name,
-					context.getScope(),
+					getScope(parentNode.callee),
 				);
 				if (!functionDeclaration || !functionDeclaration.params) {
 					return;
@@ -629,7 +643,10 @@ function findContainingBlock(node) {
 function getKeyValue(node, context) {
 	if (node.type === "Literal") return node.value;
 	if (node.type === "Identifier") {
-		let scope = context.getScope();
+		// ESLint 9 requires node argument for getScope
+		let scope = context.sourceCode?.getScope
+			? context.sourceCode.getScope(node)
+			: context.getScope();
 		while (scope) {
 			const variable = scope.variables.find((v) => v.name === node.name);
 			if (variable) {

common/build/eslint-plugin-fluid/src/test/enforce-no-file-path-links-in-jsdoc/enforce-no-file-path-links-in-jsdoc.test.js

@@ -5,23 +5,17 @@
 
 const assert = require("assert");
 const path = require("path");
-const { ESLint } = require("eslint");
+const { createESLintConfig, eslintVersion, ESLint } = require("../eslintConfigHelper.cjs");
 
-describe("Do not allow file path links in JSDoc/TSDoc comments", function () {
+describe(`Do not allow file path links in JSDoc/TSDoc comments (eslint ${eslintVersion})`, function () {
 	async function lintFile(file) {
-		const eslint = new ESLint({
-			useEslintrc: false,
-			overrideConfig: {
-				rules: {
-					"no-file-path-links-in-jsdoc": "error",
-				},
-				parser: "@typescript-eslint/parser",
-				parserOptions: {
-					project: path.join(__dirname, "../example/tsconfig.json"),
-				},
+		const eslintOptions = createESLintConfig({
+			rules: {
+				"@fluid-internal/fluid/no-file-path-links-in-jsdoc": "error",
 			},
-			rulePaths: [path.join(__dirname, "../../rules")],
 		});
+
+		const eslint = new ESLint(eslintOptions);
 		const fileToLint = path.join(__dirname, "../example/no-file-path-links-in-jsdoc", file);
 		const results = await eslint.lintFiles([fileToLint]);
 		assert.equal(results.length, 1, "Expected a single result for linting a single file.");

common/build/eslint-plugin-fluid/src/test/enforce-no-hyphen-after-jsdoc-tag/enforce-no-hyphen-after-jsdoc-tag.test.js

@@ -5,28 +5,22 @@
 
 const assert = require("assert");
 const path = require("path");
-const { ESLint } = require("eslint");
+const { createESLintConfig, eslintVersion, ESLint } = require("../eslintConfigHelper.cjs");
 
-describe("Do not allow `-` following JSDoc/TSDoc tags", function () {
+describe(`Do not allow \`-\` following JSDoc/TSDoc tags (eslint ${eslintVersion})`, function () {
 	/**
 	 *
 	 * @param {string} file - Path to the file being linted. Relative to the `example/no-hyphen-after-jsdoc-tag` folder.
 	 * @returns
 	 */
 	async function lintFile(file) {
-		const eslint = new ESLint({
-			useEslintrc: false,
-			overrideConfig: {
-				rules: {
-					"no-hyphen-after-jsdoc-tag": "error",
-				},
-				parser: "@typescript-eslint/parser",
-				parserOptions: {
-					project: path.join(__dirname, "../example/tsconfig.json"),
-				},
+		const eslintOptions = createESLintConfig({
+			rules: {
+				"@fluid-internal/fluid/no-hyphen-after-jsdoc-tag": "error",
 			},
-			rulePaths: [path.join(__dirname, "../../rules")],
 		});
+
+		const eslint = new ESLint(eslintOptions);
 		const fileToLint = path.join(__dirname, "../example/no-hyphen-after-jsdoc-tag", file);
 		const results = await eslint.lintFiles([fileToLint]);
 		assert.equal(results.length, 1, "Expected a single result for linting a single file.");

common/build/eslint-plugin-fluid/src/test/enforce-no-markdown-links-in-jsdoc/enforce-no-markdown-links-in-jsdoc.test.js

@@ -5,23 +5,17 @@
 
 const assert = require("assert");
 const path = require("path");
-const { ESLint } = require("eslint");
+const { createESLintConfig, eslintVersion, ESLint } = require("../eslintConfigHelper.cjs");
 
-describe("Do not allow Markdown links in JSDoc/TSDoc comments", function () {
+describe(`Do not allow Markdown links in JSDoc/TSDoc comments (eslint ${eslintVersion})`, function () {
 	async function lintFile(file) {
-		const eslint = new ESLint({
-			useEslintrc: false,
-			overrideConfig: {
-				rules: {
-					"no-markdown-links-in-jsdoc": "error",
-				},
-				parser: "@typescript-eslint/parser",
-				parserOptions: {
-					project: path.join(__dirname, "../example/tsconfig.json"),
-				},
+		const eslintOptions = createESLintConfig({
+			rules: {
+				"@fluid-internal/fluid/no-markdown-links-in-jsdoc": "error",
 			},
-			rulePaths: [path.join(__dirname, "../../rules")],
 		});
+
+		const eslint = new ESLint(eslintOptions);
 		const fileToLint = path.join(__dirname, "../example/no-markdown-links-in-jsdoc", file);
 		const results = await eslint.lintFiles([fileToLint]);
 		assert.equal(results.length, 1, "Expected a single result for linting a single file.");

common/build/eslint-plugin-fluid/src/test/enforce-no-member-release-tags/enforce-no-member-release-tags.test.js

@@ -5,29 +5,15 @@
 
 const assert = require("assert");
 const path = require("path");
-const { ESLint } = require("eslint");
-
-describe("Do not allow release tags on members", function () {
-	function createESLintInstance() {
-		const eslintConfig = {
-			rules: {
-				"no-member-release-tags": ["error"],
-			},
-			parser: "@typescript-eslint/parser",
-			parserOptions: {
-				project: path.join(__dirname, "../example/tsconfig.json"),
-			},
-		};
-
-		return new ESLint({
-			useEslintrc: false,
-			overrideConfig: eslintConfig,
-			rulePaths: [path.join(__dirname, "../../rules")],
-		});
-	}
+const { createESLintInstance, eslintVersion } = require("../eslintConfigHelper.cjs");
+
+describe(`Do not allow release tags on members (eslint ${eslintVersion})`, function () {
+	const eslintRules = {
+		"@fluid-internal/fluid/no-member-release-tags": ["error"],
+	};
 
 	it("Should report errors for including release tags inside the class declaration", async function () {
-		const eslint = createESLintInstance();
+		const eslint = createESLintInstance(eslintRules);
 
 		const filesToLint = ["mockClassDeclaration.ts"].map((file) =>
 			path.join(__dirname, "../example/no-member-release-tags", file),
@@ -72,7 +58,7 @@ describe("Do not allow release tags on members", function () {
 	});
 
 	it("Should report errors for including release tags inside the class expression", async function () {
-		const eslint = createESLintInstance();
+		const eslint = createESLintInstance(eslintRules);
 
 		const filesToLint = ["mockClassExpression.ts"].map((file) =>
 			path.join(__dirname, "../example/no-member-release-tags", file),
@@ -123,7 +109,7 @@ describe("Do not allow release tags on members", function () {
 	});
 
 	it("Should report errors for including release tags inside the abstract class", async function () {
-		const eslint = createESLintInstance();
+		const eslint = createESLintInstance(eslintRules);
 
 		const filesToLint = ["mockAbstractClass.ts"].map((file) =>
 			path.join(__dirname, "../example/no-member-release-tags", file),
@@ -142,7 +128,7 @@ describe("Do not allow release tags on members", function () {
 	});
 
 	it("Should report errors for including release tags inside the interface", async function () {
-		const eslint = createESLintInstance();
+		const eslint = createESLintInstance(eslintRules);
 
 		const filesToLint = ["mockInterface.ts"].map((file) =>
 			path.join(__dirname, "../example/no-member-release-tags", file),
@@ -181,7 +167,7 @@ describe("Do not allow release tags on members", function () {
 	});
 
 	it("Should report errors for including release tags inside the type", async function () {
-		const eslint = createESLintInstance();
+		const eslint = createESLintInstance(eslintRules);
 
 		const filesToLint = ["mockType.ts"].map((file) =>
 			path.join(__dirname, "../example/no-member-release-tags", file),
@@ -217,7 +203,7 @@ describe("Do not allow release tags on members", function () {
 	});
 
 	it("Should NOT report errors for including release tags for function", async function () {
-		const eslint = createESLintInstance();
+		const eslint = createESLintInstance(eslintRules);
 
 		const filesToLint = ["mockFunction.ts"].map((file) =>
 			path.join(__dirname, "../example/no-member-release-tags", file),

common/build/eslint-plugin-fluid/src/test/enforce-no-restricted-tags-imports/enforce-no-restricted-tags-imports.test.js

@@ -5,32 +5,21 @@
 
 const assert = require("assert");
 const path = require("path");
-const { ESLint } = require("eslint");
+const { createESLintInstance, eslintVersion } = require("../eslintConfigHelper.cjs");
 
-describe("ESLint Rule Tests", function () {
-	function createESLintInstance(config) {
-		return new ESLint({
-			useEslintrc: false,
-			overrideConfig: config,
-			rulePaths: [path.join(__dirname, "../../rules")],
-		});
-	}
+describe(`ESLint Rule Tests (eslint ${eslintVersion})`, function () {
 
 	it("Should report an error for restricted tag imports", async function () {
 		const eslint = createESLintInstance({
 			rules: {
-				"no-restricted-tags-imports": [
+				"@fluid-internal/fluid/no-restricted-tags-imports": [
 					"error",
 					{
 						tags: ["@internal", "@alpha"],
 						exceptions: { "@alpha": ["./exceptionFile.ts"] },
 					},
 				],
 			},
-			parser: "@typescript-eslint/parser",
-			parserOptions: {
-				project: path.join(__dirname, "../example/tsconfig.json"),
-			},
 		});
 		const filesToLint = ["fileWithImports.ts", "mockModule.ts"].map((file) =>
 			path.join(__dirname, "../example/no-restricted-tags-imports", file),
@@ -51,7 +40,7 @@ describe("ESLint Rule Tests", function () {
 	it("Should not report an error for restricted tag imports for exceptions", async function () {
 		const eslint = createESLintInstance({
 			rules: {
-				"no-restricted-tags-imports": [
+				"@fluid-internal/fluid/no-restricted-tags-imports": [
 					"error",
 					{
 						tags: ["@internal", "@alpha"],
@@ -62,7 +51,6 @@ describe("ESLint Rule Tests", function () {
 					},
 				],
 			},
-			parser: "@typescript-eslint/parser",
 			parserOptions: {
 				project: path.join(__dirname, "../example/tsconfig.json"),
 			},
@@ -79,7 +67,7 @@ describe("ESLint Rule Tests", function () {
 	it("Should report an error for tsconfig provided config", async function () {
 		const eslint = createESLintInstance({
 			rules: {
-				"no-restricted-tags-imports": [
+				"@fluid-internal/fluid/no-restricted-tags-imports": [
 					"error",
 					{
 						tags: ["@internal", "@alpha"],
@@ -90,7 +78,6 @@ describe("ESLint Rule Tests", function () {
 					},
 				],
 			},
-			parser: "@typescript-eslint/parser",
 			parserOptions: {
 				project: path.join(__dirname, "../example/tsconfig.json"),
 			},

common/build/eslint-plugin-fluid/src/test/enforce-no-unchecked-record-access/enforce-no-unchecked-record-access.test.js

@@ -5,23 +5,17 @@
 
 const assert = require("assert");
 const path = require("path");
-const { ESLint } = require("eslint");
+const { createESLintConfig, eslintVersion, ESLint } = require("../eslintConfigHelper.cjs");
 
-describe("ESLint Rule Tests", function () {
+describe(`ESLint Rule Tests (eslint ${eslintVersion})`, function () {
 	async function lintFile(file) {
-		const eslint = new ESLint({
-			useEslintrc: false,
-			overrideConfig: {
-				rules: {
-					"no-unchecked-record-access": "error",
-				},
-				parser: "@typescript-eslint/parser",
-				parserOptions: {
-					project: path.join(__dirname, "../example/tsconfig.json"),
-				},
+		const eslintOptions = createESLintConfig({
+			rules: {
+				"@fluid-internal/fluid/no-unchecked-record-access": "error",
 			},
-			rulePaths: [path.join(__dirname, "../../rules")],
 		});
+
+		const eslint = new ESLint(eslintOptions);
 		const fileToLint = path.join(__dirname, "../example/no-unchecked-record-access", file);
 		const results = await eslint.lintFiles([fileToLint]);
 		return results[0];