fix: correct typings for loadESLint() and shouldUseFlatConfig()
#20393
+20
−14
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.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects the TypeScript type definitions for the loadESLint() function to match its actual implementation, which no longer accepts parameters after ESLint v10.0.0 dropped support for ESLintrc.
- Updated the
loadESLint()type signature to remove the optionaluseFlatConfigparameter - Refactored
AST.Rangetype to useSourceRangeinstead of inline[number, number]tuple - Updated type tests to verify that passing arguments now produces TypeScript errors
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| lib/types/index.d.ts | Updated loadESLint() signature to accept no parameters and refactored AST.Range to use SourceRange type |
| tests/lib/types/types.test.ts | Added @ts-expect-error annotations to verify that passing arguments to loadESLint() correctly produces TypeScript errors |
lumirlumir
changed the title
loadESLint()loadESLint() and shouldUseFlatConfig()
github-actions
bot
added
cli
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
[x] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
In this PR, I've corrected the typings for
loadESLint()andshouldUseFlatConfig().After dropping support for ESLintrc, it seems the typings for
loadESLint()were not updated. As a result, the current implementation doesn't accept any value, but the typings do:eslint/lib/api.js
Lines 21 to 27 in e7673ae
eslint/lib/types/index.d.ts
Lines 1340 to 1342 in e7673ae
Just to confirm: git blame shows it wasn't updated when eslintrc support was dropped.
Also, it seems the typings for
shouldUseFlatConfigwere not updated. As a result, the current implementation only returnstrue, but the type definition specifiesboolean:eslint/lib/eslint/eslint.js
Lines 1347 to 1353 in e7673ae
eslint/lib/types/use-at-your-own-risk.d.ts
Lines 33 to 34 in e7673ae
Just to confirm: git blame shows it wasn't updated when eslintrc support was dropped.
Also, as a minor refactor, I replaced the
[number, number]type with theSourceRangetype.Is there anything you'd like reviewers to focus on?
N/A