Update ESLint config to accept separate type imports in TS again #5000
Conversation
This file contains 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
e.g., not say 'duplicate import' for this code:
import React from 'react'
import type { ReactNode } from 'react'
…which used to work fine, but typescript-eslint's no-duplicate-imports
rule has been removed:
- typescript-eslint/typescript-eslint@47eeea9275bd
- https://typescript-eslint.io/rules/no-duplicate-imports/
We could do more with this plugin.
Only skimmed it, but some of the other features might require some
more config.
- https://github.com/import-js/eslint-plugin-import/blob/main/README.md#resolvers
(Meanwhile, I'll try not to think about how many dev dependencies
we bring in just for this cool rule.)
p2edwards
added
workflow
13 tasks
magicznyleszek
approved these changes
Jul 17, 2024
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.
Description
Install eslint-plugin-import to improve the check for duplicate imports in TypeScript files. This permits the use of 2 imports again—when one is just for types. This was working before until updating typescript-eslint to v6, when they removed their version of this rule, deferring to the plugin.
Notes
Kudos to @magicznyleszek for pointing out this unwanted warning after #4985:
In v6,
typescript-eslintdeprecated their version of theno-duplicate-importsrule, in favor ofeslint-plugin-import. So, after #4985, TS code would fall back to the JS rule, which doesn't distinguish type-only imports.What works now is to install and configure the suggested
'import'plugin and use theirimport/no-duplicatesrule.We can probably get more mileage out of this plugin, but for now I just want to get this rule working.
Related issues
Follow-up to #4985