Skip to content

chore: fix internal type references to Plugin and Rule - #19665

Merged
mdjermanovic merged 1 commit into
mainfrom
fix-internal-types
Apr 28, 2025
Merged

mdjermanovic merged 1 commit into
mainfrom
fix-internal-types

Conversation

@fasttime

Copy link
Copy Markdown
Member

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[X] Other, please explain:

Fix internal types

What changes did you make? (Give an overview)

I noticed that the Plugin type defined in lib/shared/types was out of date, so I removed it and replaced its references with ESLint.Plugin from the TypeScript types in lib/types.

I also replaced references to the previously removed Rule type in lib/shared/types.js with Rule.RuleModule from lib/types.

Is there anything you'd like reviewers to focus on?

@github-project-automation github-project-automation Bot moved this to Needs Triage in Triage Apr 28, 2025
@eslint-github-bot eslint-github-bot Bot added the chore This change is not user-facing label Apr 28, 2025
@netlify

netlify Bot commented Apr 28, 2025 •

Copy link
Copy Markdown

✅ Deploy Preview for docs-eslint canceled.

Name Link
🔨 Latest commit 00fa527
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/680f58ceeca38b000820516b

@github-actions github-actions Bot added rule Relates to ESLint's core rules cli Relates to ESLint's command-line interface core Relates to ESLint's core APIs and features labels Apr 28, 2025
* rules.get("semi"); // call `() => require("semi")` here.
*
* @extends {Map<string, () => Rule>}
* @extends {Map<string, Rule>}

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was an oversight in the current JSDoc.

@fasttime fasttime added the types Related to TypeScript types label Apr 28, 2025
@fasttime
fasttime marked this pull request as ready for review April 28, 2025 10:56
@fasttime
fasttime requested a review from a team as a code owner April 28, 2025 10:56

@mdjermanovic mdjermanovic left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@mdjermanovic
mdjermanovic merged commit f1c858e into main Apr 28, 2025
@mdjermanovic
mdjermanovic deleted the fix-internal-types branch April 28, 2025 13:43
@github-project-automation github-project-automation Bot moved this from Needs Triage to Complete in Triage Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore This change is not user-facing cli Relates to ESLint's command-line interface core Relates to ESLint's core APIs and features rule Relates to ESLint's core rules types Related to TypeScript types

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

2 participants