improvement(build-tools): address ESLint rule violations in build-tools #26152
+21
−19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix low-count ESLint violations across the build-tools workspace: - 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)
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses ESLint rule violations across the build-tools workspace by fixing code to comply with newly enabled ESLint rules, without modifying the ESLint configuration itself.
- Modernizes string replacement operations using
.replaceAll()instead of regex-based.replace(/x/g, ...) - Updates import statements to use default imports for Node.js built-in modules like
path - Removes unnecessary
undefinedarguments and fixes JSDoc parameter names - Adds appropriate inline ESLint disable comments for idiomatic library usage patterns
- Updates TSDoc annotations for better compatibility
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
build-tools/packages/version-tools/src/internalVersionScheme.ts |
Removes useless undefined arguments from validateVersionScheme calls |
build-tools/packages/version-tools/src/commands/version/latest.ts |
Removes unused import-x/no-default-export disable directive |
build-tools/packages/version-tools/src/commands/version.ts |
Removes unused import-x/no-default-export disable directive |
build-tools/packages/build-infrastructure/src/test/packageJsonUtils.test.ts |
Changes path import from namespace to default import |
build-tools/packages/build-infrastructure/src/test/git.test.ts |
Changes path import from namespace to default import |
build-tools/packages/build-infrastructure/src/index.ts |
Updates @module to @packageDocumentation for TSDoc compatibility |
build-tools/packages/build-infrastructure/src/buildProject.ts |
Replaces .replace(/\\/g, "/") with .replaceAll("\\", "/") |
build-tools/packages/build-infrastructure/api-report/build-infrastructure.api.md |
Removes auto-generated comment about missing package documentation |
build-tools/packages/build-cli/src/commands/release/report.ts |
Fixes JSDoc parameter names and adds inline disable for sortJson.overwrite |
build-tools/packages/build-cli/src/commands/release/report-unreleased.ts |
Adds missing JSDoc parameter documentation |
build-tools/packages/build-cli/src/commands/release/fromTag.ts |
Adds inline disable for semver.parse |
build-tools/packages/build-cli/src/commands/generate/typetests.ts |
Replaces .replace(/x/g, ...) with .replaceAll() |
build-tools/packages/build-cli/src/commands/generate/changeset.ts |
Adds inline disable for prompts default import |
build-tools/packages/build-cli/src/commands/generate/assertTags.ts |
Replaces .replace(/x/g, ...) with .replaceAll() |
build-tools/packages/build-cli/src/commands/check/policy.ts |
Changes path import and replaces .replace() with .replaceAll() |
build-tools/packages/build-cli/src/commands/bump/deps.ts |
Adds inline disable for prompts default import |
build-tools/packages/build-cli/src/codeCoverage/getCoverageMetrics.ts |
Fixes JSDoc parameter name |
build-tools/packages/build-cli/src/BasePackageCommand.ts |
Adds inline disable for async.mapLimit |
tylerbutler
changed the title
Co-authored-by: Copilot <[email protected]>
tylerbutler
changed the title
alexvy86
reviewed
Jan 8, 2026
|
|
||
| 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 |
Contributor
There was a problem hiding this comment.
The lines before and after this one also import the default exports of the corresponding packages; if this is needed on this line, it must be needed on the other two, no?
| 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 |
Contributor
There was a problem hiding this comment.
Same as the previous comment, the line above this follows the same pattern so should need a disable too?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These changes are in preparation for upgrading to eslint 9 in build-tools.
Summary
Changes
.replace(/x/g, ...)with.replaceAll()(unicorn/prefer-string-replace-all)import * as pathtoimport path(unicorn/import-style)undefinedarguments (unicorn/no-useless-undefined)@paramnames to match actual parameters (jsdoc/check-param-names)async.mapLimit,semver.parse,sortJson.overwrite(import-x/no-named-as-default-member)promptsdefault export (import-x/no-named-as-default)@moduleto@packageDocumentationfor TSDoc compatibility (tsdoc/syntax)