docs(eslint-plugin): add FAQ about JSDoc link usage with no-unused-vars#11259

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

Jump to bottom

Merged

bradzacher merged 3 commits intotypescript-eslint:mainfromcseas:docs-jsdoc-link-faq

May 31, 2025

Merged

docs(eslint-plugin): add FAQ about JSDoc link usage with no-unused-vars#11259

bradzacher merged 3 commits intotypescript-eslint:mainfromcseas:docs-jsdoc-link-faq

May 31, 2025

Conversation

Copy link

Contributor

cseas commentedMay 30, 2025

PR Checklist

Addresses an existing open issue:fixesDocs: Mention jsdoc/no-undefined-types & similar in no-unused-vars docs page #11210
That issue was marked asaccepting prs
Steps inContributing were taken

Overview

Added an FAQ about JSDoc not being supported byno-unused-vars with a reference tojsdoc/no-undefined-types as an alternative recommendation.

docs(no-unused-vars): add FAQ about link usage in JSDoc

4c3058b

Copy link

Contributor

typescript-eslintbot commentedMay 30, 2025

Thanks for the PR,@cseas!

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

netlifybot commentedMay 30, 2025•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`f5f46a7`
🔍 Latest deploy log	https://app.netlify.com/projects/typescript-eslint/deploys/683aada3a2783a00089a6589
😎 Deploy Preview	https://deploy-preview-11259--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 75 (🔴 down 22 from production) Accessibility: 100 (no change from production) Best Practices: 100 (no change from production) SEO: 98 (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.

Copy link

nx-cloudbot commentedMay 30, 2025•
edited
Loading

View yourCI Pipeline Execution ↗ for commitf5f46a7.

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

☁️Nx Cloud last updated this comment at2025-05-31 07:29:59 UTC

cseas changed the title~~docs(no-unused-vars): add FAQ about link usage in JSDoc~~docs(eslint-plugin): add FAQ about JSDoc link usage with no-unused-vars

May 30, 2025

lint: prettier fix

612c10d