Skip to content

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.

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 2 commits into from
Jun 5, 2024
Merged

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

merged 2 commits into from
Jun 5, 2024

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Jun 3, 2024 •
edited
Loading

PR Checklist

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.

💖

@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.

@netlify Netlify
Copy link

netlify bot commented Jun 3, 2024 •
edited
Loading

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

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: 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 your Netlify site configuration.

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Jun 3, 2024 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9996d9a. 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 💌 from NxCloud.

@JoshuaKGoldberg JoshuaKGoldberg requested a review from a team June 4, 2024 01:00
@bradzacher bradzacher added the tests anything to do with testing label Jun 4, 2024
Josh-Cena
Josh-Cena previously approved these changes Jun 4, 2024
View reviewed changes
@Josh-Cena
Copy link
Member

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

@JoshuaKGoldberg JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jun 4, 2024
@JoshuaKGoldberg JoshuaKGoldberg merged commit fd3b35e into typescript-eslint:main Jun 5, 2024
63 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the rule-docs-test-options-correct-blocks branch June 5, 2024 13:10
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Josh-Cena Josh-Cena Josh-Cena approved these changes

Assignees
No one assigned
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge tests anything to do with testing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Enforce that every rule and rule option has ❌ Incorrect and ✅ Correct examples
3 participants
@JoshuaKGoldberg @Josh-Cena @bradzacher