fix(website): add explicit frontmatter description to rule docs #5429
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify 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) |
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.
|
crapStone
pushed a commit
to Calciumdibromid/CaBr2
that referenced
this pull request
Aug 9, 2022
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/1494 Reviewed-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>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
Overview
Per #5425 (comment), adds a frontmatter
description: ...to each rule equal to itsmeta.docs.description.To test, copy a link like https://deploy-preview-5429--typescript-eslint.netlify.app/rules/adjacent-overload-signatures into a DM with yourself on Slack.