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

fix(website): add explicit frontmatter description to rule docs #5429

Conversation

JoshuaKGoldberg
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg commented Aug 6, 2022

PR Checklist

Overview

Per #5425 (comment), adds a frontmatter description: ... to each rule equal to its meta.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.

Screenshot of the adjacent-overload-signatures docs page preview in Slack, with a description of the rule instead of a notice

@nx-cloud
Copy link

nx-cloud bot commented Aug 6, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 144b33f. 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 47 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

typescript-eslint bot commented Aug 6, 2022

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.

@netlify
Copy link

netlify bot commented Aug 6, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 144b33f
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/62efdccd37d70400095acc3f
😎 Deploy Preview https://deploy-preview-5429--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.

@JamesHenry
Copy link
Member

JamesHenry commented Aug 7, 2022

Awesome! Thanks for the quick fix, I'll approve as soon as it is no longer in draft

@Josh-Cena
Copy link
Contributor

Josh-Cena commented Aug 7, 2022

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)

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review Aug 7, 2022
@codecov
Copy link

codecov bot commented Aug 7, 2022

Codecov Report

Merging #5429 (4b95096) into main (e03826f) will increase coverage by 2.46%.
The diff coverage is n/a.

Current head 4b95096 differs from pull request most recent head 144b33f. Consider uploading reports for the commit 144b33f to get more accurate results

@@            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     
Flag Coverage Δ
unittest 93.83% <ø> (+2.46%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...slint-plugin/src/rules/no-unnecessary-qualifier.ts 100.00% <0.00%> (ø)
packages/eslint-plugin/src/rules/no-namespace.ts 100.00% <0.00%> (ø)
.../eslint-plugin/src/rules/promise-function-async.ts 98.03% <0.00%> (ø)
...lugin/src/rules/no-confusing-non-null-assertion.ts 82.60% <0.00%> (ø)
...ackages/eslint-plugin/src/rules/no-invalid-this.ts 80.00% <0.00%> (ø)
packages/eslint-plugin/src/rules/comma-dangle.ts 93.33% <0.00%> (ø)
...s/eslint-plugin/src/util/collectUnusedVariables.ts 93.19% <0.00%> (ø)
packages/eslint-plugin/src/rules/await-thenable.ts 100.00% <0.00%> (ø)
...rc/rules/no-unnecessary-boolean-literal-compare.ts 90.36% <0.00%> (ø)
...es/eslint-plugin/src/util/isUndefinedIdentifier.ts 100.00% <0.00%> (ø)
... and 148 more

@JoshuaKGoldberg JoshuaKGoldberg requested a review from JamesHenry Aug 7, 2022
Copy link
Member

@JamesHenry JamesHenry left a comment

🎉

@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) Aug 7, 2022
@JoshuaKGoldberg JoshuaKGoldberg merged commit 63cba5f into typescript-eslint:main Aug 7, 2022
35 checks passed
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 (@&#8203;typescript-eslint/eslint-plugin)</summary>

### [`v5.33.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;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 ([#&#8203;5428](typescript-eslint/typescript-eslint#5428)) ([e03826f](typescript-eslint/typescript-eslint@e03826f))
-   **website:** add explicit frontmatter description to rule docs ([#&#8203;5429](typescript-eslint/typescript-eslint#5429)) ([63cba5f](typescript-eslint/typescript-eslint@63cba5f))

##### Features

-   **eslint-plugin:** \[member-ordering] support static blocks ([#&#8203;5417](typescript-eslint/typescript-eslint#5417)) ([5983e5a](typescript-eslint/typescript-eslint@5983e5a))
-   **eslint-plugin:** \[prefer-as-const] adds support for class properties ([#&#8203;5413](typescript-eslint/typescript-eslint#5413)) ([d2394f8](typescript-eslint/typescript-eslint@d2394f8))

</details>

<details>
<summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>

### [`v5.33.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;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 [@&#8203;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>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 7, 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.

Docs: Rule page links previews show the 🛑 warning
3 participants