chore: disambiguate internal types LanguageOptions and Rule
#19669
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
✅ Deploy Preview for docs-eslint canceled.
|
snitin315
previously approved these changes
Apr 29, 2025
lib/linter/linter.js
Outdated
| @@ -2645,7 +2644,7 @@ class Linter { | |||
| /** | |||
| * Defines a new linting rule. | |||
| * @param {string} ruleId A unique rule identifier | |||
| * @param {Rule} rule A rule object | |||
| * @param {JSRuleDefinition} rule A rule object | |||
There was a problem hiding this comment.
There's no type JSRuleDefinition defined or imported in this module?
There was a problem hiding this comment.
Fixed in e92fa18, thanks. I first thought to use JSRuleDefinition in this PR but since this is a legacy method parameter and it's typed as Rule.RuleModule in the TS types we can stick with that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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)
In the ESLint code, the types
LanguageOptionsandRuleare currently being used for both language-generic types (which now have equivalents in the core types) and for JavaScript-specific types. This PR resolves the ambiguities as follows:LanguageOptionsfrom core types is used.RuleDefinitionfrom core types is used.Linter.LanguageOptionsfrom the ESLint types is used with the aliasJSLanguageOptions. This is probably the name we'll use when the JS language logic is moved to the@eslint/jsplugin (similar toCSSLanguageOptionsorMarkdownLanguageOptions), so I chose to useJSLanguageOptionsto avoid confusion.Rule.RuleModulefrom the ESLint types is used with the aliasRule.Rule.RuleModuleis the type historically found in place ofJSRuleDefinitionin legacy code or for built-in rules.I also removed the unused
LanguageOptionstype fromlib/shared/types.js.Is there anything you'd like reviewers to focus on?