Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
fix(website): add explicit frontmatter description to rule docs#5429
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
fix(website): add explicit frontmatter description to rule docs#5429
Uh oh!
There was an error while loading.Please reload this page.
Conversation
nx-cloudbot commentedAug 6, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
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 onhttps://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitorsper day. |
netlifybot commentedAug 6, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview fortypescript-eslint ready!
To edit notification comments on pull requests, go to yourNetlify site settings. |
Awesome! Thanks for the quick fix, I'll approve as soon as it is no longer in draft |
LGTM as well. Adds a bit of maintenance burden in the future (since the Jest tests are gone now) but I don't think a better solution exists with Docusaurus—unless you want to dynamically modify the Markdown files as a pre-build step! (Which sounds fine to me) |
codecovbot commentedAug 7, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Codecov Report
@@ Coverage Diff @@## main #5429 +/- ##==========================================+ Coverage 91.36% 93.83% +2.46%========================================== Files 132 290 +158 Lines 1494 9985 +8491 Branches 226 3005 +2779 ==========================================+ Hits 1365 9369 +8004- Misses 65 335 +270- Partials 64 281 +217
Flags with carried forward coverage won't be shown.Click here to find out more.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
🎉
This PR contains the following updates:| Package | Type | Update | Change ||---|---|---|---|| [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.32.0` -> `5.33.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.32.0/5.33.0) || [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.32.0` -> `5.33.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.32.0/5.33.0) |---### Release Notes<details><summary>typescript-eslint/typescript-eslint (@​typescript-eslint/eslint-plugin)</summary>### [`v5.33.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#​5330-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5320v5330-2022-08-08)[Compare Source](typescript-eslint/typescript-eslint@v5.32.0...v5.33.0)##### Bug Fixes- **eslint-plugin:** \[no-extra-parens] handle await with type assertion ([#​5428](typescript-eslint/typescript-eslint#5428)) ([e03826f](typescript-eslint/typescript-eslint@e03826f))- **website:** add explicit frontmatter description to rule docs ([#​5429](typescript-eslint/typescript-eslint#5429)) ([63cba5f](typescript-eslint/typescript-eslint@63cba5f))##### Features- **eslint-plugin:** \[member-ordering] support static blocks ([#​5417](typescript-eslint/typescript-eslint#5417)) ([5983e5a](typescript-eslint/typescript-eslint@5983e5a))- **eslint-plugin:** \[prefer-as-const] adds support for class properties ([#​5413](typescript-eslint/typescript-eslint#5413)) ([d2394f8](typescript-eslint/typescript-eslint@d2394f8))</details><details><summary>typescript-eslint/typescript-eslint (@​typescript-eslint/parser)</summary>### [`v5.33.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#​5330-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5320v5330-2022-08-08)[Compare Source](typescript-eslint/typescript-eslint@v5.32.0...v5.33.0)**Note:** Version bump only for package [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser)</details>---### Configuration📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.--- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.---This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xNTEuMiIsInVwZGF0ZWRJblZlciI6IjMyLjE1MS4yIn0=-->Co-authored-by: cabr2-bot <cabr2.help@gmail.com>Reviewed-on:https://codeberg.org/Calciumdibromid/CaBr2/pulls/1494Reviewed-by: 6543 <6543@noreply.codeberg.org>Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Uh oh!
There was an error while loading.Please reload this page.
PR Checklist
Overview
Per#5425 (comment), adds a frontmatter
description: ...to each rule equal to itsmeta.docs.description.To test, copy a link likehttps://deploy-preview-5429--typescript-eslint.netlify.app/rules/adjacent-overload-signatures into a DM with yourself on Slack.