feat(eslint-config-fluid): add script to generate deprecated rules JSON #26199
+986
−1
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
Add a script that automatically generates a JSON file listing all deprecated ESLint rules from core ESLint and all plugins used in the config. This enables tooling to programmatically identify and handle deprecated rules. The script: - Queries rule metadata from ESLint core and 12 plugins - Tracks which deprecated rules are configured in our ESLint configs - Records replacement rules when available - Supports both flat config (flat.mts) and legacy CJS configs Output is written to printed-configs/deprecated-rules.json.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a script to automatically generate a JSON file containing all deprecated ESLint rules from core ESLint and 12 plugins. The script intelligently detects and uses either flat config (flat.mts) or legacy CJS configs (recommended.js, strict.js) to determine which deprecated rules are currently configured in the project.
Changes:
- Adds a new TypeScript script that queries rule metadata from ESLint and all configured plugins to identify deprecated rules
- Generates a comprehensive JSON output tracking 119 deprecated rules, their replacement rules, and configuration status
- Adds the
typescript-eslintpackage as a dependency to support the script's functionality
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| common/build/eslint-config-fluid/scripts/generate-deprecated-rules.ts | New script that extracts deprecated rules from ESLint core and plugins, with fallback logic for config loading |
| common/build/eslint-config-fluid/printed-configs/deprecated-rules.json | Auto-generated JSON output containing 119 deprecated rules with metadata about replacements and configuration status |
| common/build/eslint-config-fluid/package.json | Adds generate-deprecated-rules npm script and typescript-eslint dependency |
| common/build/eslint-config-fluid/pnpm-lock.yaml | Lockfile updates for the new typescript-eslint dependency |
Files not reviewed (1)
- common/build/eslint-config-fluid/pnpm-lock.yaml: Language not supported
common/build/eslint-config-fluid/scripts/generate-deprecated-rules.ts
Outdated
Show resolved
Hide resolved
Address PR feedback from Copilot: use indexOf with bounds check to robustly handle edge cases like rule names starting with "/". Also use nullish coalescing for consistency.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds a script that automatically generates a JSON file listing all deprecated ESLint rules from core ESLint and all plugins used in the config. This enables tooling to programmatically identify and handle deprecated rules.
Features
@typescript-eslintunicornjsdocimport-xpromisereactreact-hooksdepend@eslint-community/eslint-comments@rushstack@fluid-internal/fluidtsdocunused-importsflat.mts) and legacy CJS configs (recommended.js,strict.js)Output
The script generates
printed-configs/deprecated-rules.jsoncontaining:Usage
Test plan