typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star15.8k

test(eslint-plugin): add docs test for Correct and Incorrect blocks#9239

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

JoshuaKGoldberg merged 2 commits intotypescript-eslint:mainfromJoshuaKGoldberg:rule-docs-test-options-correct-blocks

Jun 5, 2024

Merged

test(eslint-plugin): add docs test for Correct and Incorrect blocks#9239

JoshuaKGoldberg merged 2 commits intotypescript-eslint:mainfromJoshuaKGoldberg:rule-docs-test-options-correct-blocks

Jun 5, 2024

Conversation

Copy link

Member

JoshuaKGoldberg commentedJun 3, 2024•
edited
Loading

PR Checklist

Addresses an existing open issue:fixesDocs: Enforce that every rule and rule option has ❌ Incorrect and ✅ Correct examples #8154
That issue was marked asaccepting prs
Steps inContributing were taken

Overview

Following#8015, this adds additional testing to ensure there's both a ✅ Correct and an ❌ Incorrect tab item for each rule option.

A lot of existing rule docs don't yet adhere to this. Rather than try to fix them all in this PR, I added an allowlist with a TODO comment.

💖

test(eslint-plugin): add docs test for Correct and Incorrect blocks

a67b22d

Copy link

Contributor

typescript-eslintbot commentedJun 3, 2024

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

netlifybot commentedJun 3, 2024•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`9996d9a`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/665f83032743b00008b4b416
😎 Deploy Preview	https://deploy-preview-9239--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (no change from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 90 (🔴 down 8 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 site configuration.

Copy link

nx-cloudbot commentedJun 3, 2024•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit9996d9a. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 31 targets

Sent with 💌 fromNxCloud.

JoshuaKGoldberg requested a review froma team

June 4, 2024 01:00

bradzacher added the testsanything to do with testing label

Jun 4, 2024

Josh-Cena previously approved these changes

Jun 4, 2024

View reviewed changes

packages/eslint-plugin/tests/docs.test.tsShow resolvedHide resolved

Copy link

Member

Josh-Cena commentedJun 4, 2024

There are probably some complex situations (for example,https://typescript-eslint.io/rules/ban-ts-comment/ is actually fine), but we can fix the invalid ones first