Skip to content

Docs: Mention jsdoc/no-undefined-types & similar in no-unused-vars docs page #11210

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
2 tasks done
JoshuaKGoldberg opened this issue May 13, 2025 · 1 comment
Open
2 tasks done
Labels
documentation Documentation ("docs") that needs adding/updating triage Waiting for team members to take a look

Comments

@JoshuaKGoldberg
Copy link
Member

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

@typescript-eslint/no-unused-vars regularly gets one of our most commonly duplicated issues: that it reports on types only used in JSDoc locations. #11208, #10873, #9435, #8902, #5017, #6967, #7944, #8258, etc. I think this is a sign we should document something on the rule page.

#11208 (comment) mentioned jsdoc/no-undefined-types. I think we should at least add an FAQ for it.

Affected URL(s)

https://typescript-eslint.io/rules/no-unused-vars/#faqs

Additional Info

Are there other common "gotcha"s with no-unused-vars we should also add FAQs for?

@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for team members to take a look documentation Documentation ("docs") that needs adding/updating labels May 13, 2025
@Andarist
Copy link
Contributor

For reference, this is how I ended up configuring it: statelyai/xstate#5279

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation ("docs") that needs adding/updating triage Waiting for team members to take a look
Projects
None yet
Development

No branches or pull requests

2 participants