docs: Add rules meta info to rule pages #15902

nzakas · 2022-05-20T21:15:05Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

This PR makes several changes to the rules doc pages:

It inserts the description from the JavaScript rule source file under the header.
It shows panels for recommended, fixable, and suggestions at the top of the pages.
It updates Makefile.js to include functionality to generate a rules meta data JSON file for use in the docs site. This will be done automatically during site generation of the current eslint.org so it will be updated with each release.

Is there anything you'd like reviewers to focus on?

Don't worry too much about the styling right now...I still need to fix that.

In the new site, the description tends to be duplicated because each rule's first line of content is the rule description. We can fix that once we move over to the new site.

Otherwise, does everything appear in the correct spot?

netlify · 2022-05-20T21:15:10Z

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	`677f283`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/62a76f92cd5bb70009d0e24e

docs/src/_includes/layouts/doc.html

Makefile.js

nzakas · 2022-06-08T18:24:18Z

Updated the git tag after modifying the commit and rebased on top of main.

Note: I noticed a UI bug related to the displaying of fixable/suggestions/recommended on rules. I've opened #15977 to track separately.

nzakas · 2022-06-08T18:24:47Z

@btmills can you take a look at this to clear your review?

btmills

I commented on #15977 as well, but I'm seeing all three categories displaying correctly now!

mdjermanovic · 2022-06-09T17:38:45Z

Makefile.js

+
+    echo("Updating commit with docs data");
+    exec("git add docs/src/_data && git commit --amend --no-edit");
+    exec(`git tag -f v${releaseInfo.version}`);


This works well, but there will be one difference compared to previous releases: npm version creates an annotated tag, while this creates a lightweight one. I'm not sure if that's important, though.

I’ll have to check if the annotation remains after this or if it’s lost.

It looks like everything is lost, so I updated to create a new annotated tag with the version as a message (to duplicate what npm version does).

docs/src/_includes/components/rule-categories.macro.html

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

mdjermanovic

LGTM, thanks!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.17.0` -> `8.18.0`](https://renovatebot.com/diffs/npm/eslint/8.17.0/8.18.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.18.0`](https://github.com/eslint/eslint/releases/tag/v8.18.0) [Compare Source](eslint/eslint@v8.17.0...v8.18.0) #### Features - [`a6273b8`](eslint/eslint@a6273b8) feat: account for rule creation time in performance reports ([#15982](eslint/eslint#15982)) (Nitin Kumar) #### Bug Fixes - [`f364d47`](eslint/eslint@f364d47) fix: Make no-unused-vars treat for..of loops same as for..in loops ([#15868](eslint/eslint#15868)) (Alex Bass) #### Documentation - [`4871047`](eslint/eslint@4871047) docs: Update analytics, canonical URL, ads ([#15996](eslint/eslint#15996)) (Nicholas C. Zakas) - [`cddad14`](eslint/eslint@cddad14) docs: Add correct/incorrect containers ([#15998](eslint/eslint#15998)) (Nicholas C. Zakas) - [`b04bc6f`](eslint/eslint@b04bc6f) docs: Add rules meta info to rule pages ([#15902](eslint/eslint#15902)) (Nicholas C. Zakas) - [`1324f10`](eslint/eslint@1324f10) docs: unify the wording referring to optional exception ([#15893](eslint/eslint#15893)) (Abdelrahman Elkady) - [`ad54d02`](eslint/eslint@ad54d02) docs: add missing trailing slash to some internal links ([#15991](eslint/eslint#15991)) (Milos Djermanovic) - [`df7768e`](eslint/eslint@df7768e) docs: Switch to version-relative URLs ([#15978](eslint/eslint#15978)) (Nicholas C. Zakas) - [`21d6479`](eslint/eslint@21d6479) docs: change some absolute links to relative ([#15970](eslint/eslint#15970)) (Milos Djermanovic) - [`f31216a`](eslint/eslint@f31216a) docs: Update README team and sponsors (ESLint Jenkins) #### Build Related - [`ed49f15`](eslint/eslint@ed49f15) build: remove unwanted parallel and image-min for dev server ([#15986](eslint/eslint#15986)) (Strek) #### Chores - [`f6e2e63`](eslint/eslint@f6e2e63) chore: fix 'replaced by' rule list ([#16007](eslint/eslint#16007)) (Milos Djermanovic) - [`d94dc84`](eslint/eslint@d94dc84) chore: remove unused deprecation warnings ([#15994](eslint/eslint#15994)) (Francesco Trotta) - [`cdcf11e`](eslint/eslint@cdcf11e) chore: fix versions link ([#15995](eslint/eslint#15995)) (Milos Djermanovic) - [`d2a8715`](eslint/eslint@d2a8715) chore: add trailing slash to `pathPrefix` ([#15993](eslint/eslint#15993)) (Milos Djermanovic) - [`58a1bf0`](eslint/eslint@58a1bf0) chore: tweak URL rewriting for local previews ([#15992](eslint/eslint#15992)) (Milos Djermanovic) - [`80404d2`](eslint/eslint@80404d2) chore: remove docs deploy workflow ([#15984](eslint/eslint#15984)) (Nicholas C. Zakas) - [`71bc750`](eslint/eslint@71bc750) chore: Set permissions for GitHub actions ([#15971](eslint/eslint#15971)) (Naveen) - [`90ff647`](eslint/eslint@90ff647) chore: avoid generating subdirectories for each page on new docs site ([#15967](eslint/eslint#15967)) (Milos Djermanovic) </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 this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1427 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

eslint-github-bot bot added triage documentation labels May 20, 2022

btmills suggested changes May 21, 2022

View reviewed changes

docs/src/_includes/layouts/doc.html Outdated Show resolved Hide resolved

mdjermanovic added accepted and removed triage labels May 23, 2022

mdjermanovic reviewed May 23, 2022

View reviewed changes

Makefile.js Show resolved Hide resolved

nzakas added 6 commits June 8, 2022 11:04

docs: Add rules meta info to rule pages

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

b99871b

Address feedback

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

75981ad

Update release to include rules metadata

a990280

Fix message

19166b0

Update git tag

a4782f0

Fix conflicts

0b7155c

nzakas force-pushed the rule-hints branch from dbf3875 to 0b7155c Compare June 8, 2022 18:15

nzakas mentioned this pull request Jun 8, 2022

[new docs site] UI bug with on rules index and details pages #15977

Closed

btmills approved these changes Jun 9, 2022

View reviewed changes

mdjermanovic reviewed Jun 9, 2022

View reviewed changes

nzakas and others added 2 commits June 9, 2022 17:49

Update docs/src/_includes/components/rule-categories.macro.html

a206294

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

Create annotated tag

677f283

mdjermanovic approved these changes Jun 14, 2022

View reviewed changes

mdjermanovic merged commit b04bc6f into main Jun 14, 2022

mdjermanovic deleted the rule-hints branch June 14, 2022 15:50

This was referenced Jul 1, 2022

build(deps-dev): bump eslint from 7.32.0 to 8.18.0 numbersprotocol/capture-lite#1769

Closed

build(deps-dev): bump eslint from 7.32.0 to 8.19.0 numbersprotocol/capture-lite#1787

Closed

eslint-github-bot bot locked and limited conversation to collaborators Dec 12, 2022

eslint-github-bot bot added the archived due to age label Dec 12, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Add rules meta info to rule pages #15902

docs: Add rules meta info to rule pages #15902

nzakas commented May 20, 2022

netlify bot commented May 20, 2022 •

edited

Loading

nzakas commented Jun 8, 2022

nzakas commented Jun 8, 2022

btmills left a comment

mdjermanovic Jun 9, 2022

nzakas Jun 10, 2022

nzakas Jun 13, 2022

mdjermanovic left a comment

docs: Add rules meta info to rule pages #15902

docs: Add rules meta info to rule pages #15902

Conversation

nzakas commented May 20, 2022

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

netlify bot commented May 20, 2022 • edited Loading

✅ Deploy Preview for docs-eslint canceled.

nzakas commented Jun 8, 2022

nzakas commented Jun 8, 2022

btmills left a comment

Choose a reason for hiding this comment

mdjermanovic Jun 9, 2022

Choose a reason for hiding this comment

nzakas Jun 10, 2022

Choose a reason for hiding this comment

nzakas Jun 13, 2022

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

netlify bot commented May 20, 2022 •

edited

Loading