Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
feat(eslint-plugin): [no-unused-vars] add a default-off option to autofix remove unused imports#11243
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Conversation
Thanks for the PR,@nayounsang! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently onhttps://opencollective.com/typescript-eslint. |
netlifybot commentedMay 23, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview fortypescript-eslint ready!
To edit notification comments on pull requests, go to yourNetlify project configuration. |
nx-cloudbot commentedMay 23, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
View yourCI Pipeline Execution ↗ for commitac3ead7
☁️Nx Cloud last updated this comment at |
nayounsang commentedMay 23, 2025
Wow, when adding a new feature, a follow-up development is needed. I'll work on it tomorrow. |
codecovbot commentedMay 24, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@## main #11243 +/- ##==========================================+ Coverage 90.85% 90.88% +0.03%========================================== Files 501 505 +4 Lines 50987 51256 +269 Branches 8410 8454 +44 ==========================================+ Hits 46324 46586 +262- Misses 4648 4656 +8+ Partials 15 14 -1
Flags with carried forward coverage won't be shown.Click here to find out more.
🚀 New features to boost your workflow:
|
Uh oh!
There was an error while loading.Please reload this page.
This reverts commite5394b2.
kirkwaiblinger left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
A great start!
I'm leaving a bit of a drive-by review since I see that there are several major TODOs in the code that need to get resolved. Feel free to reach out if you're looking for help with those! In the meantime, I'm going to leave a Changes Requested review so that this isn't in our ready-to-review queue.
Thanks!
| constsource=context.sourceCode; | ||
| constnode=def.node; | ||
| constdecl=node.parentasTSESTree.ImportDeclaration; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think that this will be unsound forimport = require-style imports, for example
importx= require('foo')
Let's be sure to include some test coverage with that style ofimport.
nayounsangJun 6, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Oh, nice catch. This isTSImportEqualsDeclaration type.
I test with this code:
{code:`import x = require('foo');import y = require('bar');export { y }; `,errors:[{messageId:'unusedVar'}],options:[{enableAutofixRemoval:{imports:true}}],output:`import y = require('bar');export { y }; `,}
In the existing logic, an error occurs and a more accurate logic is used rather than type casting.
related commit:11ac4fa
| data:unusedVar.references.some(ref=>ref.isWrite()) | ||
| ?getAssignedMessageData(unusedVar) | ||
| :getDefinedMessageData(unusedVar), | ||
| fix:options.enableAutofixRemoval?.imports |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This seems useful as a suggestion, even if the autofix option is disabled. Consider usinggetFixOrSuggest to conditionally provide this fix as a suggestion?
| exportfunctiongetFixOrSuggest<MessageIdextendsstring>({ | |
| fixOrSuggest, | |
| suggestion, | |
| }:{ | |
| fixOrSuggest:'fix'|'none'|'suggest'; | |
| suggestion:TSESLint.SuggestionReportDescriptor<MessageId>; | |
| }): | |
| |{fix:TSESLint.ReportFixFunction} | |
| |{suggest:TSESLint.SuggestionReportDescriptor<MessageId>[]} | |
| |undefined{ | |
| switch(fixOrSuggest){ | |
| case'fix': | |
| return{fix:suggestion.fix}; | |
| case'none': | |
| returnundefined; | |
| case'suggest': | |
| return{suggest:[suggestion]}; | |
| } | |
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Good idea. However, it would be better to provide suggestions to existing test cases and then resolvethis comment before processing.
| if(decl.specifiers.length===1){ | ||
| returnfixer.removeRange([ | ||
| decl.range[0], | ||
| decl.range[1]+1,// +1 to include "\n" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
to include "\n"
Why do we want to do this exactly? This causes a bug with this technically valid code (please include as a test case - hint, you'll need to usenoFormat):
importxfrom'foo';importyfrom'bar'
My instinct is to say we're better off just leaving a blank line and letting the user decide how to format it afterwards (whether by hand or with prettier or similar).
nayounsangJun 6, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
we're better off just leaving a blank line and letting the user decide how to format it afterwards (whether by hand or with prettier or similar).
Wow, that's right. That should have been it. Plus, it lowers the difficulty of solving the problem and the code becomes simpler.
related commit:9f76441 &633d2c8
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
packages/eslint-plugin/tests/rules/no-unused-vars/no-unused-vars.test.ts OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
nayounsang commentedJun 11, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
@kirkwaiblinger Hi. I committed my code about your review and TODOs! Please make sure I'm on the right track. // test caseimport{A,B,C,D,E,F,G,Used1,H,I,J,K}from'foo';export{Used1};// expectimport{Used1}from'foo';export{Used1};// receivedimport{B,D,F,Used1,I,K}from'foo'export{Used1}; How can I solve this problem? My idea is to merge the contiguous segments and remove multiple specifiers at once. import{A,B,C,D,E,F,G,Used1,H,I,J,K}from'foo';// ->import{Used1,H,I,J,K}from'foo';// ->import{Used1}from'foo'; |
nayounsang left a comment• edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'm going to try something different than my previous commit.This is reason & plan:1. Fixing multiple specifers at once is confusing and incompatible with the existing way of reporting.2. Test cases that test for multiple types of imports are more suitable for Unit testing.Done, I apologize to the reviewer for the change, but I think this is the right direction.
bradzacher left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
could you please add a test forimport { Unused1, Unused2 } from 'mod'?
it looks like your logic currently will not remove the import declaration in this case -- which would be the desired result
nayounsang commentedAug 17, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
@bradzacher // receivedimport{a,b}from'foo';// expected// receivedimporta,{b,c}from'foo';console.log(a);// expectedimportafrom'foo';console.log(a) I'm curious about the direction. // To express it in pseudocode...constallNamedSpecifersCount=decl.specifiers.filter(s=>s.type===AST_NODE_TYPES.ImportSpecifier,);if(unusedNamedSpecifiersCount===allNamedSpecifiersCount){returnfixer.removeRange([startBraceToken.range[0],endBraceToken.range[1],]);}
Is there another better way? Anyway I'll try implementing it my way and then req for review. |
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
| ); | ||
| constfirstBraceToken=source.getTokenBefore( | ||
| unusedSpecifiers[0], | ||
| ); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This logic assume that unusedVariables collected sequentially from the code.
Deductively, it works fine.
But, I'm not really sure if that's true in all cases.
constanalysisResults=collectVariables(context);constvariables=[ ...Array.from(analysisResults.unusedVariables,variable=>({used:false, variable,})), ...Array.from(analysisResults.usedVariables,variable=>({used:true, variable,})),];
JoshuaKGoldberg left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Looking good! Just a few small touchup suggestions from me, nothing serious.
If@bradzacher and/or@kirkwaiblinger have time to review that'd be great - so I'll hold off on merging for a bit. But if they don't (they're busy this month & we've got a lot of PRs going on) then I feel comfortable merging this soon.
Thanks! 😊
| recommended:'recommended', | ||
| }, | ||
| fixable:'code', | ||
| // If generate suggest dynamically, disable the eslint rule. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| //If generate suggest dynamically, disable the eslint rule. | |
| //Suggestions are generated dynamically by getFixOrSuggest |
| hasSuggestions:true, | ||
| messages:{ | ||
| unusedVar:"'{{varName}}' is {{action}} but never used{{additional}}.", | ||
| unusedVarSuggestion:'Remove unused variable.', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
[Bug] This is specific to imports, so we should be more specific here I think.
| unusedVarSuggestion:'Remove unusedvariable.', | |
| removeUnusedImport:'Remove unusedimport.', |
| /** | ||
| * Collect unused import specifiers for the import declaration. | ||
| * Access the map by the import declaration. | ||
| */ | ||
| constunusedImportSpecifiersMap=newWeakMap< |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
[Style] A few interlinked suggestions:
- This comment doesn't add anything IMO: the variable is already named "unused import specifiers", and its type says that import declarations are the keys
- The
Mapsuffix in the name isn't necessary either - it's a map type already - It's kind of confusing to read through so much new logic, where a few dozen lines are just to populate a map. Let's move the logic into a function outside of the rule.
| /** | |
| *Collectunusedimportspecifiersfortheimportdeclaration. | |
| *Accessthemapbytheimportdeclaration. | |
| */ | |
| constunusedImportSpecifiersMap=newWeakMap< | |
| constunusedImportSpecifiers= | |
| collectUnusedImportSpecifiers(unusedVars); |
| options:[{enableAutofixRemoval:{imports:true}}], | ||
| output:` | ||
| `, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Moving#11243 (review) ⯫ (comment) into a thread:
yes, it is not supported. When handling this, a conflict occurs in the range that the fixer removes, and is therefore ignored.
Just to confirm what it looks like the implementation went with: conflicts are ok! ESLint runs up to 10 passes of auto-fixing. If there are 2-3 fixes in a range and only 1-2 get applied in a time, that's fine. It'll get all of them eventually. Fixes are by design meant to always improve codebase quality. They never backtrack.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Okay. Then, I think I can just delete the complex (conflict-causing) test case and the logic surroundingthis comment (this will greatly simplify the overall logic).
I'll wait for other people's opinions.
nayounsang commentedNov 6, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
TODO: This pr adds options separate fromeslint's options, so I think it needs to add something inthe documentation. |

Uh oh!
There was an error while loading.Please reload this page.
PR Checklist
Overview
Auto fix & suggest unused import statements
enableAutofixRemoval.imports: boolean, not enable defaultexamples