Skip to content

chore: enable eslint-plugin-jsdoc internally #8145

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

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Extends the "plugin:jsdoc/recommended-typescript-error" preset and disables opinionated rules that don't match our pre-existing opinions. Most of those are around requiring docs to always exist.

Doesn't enable jsdoc/informative-docs. That rule is opinionated enough that I'll file a followup issue for it.

Sorry, something went wrong.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

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 Dec 27, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 52c365a
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/659ad027b0e46100086acd91
😎 Deploy Preview https://deploy-preview-8145--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: 99 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (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 site configuration.

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review December 29, 2023 19:27
@JoshuaKGoldberg JoshuaKGoldberg merged commit 1ee3087 into typescript-eslint:main Jan 7, 2024
@JoshuaKGoldberg JoshuaKGoldberg deleted the eslint-plugin-jsdoc-internally branch January 7, 2024 18:29
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Repo: Bring in eslint-plugin-jsdoc recommended-typescript-error preset
2 participants