refactor: type RuleModule docs generic for requiresTypeChecking - #964
Open
bmish wants to merge 1 commit into
Open
refactor: type RuleModule docs generic for requiresTypeChecking#964bmish wants to merge 1 commit into
bmish wants to merge 1 commit into
Conversation
Pass `{ requiresTypeChecking?: boolean }` as the `Docs` generic to
`TSESLint.RuleModule` so `meta.docs.requiresTypeChecking` is typed. This
removes three identical `@ts-expect-error` suppressions that worked around
the property being absent from the standard `RuleMetaDataDocs` type.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
bmish
marked this pull request as ready for review
June 7, 2026 21:09
bmish
enabled auto-merge (squash)
July 11, 2026 16:06
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
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
meta.docs.requiresTypeCheckingis a common ESLint-ecosystem convention but isn't part of@typescript-eslint/utils' standardRuleMetaDataDocstype. We were working around that with three identical@ts-expect-errorsuppressions.This passes
{ requiresTypeChecking?: boolean }as theDocsgeneric toTSESLint.RuleModule(its third type parameter, which flows intometa.docs), so the property is properly typed in one place — removing all three suppressions.Changes
lib/types.ts— augment theRuleModuleDocsgeneric.lib/rule-list.ts,lib/rule-list-columns.ts,lib/rule-doc-notices.ts— drop the now-unnecessary@ts-expect-errorcomments (and a redundantas boolean | undefinedcast).Test plan
npm run lint:typespasses.eslintpasses on changed files.🤖 Generated with Claude Code