Skip to content

fix(eslint-plugin): [no-unused-vars] no is assigned a value but only used as a type error when it has a same name #11322

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

nayounsang
Copy link
Contributor

@nayounsang nayounsang commented Jun 20, 2025

PR Checklist

Overview

Strict checks on exports with same type and variable name

  • If the name is the same, the variable is isTypeVariable && isValueVariable.
  • ClassName, TSEnumName, TSModuleName, ImportBinding and arguments also have same characteristics
  • Therefore, only the cases that correspond to the issue are properly verified.

Perform additional validating for abnormal cases

  • def.node.type !== AST_NODE_TYPES.TSTypeAliasDeclaration

Add test cases

  • tc mentioned in issue and similar but valid

@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 on https://opencollective.com/typescript-eslint.

Copy link

netlify bot commented Jun 20, 2025

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 2f474b3
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/6855574bb5b6cb000850e215
😎 Deploy Preview https://deploy-preview-11322--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: 90 (🔴 down 8 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (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 your Netlify project configuration.

@nayounsang nayounsang changed the title fix(eslint-plugin): [no-unused-vars] no is assigned a value but only used as a type error when it has a same name type alias declaration exporte fix(eslint-plugin): [no-unused-vars] no is assigned a value but only used as a type error when it has a same name Jun 20, 2025
Copy link

nx-cloud bot commented Jun 20, 2025

View your CI Pipeline Execution ↗ for commit 2f474b3.

Command Status Duration Result
nx test eslint-plugin --coverage=false ✅ Succeeded 5m 1s View ↗
nx run-many -t typecheck ✅ Succeeded 2m 6s View ↗
nx test eslint-plugin-internal --coverage=false ✅ Succeeded <1s View ↗
nx run integration-tests:test ✅ Succeeded <1s View ↗
nx run types:build ✅ Succeeded <1s View ↗
nx run-many -t lint ✅ Succeeded 10s View ↗
nx test typescript-estree --coverage=false ✅ Succeeded <1s View ↗
nx run generate-configs ✅ Succeeded 4s View ↗
Additional runs (27) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-06-20 12:53:10 UTC

Copy link

codecov bot commented Jun 20, 2025

Codecov Report

Attention: Patch coverage is 88.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 90.84%. Comparing base (76cc62c) to head (2f474b3).
Report is 11 commits behind head on main.

Files with missing lines Patch % Lines
...s/eslint-plugin/src/util/collectUnusedVariables.ts 88.00% 3 Missing ⚠️

❌ Your patch check has failed because the patch coverage (88.00%) is below the target coverage (90.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11322   +/-   ##
=======================================
  Coverage   90.84%   90.84%           
=======================================
  Files         501      501           
  Lines       50911    50932   +21     
  Branches     8383     8391    +8     
=======================================
+ Hits        46248    46269   +21     
  Misses       4648     4648           
  Partials       15       15           
Flag Coverage Δ
unittest 90.84% <88.00%> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
...s/eslint-plugin/src/util/collectUnusedVariables.ts 96.34% <88.00%> (+0.15%) ⬆️
🚀 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.

function isSafeUnusedExportCondition(variable: ScopeVariable): boolean {
if (variable instanceof ESLintScopeVariable) {
return true;
}
Copy link
Contributor Author

@nayounsang nayounsang Jun 20, 2025

Choose a reason for hiding this comment

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

need advice

I don't know why this condition is necessary. Can't the arg type of isExported, isMergableExported be used as Variable?
Actually, it is used as Variable only.

Copy link
Member

Choose a reason for hiding this comment

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

it is used as Variable only

👍 any reason not to change its type from ScopeVariable to Variable? I tried the three : ScopeVariable parameters to : Variable locally and everything looked happy.

@@ -465,7 +495,12 @@ function isExported(variable: ScopeVariable): boolean {
}

// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
return node.parent!.type.startsWith('Export');
const isExportedFlag = node.parent!.type.startsWith('Export');
Copy link
Contributor Author

@nayounsang nayounsang Jun 20, 2025

Choose a reason for hiding this comment

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

need advice

Is there a reason why didn't use optional chaining before?

Copy link
Member

Choose a reason for hiding this comment

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

tl;dr: the ! is the right thing to use here. node.parent definitely always exists, so it'd be unnecessary to add extra runtime logic with a ?.. The types are wrong!

Other code using ?. isn't ideal, but is existing cruft that we'll clean up eventually.


Digging in for fun...

To see what node type(s) don't know that the parent property definitely exists, you can hover or use a twoslash query on:

node;
// ^? let node: TSESTree.CatchClause | TSESTree.ArrayPattern | TSESTree.ObjectPattern | TSESTree.Identifier | TSESTree.ClassDeclarationWithName | ... 192 more ... | TSESTree.YieldExpression

if (!node.parent) {
  node;
  // ^? let node: TSESTree.Program
}

TSESTree.Program is the AST root representing a file. Why is node allowed to be TSESTree.Program?

Its definition comes from:

  • definition.node is the DefinitionBase type parameter Node extends ESTree.Node
  • definition itself comes from variable.defs, which is the VariableBase property defs: Definition[]

I think the root issue, then, is that Definition says its node can be any TSESTree.Node, including TSESTree.Program - the only node type that doesn't have a parent. Which feels weird and wrong to me. What kind of scope-manager definition would come from a TSESTree.Program?

Filed: #11334. Once that's fixed then lint rules will force this code to remove unnecessary !.s and ?.s.

@nayounsang
Copy link
Contributor Author

Its a different issue:#8315, but we need to figure out if this is a workable solution.

@nayounsang
Copy link
Contributor Author

Its a different issue:#8315, but we need to figure out if this is a workable solution.

Ah, it is different. should change validate logic.
I think I need to work on another PR. If this PR is headed in the right direction.

@JoshuaKGoldberg
Copy link
Member

I think I need to work on another PR. If this PR is headed in the right direction.

@nayounsang apologies, I'm not following - are you suggesting we should or shouldn't review this PR?

@nayounsang
Copy link
Contributor Author

@JoshuaKGoldberg
Oh, please review this PR. I'm ready.

The comments are my own monologue. I tend to take notes of everything and I just saw another issue that seemed related to this PR. After looking into it, it seems that even if this PR is resolved, there will be additional work needed to resolve the other issues.

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

🙌 Looks like a good start! I didn't review deeply because the .every line looks like it's either unnecessary or not fully tested. Which makes me suspect things might change up a bit. Could you please take a look?

@@ -441,7 +467,9 @@ function isMergableExported(variable: ScopeVariable): boolean {
def.node.parent?.type === AST_NODE_TYPES.ExportNamedDeclaration) ||
def.node.parent?.type === AST_NODE_TYPES.ExportDefaultDeclaration
) {
return true;
return (
safeFlag || def.node.type !== AST_NODE_TYPES.TSTypeAliasDeclaration
Copy link
Member

Choose a reason for hiding this comment

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

[Performance] There's no need to run through isSafeUnusedExportCondition(...) until it's used:

Suggested change
safeFlag || def.node.type !== AST_NODE_TYPES.TSTypeAliasDeclaration
def.node.type !== AST_NODE_TYPES.TSTypeAliasDeclaration || isSafeUnusedExportCondition(variable)

@@ -465,7 +495,12 @@ function isExported(variable: ScopeVariable): boolean {
}

// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
return node.parent!.type.startsWith('Export');
const isExportedFlag = node.parent!.type.startsWith('Export');
Copy link
Member

Choose a reason for hiding this comment

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

tl;dr: the ! is the right thing to use here. node.parent definitely always exists, so it'd be unnecessary to add extra runtime logic with a ?.. The types are wrong!

Other code using ?. isn't ideal, but is existing cruft that we'll clean up eventually.


Digging in for fun...

To see what node type(s) don't know that the parent property definitely exists, you can hover or use a twoslash query on:

node;
// ^? let node: TSESTree.CatchClause | TSESTree.ArrayPattern | TSESTree.ObjectPattern | TSESTree.Identifier | TSESTree.ClassDeclarationWithName | ... 192 more ... | TSESTree.YieldExpression

if (!node.parent) {
  node;
  // ^? let node: TSESTree.Program
}

TSESTree.Program is the AST root representing a file. Why is node allowed to be TSESTree.Program?

Its definition comes from:

  • definition.node is the DefinitionBase type parameter Node extends ESTree.Node
  • definition itself comes from variable.defs, which is the VariableBase property defs: Definition[]

I think the root issue, then, is that Definition says its node can be any TSESTree.Node, including TSESTree.Program - the only node type that doesn't have a parent. Which feels weird and wrong to me. What kind of scope-manager definition would come from a TSESTree.Program?

Filed: #11334. Once that's fixed then lint rules will force this code to remove unnecessary !.s and ?.s.

function isSafeUnusedExportCondition(variable: ScopeVariable): boolean {
if (variable instanceof ESLintScopeVariable) {
return true;
}
Copy link
Member

Choose a reason for hiding this comment

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

it is used as Variable only

👍 any reason not to change its type from ScopeVariable to Variable? I tried the three : ScopeVariable parameters to : Variable locally and everything looked happy.

if (variable.isTypeVariable && variable.isValueVariable) {
return !variable.defs
.map(d => d.type)
.every(t => exportExceptDefTypes.includes(t));
Copy link
Member

Choose a reason for hiding this comment

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

[Testing] If I comment out this .every, then all tests still pass. In fact, if the inside of the if just does return false; then tests still pass. So either this is unnecessary code or there's a gap in test coverage.

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Jun 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting response Issues waiting for a reply from the OP or another party
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: [no-unused-vars] no is assigned a value but only used as a type error when it has a same name type alias declaration exported
2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy