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

feat: remove meta.docs.category from rules #3800

Merged

Conversation

MichaelDeBoey
Copy link
Contributor

@MichaelDeBoey MichaelDeBoey commented Aug 28, 2021

@bradzacher Not sure if wanted to remove it from all rules or only from the extended core rules, so went with the latter (for now).
Types will be less complex if we remove it on all rules though.


Part of #3738

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @MichaelDeBoey!

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.

@MichaelDeBoey MichaelDeBoey force-pushed the remove-category-in-core-rules branch from 7d447ab to 00e8efa Compare August 28, 2021 01:14
@bradzacher bradzacher added this to the 5.0.0 milestone Aug 28, 2021
@bradzacher bradzacher added the breaking change This change will require a new major version to be released label Aug 28, 2021
@bradzacher
Copy link
Member

let's just remove it from everywhere.
they've removed it from core so let's remove it from the types too.
no point fragmenting the ecosystem.

@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Aug 28, 2021
@MichaelDeBoey MichaelDeBoey changed the title feat: remove meta.docs.category in core rules feat: remove meta.docs.category from rules Aug 28, 2021
@MichaelDeBoey MichaelDeBoey force-pushed the remove-category-in-core-rules branch 2 times, most recently from 1dabec2 to 3d22078 Compare August 28, 2021 19:10
@MichaelDeBoey
Copy link
Contributor Author

@bradzacher Removed the category from all rules now

@codecov
Copy link

codecov bot commented Aug 28, 2021

Codecov Report

Merging #3800 (44b97b4) into v5 (ea6a97c) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##               v5    #3800      +/-   ##
==========================================
- Coverage   92.55%   92.55%   -0.01%     
==========================================
  Files         325      323       -2     
  Lines       11247    11240       -7     
  Branches     3174     3174              
==========================================
- Hits        10410    10403       -7     
  Misses        384      384              
  Partials      453      453              
Flag Coverage Δ
unittest 92.55% <ø> (-0.01%) ⬇️

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

Impacted Files Coverage Δ
...gin-internal/src/rules/no-poorly-typed-ts-props.ts 88.88% <ø> (ø)
...internal/src/rules/no-typescript-default-import.ts 100.00% <ø> (ø)
...-internal/src/rules/no-typescript-estree-import.ts 87.50% <ø> (ø)
...lugin-internal/src/rules/plugin-test-formatting.ts 81.75% <ø> (ø)
...plugin-internal/src/rules/prefer-ast-types-enum.ts 90.00% <ø> (ø)
...t-plugin/src/rules/adjacent-overload-signatures.ts 93.33% <ø> (ø)
packages/eslint-plugin/src/rules/array-type.ts 98.61% <ø> (ø)
packages/eslint-plugin/src/rules/await-thenable.ts 100.00% <ø> (ø)
packages/eslint-plugin/src/rules/ban-ts-comment.ts 95.65% <ø> (ø)
...ages/eslint-plugin/src/rules/ban-tslint-comment.ts 100.00% <ø> (ø)
... and 114 more

@MichaelDeBoey MichaelDeBoey force-pushed the remove-category-in-core-rules branch from 3d22078 to 44b97b4 Compare August 28, 2021 21:42
Copy link
Member

@bradzacher bradzacher 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!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
breaking change This change will require a new major version to be released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants