10000 Bug: [no-unused-vars] <should consider use in JSDoc> · Issue #8258 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

Bug: [no-unused-vars] <should consider use in JSDoc> #8258

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.

Sign up for GitHub

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

Jump to bottom
Closed
4 tasks done
parloti opened this issue Jan 15, 2024 · 1 comment
Closed
4 tasks done

Bug: [no-unused-vars] <should consider use in JSDoc> #8258

parloti opened this issue Jan 15, 2024 · 1 comment
Labels
wontfix This will not be worked on

Comments

@parloti
Copy link
Contributor
parloti commented Jan 15, 2024

Before You File a Bug Report Please Confirm You Have Done The Following...

  • I have tried restarting my IDE and the issue persists.
  • I have updated to the latest version of the packages.
  • I have searched for related issues and found none that matched my issue.
  • I have read the FAQ and my problem is not listed.

Playground Link

https://typescript-eslint.io/play/#ts=5.3.3&fileType=.ts&code=JYWwDg9gTgLgBAbzgeQHYBECmBnGUICecAvnAGb4hwDkAAgIaoDmArgDb1QD0AxtJtQDcAWABQY4KhiYoZej0xwAkkqkzEYscU2iuAKj1i4exLTaSA1igw48hEqfOorKtVG2jjXMZgAekWHIWVB4YYAhUOAAxYIAKAEoNTzgoTBgWKEiABhFRDyA&eslintrc=N4KABGBEBOCuA2BTAzpAXGUEKQHYHsBaWXWZRAE0IDcBDaVDSfAMxcgBpxtIABAFwCeABxQBjaAEth-QiniTc-APQFipclToN0URNGj5okbgF8QpoA&tsconfig=&tokens=false

Repro Code

import { OnDestroy } from '@angular/core';

interface IInter {

}

/**
 * {@link OnDestroy } {@link IInter}
 */
export function Fun() {
  return 0;
}

ESLint Config

module.exports = {
  parser: "@typescript-eslint/parser",
  rules: {
    "no-unused-vars": "off",
    "@typescript-eslint/no-unused-vars": "error"
  },
};

tsconfig

{
  "compilerOptions": {
    // ...
  }
}

Expected Result

I expected none of these errors to occur:

'OnDestroy' is defined but never used. 1:10 - 1:19
'IInter' is defined but never used. 3:11 - 3:17

Actual Result

The linter throws the following errors:

'OnDestroy' is defined but never used. 1:10 - 1:19
'IInter' is defined but never used. 3:11 - 3:17

Additional Info

No response
@parloti parloti added bug Something isn't working package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin triage Waiting for team members to take a look labels Jan 15, 2024
@Josh-Cena
Copy link
Member

typescript-eslint doesn't handle JSDoc. See gajus/eslint-plugin-jsdoc#858 and try jsdoc/no-undefined-types instead.

@Josh-Cena Josh-Cena closed this as not planned Won't fix, can't repro, duplicate, stale Jan 15, 2024
@Josh-Cena Josh-Cena added wontfix This will not be worked on and removed bug Something isn't working package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin triage Waiting for team members to take a look labels Jan 15, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
wontfix This will not be worked on
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@parloti @Josh-Cena
0