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(eslint-plugin): [typedef] remove all defaults #2352

Merged
merged 1 commit into from Aug 3, 2020

Conversation

bradzacher
Copy link
Member

@bradzacher bradzacher commented Aug 3, 2020

BREAKING CHANGE:

Removes all default options from typedef. Users will have to specifically opt-in to all options them selves.

This is intentional friction being introduced to setup the rule to help discourage it as it's not recommended for use.
This also ensures this rule cannot conflict with any other rules (or even do anything) in the all config.

Fixes #2075

@bradzacher bradzacher added breaking change This change will require a new major version to be released default rule options Discussions about default rule options labels Aug 3, 2020
@typescript-eslint
Copy link
Contributor

Thanks for the PR, @bradzacher!

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.

@bradzacher bradzacher linked an issue Aug 3, 2020 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Aug 3, 2020

Codecov Report

Merging #2352 into v4 will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##               v4    #2352      +/-   ##
==========================================
- Coverage   92.97%   92.97%   -0.01%     
==========================================
  Files         285      285              
  Lines        9014     9013       -1     
  Branches     2510     2510              
==========================================
- Hits         8381     8380       -1     
  Misses        304      304              
  Partials      329      329              
Flag Coverage Δ
#unittest 92.97% <ø> (-0.01%) ⬇️

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

Impacted Files Coverage Δ
packages/eslint-plugin/src/rules/typedef.ts 97.26% <ø> (ø)
packages/eslint-plugin/src/rules/ban-ts-comment.ts 95.45% <0.00%> (-0.20%) ⬇️

@bradzacher bradzacher merged commit 13bd4dd into v4 Aug 3, 2020
@bradzacher bradzacher deleted the v4-typedef-defaults branch August 3, 2020 17:18
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 3, 2020
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 default rule options Discussions about default rule options
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[all] conflict
1 participant