Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

Update: remove meta.docs.category in core rules #848

Merged
merged 3 commits into from Oct 9, 2021
Merged

Conversation

aladdin-add
Copy link
Member

@aladdin-add aladdin-add commented May 17, 2021

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label May 17, 2021
@aladdin-add aladdin-add changed the title Chore: remove category in core rules Chore: remove meta.docs.category in core rules May 17, 2021
@netlify
Copy link

netlify bot commented May 17, 2021

✔️ Deploy Preview for eslint ready!

🔨 Explore the source changes: b6207d5

🔍 Inspect the deploy log: https://app.netlify.com/sites/eslint/deploys/6123d041c70f2000079a6ce3

😎 Browse the preview: https://deploy-preview-848--eslint.netlify.app/docs/rules

@nzakas
Copy link
Member

nzakas commented May 18, 2021

Can you rebase this?

@aladdin-add aladdin-add force-pushed the eslint-issue-13398 branch 2 times, most recently from 0cf59f1 to 9d0d609 Compare May 18, 2021 03:06
@nzakas
Copy link
Member

nzakas commented May 22, 2021

I think we need to have headings that look a bit nicer:
https://deploy-preview-848--eslint.netlify.app/docs/rules/

problem -> Possible Problems
suggestion -> Suggestions
layout -> Layout & Formatting

_data/rules.yml Outdated Show resolved Hide resolved
_data/rules.yml Outdated Show resolved Hide resolved
_data/rules.yml Outdated Show resolved Hide resolved
@aladdin-add
Copy link
Member Author

it was auto-gened. I just added a new field "displayName"(the name was borrowed from react:)). eslint/eslint@ef4c31b

nzakas
nzakas previously approved these changes May 25, 2021
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

I like it. 👍

@mdjermanovic mdjermanovic added accepted There is consensus among the team that this change meets the criteria for inclusion blocked This change can't be completed until another issue is resolved do not merge This pull request should not be merged yet and removed triage An ESLint team member will look at this issue soon labels May 25, 2021
@mdjermanovic
Copy link
Member

image

Should we maybe keep the "These rules..." wording with : at the end in the description? Given the display position, it might look better.

E.g., These rules warn about potential errors:

@aladdin-add
Copy link
Member Author

👍 good call! will update the PR in eslint repo.

@nzakas nzakas marked this pull request as draft June 30, 2021 00:50
@nzakas nzakas removed the do not merge This pull request should not be merged yet label Jun 30, 2021
@nzakas
Copy link
Member

nzakas commented Jun 30, 2021

Just a reminder to use a PR draft if you don’t want a PR to be merged.

@mdjermanovic
Copy link
Member

@aladdin-add eslint/eslint#14594 has multiple approvals and eslint/eslint#13398 has been moved to the Ready for Merge state in the v8.0.0 project.

You can now undo the rules.yml change in this PR, so that this PR can become ready for merge (blocked on ESLint v8.0.0 final).

@aladdin-add aladdin-add marked this pull request as ready for review July 5, 2021 04:17
@aladdin-add aladdin-add removed the blocked This change can't be completed until another issue is resolved label Jul 5, 2021
@mdjermanovic mdjermanovic changed the title Chore: remove meta.docs.category in core rules Update: remove meta.docs.category in core rules Jul 5, 2021
mdjermanovic
mdjermanovic previously approved these changes Jul 5, 2021
Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@mdjermanovic mdjermanovic added the blocked This change can't be completed until another issue is resolved label Jul 5, 2021
@mdjermanovic
Copy link
Member

Note to the merger:

This PR is ready for merge as-is, but merging is blocked on the ESLint v8.0.0 final release.

ESLint v7 releases produce rules.yml data file in a different, incompatible format. Prereleases do not update rules.yml.

Therefore:

  • Do not merge this after ESLint v7.x releases.
  • Do not merge this after ESLint v8.0.0 prereleases.
  • Merge this right after the ESLint v8.0.0 final release.

@mdjermanovic
Copy link
Member

@aladdin-add can you resolve merge conflicts?

@bmish
Copy link
Sponsor Member

bmish commented Aug 23, 2021

I addressed the conflict (my change originally caused it).

Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

(#848 (comment) still applies, do not merge this before v8.0.0 final release).

@btmills
Copy link
Member

btmills commented Oct 9, 2021

Merging this now that v8.0.0 final was just published.

@btmills btmills merged commit 09a6ea1 into master Oct 9, 2021
@aladdin-add aladdin-add deleted the eslint-issue-13398 branch October 10, 2021 00:16
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion blocked This change can't be completed until another issue is resolved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants