Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Open
nayounsang wants to merge27 commits intotypescript-eslint:main
base:main
Choose a base branch
Loading
fromnayounsang:auto-unused

Conversation

nayounsang
Copy link
Contributor

@nayounsangnayounsang commentedMay 23, 2025
edited
Loading

PR Checklist

Overview

Auto fix & suggest unused import statements

  • Test cases that correspond to the issue can be fixed
  • add option:enableAutofixRemoval.imports: boolean , not enable default

examples

importUnused1from'foo';importUnused2,{Used}from'bar';export{Used};import{Used}from'bar';export{Used};// -------------------import{Unused1}from'foo';importUsed1,{Unused2}from'bar';import{Used2,Unused3}from'baz';importUsed3,{Unused4,Used4}from'foobar';export{Used1,Used2,Used3,Used4};importUsed1from'bar';import{Used2}from'baz';importUsed3,{Used4}from'foobar';export{Used1,Used2,Used3,Used4};// -----------------import{/* cmt */Unused1,Used1}from'foo';export{Used1};import{/* cmt */Used1}from'foo';export{Used1};// ------------------importtype{UnusedType}from'foo';import{Used1,Unused1}from'foo';export{Used1};import{Used1}from'foo';export{Used1};// -----------------import{Unused1asu1,Used1asu2}from'foo';export{u2};import{Used1asu2}from'foo';export{u2};

algoORgoal reacted with thumbs up emoji
@typescript-eslint
Copy link
Contributor

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.

@netlifyNetlify
Copy link

netlifybot commentedMay 23, 2025
edited
Loading

Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commiteb3fd2b
🔍 Latest deploy loghttps://app.netlify.com/projects/typescript-eslint/deploys/6874a6c99b97730008ee5601
😎 Deploy Previewhttps://deploy-preview-11243--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 98 (🟢 up 9 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to yourNetlify project configuration.

@nayounsangnayounsang marked this pull request as draftMay 23, 2025 15:53
@nx-cloudNx Cloud
Copy link

nx-cloudbot commentedMay 23, 2025
edited
Loading

View yourCI Pipeline Execution ↗ for commiteb3fd2b

CommandStatusDurationResult
nx test eslint-plugin --coverage=false✅ Succeeded5m 6sView ↗
nx run-many -t lint✅ Succeeded3m 11sView ↗
nx run-many -t typecheck✅ Succeeded2m 5sView ↗
nx test eslint-plugin-internal --coverage=false✅ Succeeded5sView ↗
nx run integration-tests:test✅ Succeeded4sView ↗
nx test typescript-estree --coverage=false✅ Succeeded2sView ↗
nx run types:build✅ Succeeded5sView ↗
nx run generate-configs✅ Succeeded6sView ↗
Additional runs (27)✅ Succeeded...View ↗

☁️Nx Cloud last updated this comment at2025-07-14 06:53:42 UTC

@nayounsang
Copy link
ContributorAuthor

Wow, when adding a new feature, a follow-up development is needed. I'll work on it tomorrow.

@codecovCodecov
Copy link

codecovbot commentedMay 24, 2025
edited
Loading

Codecov Report

Attention: Patch coverage is94.52055% with4 lines in your changes missing coverage. Please review.

Project coverage is 90.85%. Comparing base(16c344e) to head(eb3fd2b).
Report is 6 commits behind head on main.

Files with missing linesPatch %Lines
packages/eslint-plugin/src/rules/no-unused-vars.ts94.52%4 Missing⚠️
Additional details and impacted files
@@           Coverage Diff           @@##             main   #11243   +/-   ##=======================================  Coverage   90.85%   90.85%           =======================================  Files         501      501             Lines       50987    51060   +73       Branches     8410     8430   +20     =======================================+ Hits        46324    46393   +69- Misses       4648     4652    +4  Partials       15       15
FlagCoverage Δ
unittest90.85% <94.52%> (+<0.01%)⬆️

Flags with carried forward coverage won't be shown.Click here to find out more.

Files with missing linesCoverage Δ
packages/eslint-plugin/src/rules/no-unused-vars.ts99.41% <94.52%> (-0.59%)⬇️
🚀 New features to boost your workflow:
  • ❄️Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nayounsangnayounsang marked this pull request as ready for reviewJune 5, 2025 06:13
Copy link
Member

@kirkwaiblingerkirkwaiblinger left a 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!


const source = context.sourceCode;
const node = def.node;
const decl = node.parent as TSESTree.ImportDeclaration;

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.

Copy link
ContributorAuthor

@nayounsangnayounsangJun 6, 2025
edited
Loading

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

@@ -687,6 +708,80 @@ export default createRule<Options, MessageIds>({
data: unusedVar.references.some(ref => ref.isWrite())
? getAssignedMessageData(unusedVar)
: getDefinedMessageData(unusedVar),
fix: options.enableAutofixRemoval?.imports

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]};
}
}

Copy link
ContributorAuthor

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) {
return fixer.removeRange([
decl.range[0],
decl.range[1] + 1, // +1 to include "\n"

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).

nayounsang reacted with thumbs up emoji
Copy link
ContributorAuthor

@nayounsangnayounsangJun 6, 2025
edited
Loading

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

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Add new message:unusedVarSuggestion. However, I'm concerned about the proposed message:Remove unused variable.. Any thoughts?

related commit:2c8b740 &9a15d49

@kirkwaiblingerkirkwaiblinger added the awaiting responseIssues waiting for a reply from the OP or another party labelJun 6, 2025
@nayounsang
Copy link
ContributorAuthor

nayounsang commentedJun 11, 2025
edited
Loading

@kirkwaiblinger Hi. I committed my code about your review and TODOs! Please make sure I'm on the right track.
The problem to be solved now is: Problem with unformatted code. (Based on 0-index) Odd specifiers are not deleted.
Um... I run console.log in the local and see results of the ranges need to be deleted, and in this case, the range to delete did not conflict! I don't know why.

// 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.
For ex

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';
kirkwaiblinger reacted with eyes emoji

Copy link
ContributorAuthor

@nayounsangnayounsang left a comment
edited
Loading

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.

@bradzacherbradzacher changed the titlefeat(eslint-plugin): add a default-off option to autofix remove unused importsfeat(eslint-plugin): [no-unused-vars] add a default-off option to autofix remove unused importsJul 9, 2025
@bradzacherbradzacher removed the awaiting responseIssues waiting for a reply from the OP or another party labelJul 13, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@kirkwaiblingerkirkwaiblingerAwaiting requested review from kirkwaiblinger

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Enhancement: [no-unused-vars] add a default-off option to autofix remove unused imports
3 participants
@nayounsang@kirkwaiblinger@bradzacher

[8]ページ先頭

©2009-2025 Movatter.jp