improvement(build-tools): address ESLint rule violations in build-tools (#26152)

These changes are in preparation for upgrading to eslint 9 in
build-tools.

## Summary
- Fix low-count ESLint violations across the build-tools workspace
- Address issues from newly enabled ESLint rules without modifying the
config

## Changes
- Replace `.replace(/x/g, ...)` with `.replaceAll()`
(unicorn/prefer-string-replace-all)
- Change `import * as path` to `import path` (unicorn/import-style)
- Remove useless `undefined` arguments (unicorn/no-useless-undefined)
- Fix JSDoc `@param` names to match actual parameters
(jsdoc/check-param-names)
- Add inline disables for idiomatic usage patterns:
- `async.mapLimit`, `semver.parse`, `sortJson.overwrite`
(import-x/no-named-as-default-member)
  - `prompts` default export (import-x/no-named-as-default)
- Remove unused eslint-disable directives for import-x/no-default-export
- Change `@module` to `@packageDocumentation` for TSDoc compatibility
(tsdoc/syntax)

Author: tylerbutler

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

@@ -151,6 +151,7 @@ export abstract class PackageCommand<
 		}
 
 		try {
+			// eslint-disable-next-line import-x/no-named-as-default-member -- async.mapLimit is the idiomatic usage
 			await async.mapLimit(packages, this.flags.concurrency, async (pkg: PackageWithKind) => {
 				started += 1;
 				updateStatus();

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

@@ -56,7 +56,7 @@ const extractCoverageMetrics = (
 
 /**
  * Method that returns the coverage report for the build from the artifact.
- * @param baselineZip - zipped coverage files for the build
+ * @param artifactZip - zipped coverage files for the build
  * @param logger - The logger to log messages.
  * @returns an map of coverage metrics for build containing packageName, lineCoverage and branchCoverage
  */

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

@@ -5,6 +5,7 @@
 
 import { Flags } from "@oclif/core";
 import chalk from "picocolors";
+// eslint-disable-next-line import-x/no-named-as-default -- prompts default export is the intended API
 import prompts from "prompts";
 import stripAnsi from "strip-ansi";
 

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

@@ -6,7 +6,7 @@
 import { strict as assert } from "node:assert";
 import * as fs from "node:fs";
 import { EOL as newline } from "node:os";
-import * as path from "node:path";
+import path from "node:path";
 import process from "node:process";
 import { Flags } from "@oclif/core";
 
@@ -313,7 +313,7 @@ export class CheckPolicy extends BaseCommand<typeof CheckPolicy> {
 	): Promise<void> {
 		const { exclusions, gitRoot, pathRegex } = commandContext;
 
-		const filePath = path.join(gitRoot, inputPath).trim().replace(/\\/g, "/");
+		const filePath = path.join(gitRoot, inputPath).trim().replaceAll("\\", "/");
 		assert(path.isAbsolute(filePath) === true);
 
 		if (!pathRegex.test(inputPath) || !fs.existsSync(filePath)) {

build-tools/packages/build-cli/src/commands/generate/assertTags.ts

@@ -295,8 +295,8 @@ The format of the configuration is specified by the "AssertTaggingPackageConfig"
 						if (comments.length > 0) {
 							let originalErrorText = comments[0]
 								.getText()
-								.replace(/\/\*/g, "")
-								.replace(/\*\//g, "")
+								.replaceAll("/*", "")
+								.replaceAll("*/", "")
 								.trim();
 
 							// Replace leading+trailing double quotes and backticks.

build-tools/packages/build-cli/src/commands/generate/changeset.ts

@@ -11,6 +11,7 @@ import { Flags, ux } from "@oclif/core";
 import { PackageName } from "@rushstack/node-core-library";
 import { humanId } from "human-id";
 import chalk from "picocolors";
+// eslint-disable-next-line import-x/no-named-as-default -- prompts default export is the intended API
 import prompts from "prompts";
 
 import { releaseGroupFlag } from "../../flags.js";

build-tools/packages/build-cli/src/commands/generate/typetests.ts

@@ -432,8 +432,8 @@ function getNodeTypeData(node: Node, log: Logger, exportedName: string): TypeDat
 			tags: getTags(docs),
 		};
 
-		const escapedTypeName = exportedName.replace(/\./g, "_");
-		const trimmedKind = node.getKindName().replace(/Declaration/g, "");
+		const escapedTypeName = exportedName.replaceAll(".", "_");
+		const trimmedKind = node.getKindName().replaceAll("Declaration", "");
 
 		if (
 			// Covers instance type of the class (including generics of it)

build-tools/packages/build-cli/src/commands/release/fromTag.ts

@@ -127,6 +127,7 @@ export default class FromTagCommand extends ReleaseReportBaseCommand<typeof From
 		const tag = input.startsWith(tagRefPrefix) ? input.slice(tagRefPrefix.length) : input;
 		const [rg, ver] = tag.split("_v");
 
+		// eslint-disable-next-line import-x/no-named-as-default-member -- semver.parse is the idiomatic usage
 		const version = semver.parse(ver);
 		if (version === null) {
 			throw new Error(`Invalid version parsed from tag: ${ver}`);

build-tools/packages/build-cli/src/commands/release/report-unreleased.ts

@@ -70,6 +70,7 @@ export class UnreleasedReportCommand extends BaseCommand<typeof UnreleasedReport
  * @param fullReleaseReport - The format of the "full" release report.
  * @param version - The version string for the reports.
  * @param outDir - The output directory for the reports.
+ * @param branchName - The branch name for the reports.
  * @param log - The logger object for logging messages.
  */
 async function generateReleaseReport(

build-tools/packages/build-cli/src/commands/release/report.ts

@@ -119,7 +119,7 @@ export abstract class ReleaseReportBaseCommand<
 	 *
 	 * @param context - The {@link Context}.
 	 * @param mode - The {@link ReleaseSelectionMode} to use to determine the release to report on.
-	 * @param releaseGroup - If provided, the release data collected will be limited to only the pakages in this release
+	 * @param releaseGroupOrPackage - If provided, the release data collected will be limited to only the packages in this release
 	 * group and its direct Fluid dependencies.
 	 * @param includeDependencies - If true, the release data will include the Fluid dependencies of the release group.
 	 */
@@ -205,7 +205,7 @@ export abstract class ReleaseReportBaseCommand<
 	/**
 	 * Collects the releases of a given release group or package.
 	 *
-	 * @param context - The {@link Context}.
+	 * @param repo - The {@link Repository}.
 	 * @param releaseGroupOrPackage - The release group or package to collect release data for.
 	 * @param repoVersion - The version of the release group or package in the repo.
 	 * @param latestReleaseChooseMode - Controls which release is considered the latest.
@@ -734,5 +734,6 @@ async function writeReport(
 	const reportOutput = toReportKind(report, kind);
 
 	await writeJson(reportPath, reportOutput, { spaces: 2 });
+	// eslint-disable-next-line import-x/no-named-as-default-member -- sortJson.overwrite is the correct usage
 	sortJson.overwrite(reportPath);
 }