Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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.

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
Merged
merged 3 commits into from
May 31, 2025
Merged

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

merged 3 commits into from
May 31, 2025

Conversation

cseas
Copy link
Contributor

@cseas cseas commented May 30, 2025

PR Checklist

Overview

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

@typescript-eslint
Copy link
Contributor

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.

@netlify Netlify
Copy link

netlify bot commented May 30, 2025 •
edited
Loading

✅ Deploy Preview for typescript-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...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
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 your Netlify project configuration.

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented May 30, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit f5f46a7.

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 at 2025-05-31 07:29:59 UTC

@cseas 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
bradzacher
bradzacher previously approved these changes May 31, 2025
View reviewed changes
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

Thank you for this!

@cseas cseas requested a review from bradzacher May 31, 2025 07:20
@cseas
Copy link
Contributor Author

cseas commented May 31, 2025

Noticed a small typo (typeScript -> typescript). Please re-approve, thanks!

@bradzacher bradzacher merged commit e493317 into typescript-eslint:main May 31, 2025
64 checks passed
@cseas cseas deleted the docs-jsdoc-link-faq branch May 31, 2025 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bradzacher bradzacher bradzacher approved these changes

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

Successfully merging this pull request may close these issues.

Docs: Mention jsdoc/no-undefined-types & similar in no-unused-vars docs page
2 participants
@cseas @bradzacher