Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
feat(eslint-plugin): Add BigInt object type to default ban-types list#4970
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
nx-cloudbot commentedMay 13, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Thanks for the PR,@tduyduc! 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 onhttps://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitorsper day. |
netlifybot commentedMay 13, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview fortypescript-eslint ready!
To edit notification comments on pull requests, go to yourNetlify site settings. |
codecovbot commentedMay 13, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Codecov Report
@@ Coverage Diff @@## main #4970 +/- ##==========================================+ Coverage 92.64% 94.25% +1.61%========================================== Files 190 153 -37 Lines 10251 8305 -1946 Branches 3249 2702 -547 ==========================================- Hits 9497 7828 -1669+ Misses 502 263 -239+ Partials 252 214 -38
Flags with carried forward coverage won't be shown.Click here to find out more. |
It is impossible to construct a wrapper object of type |
bradzacher commentedMay 14, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
99.99999% of the time you don't want the capital version of the type, nor should you be constructing a wrapper object. Which is why the rule points people at using the lowercase type for the primitives. |
Ugh, I see we ban |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Yup this makes sense, thanks!
Boxed objects of
It is also worth noting that the boxed primitive types can screw up TypeScript type guards. This can be a problem should we face bigger unions of types. declarevarx:BigInt|bigint|undefined;if(xinstanceofObject){x;// is BigInt (object)}elseif(typeofx==='bigint'){x;// is bigint (primitive)} |
Oh I wasn't aware of the narrowing issue. It makes much more sense then 👍 |
This PR contains the following updates:| Package | Type | Update | Change ||---|---|---|---|| [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.23.0` -> `5.25.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.23.0/5.25.0) || [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.23.0` -> `5.25.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.23.0/5.25.0) |---### Release Notes<details><summary>typescript-eslint/typescript-eslint (@​typescript-eslint/eslint-plugin)</summary>### [`v5.25.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#​5250-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5240v5250-2022-05-17)[Compare Source](typescript-eslint/typescript-eslint@v5.24.0...v5.25.0)##### Bug Fixes- **eslint-plugin:** \[typedef] stop enforcing rule for assignment expressions ([#​4958](typescript-eslint/typescript-eslint#4958)) ([04a216c](typescript-eslint/typescript-eslint@04a216c))- **eslint-plugin:** strict config should not extend recommended ([#​5005](typescript-eslint/typescript-eslint#5005)) ([05d71c2](typescript-eslint/typescript-eslint@05d71c2))- **website:** correct Presets link to be Configs ([#​5004](typescript-eslint/typescript-eslint#5004)) ([e18e91c](typescript-eslint/typescript-eslint@e18e91c))##### Features- **eslint-plugin:** \[no-empty-function] new allow option overrideMethods ([#​4923](typescript-eslint/typescript-eslint#4923)) ([13c05ae](typescript-eslint/typescript-eslint@13c05ae))- **eslint-plugin:** deprecate `no-duplicate-imports` in favour of `import/no-duplicates` ([#​4973](typescript-eslint/typescript-eslint#4973)) ([1d2e41a](typescript-eslint/typescript-eslint@1d2e41a))- update to TypeScript 4.7-rc ([#​4829](typescript-eslint/typescript-eslint#4829)) ([6fe783c](typescript-eslint/typescript-eslint@6fe783c))### [`v5.24.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#​5240-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5230v5240-2022-05-16)[Compare Source](typescript-eslint/typescript-eslint@v5.23.0...v5.24.0)##### Bug Fixes- **eslint-plugin:** \[array-type] in fixer add missing parens for constructor types [#​4756](typescript-eslint/typescript-eslint#4756) ([#​4971](typescript-eslint/typescript-eslint#4971)) ([0377070](typescript-eslint/typescript-eslint@0377070))##### Features- **eslint-plugin:** Add BigInt object type to default ban-types list ([#​4970](typescript-eslint/typescript-eslint#4970)) ([1867728](typescript-eslint/typescript-eslint@1867728))- **eslint-plugin:** add new 'strict' config ([#​4706](typescript-eslint/typescript-eslint#4706)) ([4a500b2](typescript-eslint/typescript-eslint@4a500b2))</details><details><summary>typescript-eslint/typescript-eslint (@​typescript-eslint/parser)</summary>### [`v5.25.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#​5250-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5240v5250-2022-05-17)[Compare Source](typescript-eslint/typescript-eslint@v5.24.0...v5.25.0)**Note:** Version bump only for package [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser)### [`v5.24.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#​5240-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5230v5240-2022-05-16)[Compare Source](typescript-eslint/typescript-eslint@v5.23.0...v5.24.0)**Note:** Version bump only for package [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser)</details>---### Configuration📅 **Schedule**: 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).Co-authored-by: cabr2-bot <cabr2.help@gmail.com>Reviewed-on:https://codeberg.org/Calciumdibromid/CaBr2/pulls/1357Reviewed-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>
PR Checklist
Addresses an existing open issue: fixes #000No issues have been created about this featureThat issue was marked asaccepting prsNo issues have been created about this featureOverview
The pull request title says it all: to add
BigInttype to the default list of banned types, given thatbigintis a primitive type (just likeboolean,string,number, andsymbol).The
ban-typesrule source code and the rule documentation have been changed.