Skip to content
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

chore: enable eslint-plugin/require-meta-docs-description rule #5969

Conversation

bmish
Copy link
Contributor

@bmish bmish commented Nov 11, 2022

PR Checklist

Overview

Enable this optional rule for rule source files internally: https://github.com/eslint-community/eslint-plugin-eslint-plugin/blob/main/docs/rules/require-meta-docs-description.md

Same change in ESLint recently: eslint/eslint#16529

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @bmish!

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.

@nx-cloud
Copy link

nx-cloud bot commented Nov 11, 2022

☁️ Nx Cloud Report

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

📂 See all runs for this branch


✅ Successfully ran 46 targets

Sent with 💌 from NxCloud.

@netlify
Copy link

netlify bot commented Nov 11, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit f192f21
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/636d9d632559600008cf37d9
😎 Deploy Preview https://deploy-preview-5969--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@bradzacher bradzacher changed the title Enable eslint-plugin/require-meta-docs-description rule chore: enable eslint-plugin/require-meta-docs-description rule Nov 11, 2022
@bmish bmish force-pushed the eslint-plugin-require-meta-docs-description branch from 1893658 to f192f21 Compare November 11, 2022 00:54
@@ -257,6 +257,11 @@ module.exports = {
'./packages/eslint-plugin/src/rules/**/*.ts',
],
rules: {
'eslint-plugin/require-meta-docs-description': [
'error',
{ pattern: '^(Enforce|Require|Disallow) .+[^. ]$' },
Copy link
Member

Choose a reason for hiding this comment

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

Nice, TIL about this one. Eventually maybe we'll even narow this list down to two 😄

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Super, thanks as always @bmish! 🙌

@JoshuaKGoldberg JoshuaKGoldberg merged commit 0e1e71d into typescript-eslint:main Nov 11, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 19, 2022
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.

None yet

2 participants