cleaup

Author: tylerbutler

build-tools/eslint.config.base.mts

@@ -6,7 +6,9 @@
 import eslint from "@eslint/js";
 import eslintConfigPrettier from "eslint-config-prettier";
 import chaiFriendly from "eslint-plugin-chai-friendly";
+import importX from "eslint-plugin-import-x";
 import jsdoc from "eslint-plugin-jsdoc";
+import tsdoc from "eslint-plugin-tsdoc";
 import unicorn from "eslint-plugin-unicorn";
 import tseslint from "typescript-eslint";
 
@@ -99,6 +101,39 @@ export const unicornConfig = [
 	},
 ];
 
+/**
+ * Import-x plugin configuration for import/export linting.
+ * Uses the recommended and typescript configs from eslint-plugin-import-x.
+ */
+export const importXConfig = [
+	importX.flatConfigs.recommended,
+	importX.flatConfigs.typescript,
+	{
+		settings: {
+			"import-x/resolver": {
+				typescript: true,
+			},
+		},
+		rules: {
+			// Disable rules that are too strict for CLI tools
+			"import-x/no-named-as-default-member": "off",
+			"import-x/no-default-export": "off",
+		},
+	},
+];
+
+/**
+ * TSDoc plugin configuration for TypeScript documentation comments.
+ */
+export const tsdocConfig = {
+	plugins: {
+		tsdoc,
+	},
+	rules: {
+		"tsdoc/syntax": "warn",
+	},
+};
+
 /**
  * Chai-friendly configuration for test files.
  */
@@ -145,15 +180,28 @@ export function createConfig({
 	additionalConfigs = [],
 	jsdoc: includeJsdoc = false,
 	unicorn: includeUnicorn = false,
+	importX: includeImportX = false,
+	tsdoc: includeTsdoc = true,
 } = {}) {
 	return tseslint.config(
 		ignores,
 		...recommendedConfigs,
 		...(includeJsdoc ? jsdocConfig : []),
 		...(includeUnicorn ? unicornConfig : []),
+		...(includeImportX ? importXConfig : []),
+		...(includeTsdoc ? [tsdocConfig] : []),
 		baseConfig(project),
 		...additionalConfigs,
 	);
 }
 
-export { tseslint, eslint, eslintConfigPrettier, jsdoc, unicorn, chaiFriendly };
+export {
+	tseslint,
+	eslint,
+	eslintConfigPrettier,
+	jsdoc,
+	unicorn,
+	chaiFriendly,
+	importX,
+	tsdoc,
+};

build-tools/package.json

@@ -93,6 +93,9 @@
 		"jiti": "^2.6.1",
 		"eslint-plugin-chai-friendly": "~1.1.0",
 		"eslint-plugin-jsdoc": "~61.5.0",
+		"eslint-import-resolver-typescript": "^4.4.4",
+		"eslint-plugin-import-x": "~4.16.1",
+		"eslint-plugin-tsdoc": "~0.5.0",
 		"eslint-plugin-unicorn": "~56.0.1",
 		"inquirer": "^9.3.7",
 		"rimraf": "^6.1.2",

build-tools/packages/build-cli/eslint.config.mts

@@ -9,6 +9,7 @@ export default createConfig({
 	project: ["./tsconfig.json", "./src/test/tsconfig.json"],
 	jsdoc: true,
 	unicorn: true,
+	importX: true,
 	additionalConfigs: [
 		// Ignore test data files and test fixtures that aren't in tsconfig
 		{

build-tools/packages/build-cli/src/args.ts

@@ -7,7 +7,7 @@ import type { MonoRepo, Package } from "@fluidframework/build-tools";
 import { Args } from "@oclif/core";
 import { PackageName } from "@rushstack/node-core-library";
 import * as semver from "semver";
-// eslint-disable-next-line import-x/no-deprecated
+
 import { type Context, isMonoRepoKind } from "./library/index.js";
 
 /**
@@ -28,7 +28,6 @@ export const findPackageOrReleaseGroup = (
 	name: string,
 	context: Context,
 ): Package | MonoRepo | undefined => {
-	// eslint-disable-next-line import-x/no-deprecated
 	if (isMonoRepoKind(name)) {
 		return context.repo.releaseGroups.get(name);
 	}

build-tools/packages/build-cli/src/codeCoverage/getCommentForCodeCoverage.ts

@@ -61,7 +61,6 @@ export function getCommentForCodeCoverageDiff(
 const getSummaryFooter = (baselineBuildInfo: IBuildMetrics): string => {
 	return `<hr><p>Baseline commit: ${
 		baselineBuildInfo.build.sourceVersion
-		// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 	} <br>Baseline build: <a target="_blank" href=${baselineBuildInfo.build._links?.web.href as string}> ${
 		baselineBuildInfo.build.id
 	} </a><br> Happy Coding!!</p>`;

build-tools/packages/build-cli/src/codeCoverage/getCoverageMetrics.ts

@@ -65,7 +65,7 @@ export const getCoverageMetricsFromArtifact = async (
 	logger?: CommandLogger,
 ): Promise<Map<string, CoverageMetric>> => {
 	const coverageReportsFiles: string[] = [];
-	// eslint-disable-next-line unicorn/no-array-for-each -- required as JSZip does not implement [Symbol.iterator]() which is required by for...of
+
 	artifactZip.forEach((filePath) => {
 		if (filePath.endsWith("cobertura-coverage-patched.xml"))
 			coverageReportsFiles.push(filePath);
@@ -85,7 +85,6 @@ export const getCoverageMetricsFromArtifact = async (
 				);
 			}
 
-			// eslint-disable-next-line no-await-in-loop -- Since we only need 1 report file, it is easier to run it serially rather than extracting all jsZipObjects and then awaiting promises in parallel
 			const coverageReportXML = await jsZipObject?.async("nodebuffer");
 			if (coverageReportXML !== undefined) {
 				xmlParser.parseString(

build-tools/packages/build-cli/src/commands/bump.ts

@@ -203,9 +203,7 @@ export default class BumpCommand extends BaseCommand<typeof BumpCommand> {
 			packageOrReleaseGroup = releasePackage;
 		}
 
-		const newVersion =
-			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-			exactVersion ?? bumpVersionScheme(repoVersion, bumpType!, scheme);
+		const newVersion = exactVersion ?? bumpVersionScheme(repoVersion, bumpType!, scheme);
 
 		let bumpArg: VersionChangeType;
 		if (bumpType === undefined) {

build-tools/packages/build-cli/src/commands/bump/deps.ts

@@ -21,15 +21,14 @@ import {
 } from "../../flags.js";
 import {
 	BaseCommand,
-	// eslint-disable-next-line import-x/no-deprecated
 	MonoRepoKind,
 	generateBumpDepsBranchName,
 	generateBumpDepsCommitMessage,
 	indentString,
 	isDependencyUpdateType,
 	npmCheckUpdates,
 } from "../../library/index.js";
-// eslint-disable-next-line import-x/no-internal-modules
+
 import { npmCheckUpdatesHomegrown } from "../../library/package.js";
 import type { ReleaseGroup } from "../../releaseGroups.js";
 
@@ -140,9 +139,7 @@ export default class DepsCommand extends BaseCommand<typeof DepsCommand> {
 		const gitRepo = await context.getGitRepository();
 		const branchName = await gitRepo.getCurrentBranchName();
 
-		// eslint-disable-next-line import-x/no-deprecated
 		if (args.package_or_release_group === MonoRepoKind.Server && branchName !== "next") {
-			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 			const { confirmed } = await prompts({
 				type: "confirm",
 				name: "confirmed",
@@ -152,7 +149,6 @@ export default class DepsCommand extends BaseCommand<typeof DepsCommand> {
 				initial: false,
 				// eslint-disable-next-line @typescript-eslint/no-explicit-any
 				onState: (state: any) => {
-					// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions, @typescript-eslint/no-unsafe-member-access
 					if (state.aborted) {
 						process.nextTick(() => this.exit(0));
 					}
@@ -249,7 +245,7 @@ export default class DepsCommand extends BaseCommand<typeof DepsCommand> {
 				...new Set(
 					updatedPackages
 						.filter((p) => p.monoRepo !== undefined)
-						// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
 						.map((p) => p.monoRepo!.releaseGroup),
 				),
 			];

build-tools/packages/build-cli/src/commands/check/layers.ts

@@ -9,7 +9,7 @@ import path from "node:path";
 import { Flags } from "@oclif/core";
 
 import { BaseCommand, LayerGraph } from "../../library/index.js";
-// eslint-disable-next-line import-x/no-internal-modules -- AB#8118 tracks removing the barrel files and importing directly from the submodules, including disabling this rule.
+
 import { writeFileWithLineFeeds } from "../../library/text.js";
 
 const packagesMdFileName = "PACKAGES.md";

build-tools/packages/build-cli/src/commands/check/policy.ts

@@ -207,7 +207,6 @@ export class CheckPolicy extends BaseCommand<typeof CheckPolicy> {
 	): Promise<void> {
 		try {
 			for (const pathToCheck of pathsToCheck) {
-				// eslint-disable-next-line no-await-in-loop
 				await this.checkOrExcludeFile(pathToCheck, commandContext);
 			}
 		} finally {
@@ -263,7 +262,7 @@ export class CheckPolicy extends BaseCommand<typeof CheckPolicy> {
 				if (this.flags.fix && resolver) {
 					output += `${newline}attempting to resolve: ${relPath}`;
 					// Resolvers are expected to be run serially to avoid any conflicts.
-					// eslint-disable-next-line no-await-in-loop
+
 					const resolveResult = await runWithPerf(handler.name, "resolve", async () =>
 						// Pass the resolver the absolute file path and the absolute path to the git root
 						resolver(file, gitRoot),
@@ -367,9 +366,8 @@ async function runFinalHandlers(
 	for (const h of handlers) {
 		const { final } = h;
 		if (final) {
-			// eslint-disable-next-line no-await-in-loop
 			const result = await runWithPerf(h.name, "final", async () => final(gitRoot, fix));
-			// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+
 			if (result?.error) {
 				throw new Error(result.error);
 			}