Skip to content

feat(utils): allow specifying additional rule meta.docs in RuleCreator #9025

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 6 commits into from
May 9, 2024
Merged

feat(utils): allow specifying additional rule meta.docs in RuleCreator #9025

merged 6 commits into from
May 9, 2024

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Apr 29, 2024 •
edited
Loading

BREAKING CHANGE:

Changes the default allowed types on custom rule docs.

PR Checklist

Overview

Adds an optional PluginDocs type parameter to RuleCreator that allows adding additional properties to meta.docs. That allows us to move extendsBaseRule, recommended, and requiresTypeChecking into our own ESLintPluginDocs interface so that they're no longer exposed to consumers.

Adds new RuleModuleWithMetaDocs and AnyRuleModuleWithMetaDocs interfaces so that we can finally get rid of the ?. after meta.docs in some of our internal tooling. And RuleMetaDataDocs no longer has an Options parameter, which simplifies some other types too.

Adds back in "layout" to meta.type as it actually is specified in https://eslint.org/docs/latest/extend/custom-rules.

💖

@JoshuaKGoldberg JoshuaKGoldberg added this to the 8.0.0 milestone Apr 29, 2024
@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 Apr 29, 2024 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit b60b726
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/663be9aa205b920008cc753e
😎 Deploy Preview https://deploy-preview-9025--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: 98 (🟢 up 2 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.

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Apr 29, 2024 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b60b726. 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 changed the title feat(utils): [RuleCreator] require specifying additional rule meta.docs feat(utils): require specifying additional rule meta.docs in RuleCreator Apr 29, 2024
@JoshuaKGoldberg JoshuaKGoldberg changed the title feat(utils): require specifying additional rule meta.docs in RuleCreator feat(utils): allow specifying additional rule meta.docs in RuleCreator Apr 29, 2024
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review April 29, 2024 12:05
@JoshuaKGoldberg JoshuaKGoldberg requested a review from a team April 29, 2024 12:05
@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Apr 29, 2024
Open
bradzacher
bradzacher approved these changes May 3, 2024
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.

nodyes

@JoshuaKGoldberg JoshuaKGoldberg merged commit b1c92d4 into typescript-eslint:v8 May 9, 2024
57 of 58 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the rule-creator-custom-docs-types branch May 9, 2024 00:15
@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request May 9, 2024
Closed
4 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@JamesHenry JamesHenry JamesHenry left review comments

@bradzacher bradzacher bradzacher approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@JoshuaKGoldberg @JamesHenry @bradzacher