feat(eslint-plugin): add no-unsafe-declaration-merging #5840

yeonjuan · 2022-10-17T14:44:54Z

PR Checklist

Addresses an existing open issue: fixes New Rule: ban unsafe declaration merging #5275
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

typescript-eslint · 2022-10-17T14:44:56Z

Thanks for the PR, @yeonjuan!

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.

nx-cloud · 2022-10-17T14:44:57Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9be6acc. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 46 targets

Sent with 💌 from NxCloud.

netlify · 2022-10-17T14:44:59Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`9be6acc`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/634f675dc1e123000828174a
😎 Deploy Preview	https://deploy-preview-5840--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

codecov · 2022-10-17T15:04:10Z

Codecov Report

Merging #5840 (944a5a4) into main (0be356b) will increase coverage by 0.00%.
The diff coverage is 92.85%.

❗ Current head 944a5a4 differs from pull request most recent head 9be6acc. Consider uploading reports for the commit 9be6acc to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5840   +/-   ##
=======================================
  Coverage   91.34%   91.35%           
=======================================
  Files         360      361    +1     
  Lines       12010    12024   +14     
  Branches     3498     3499    +1     
=======================================
+ Hits        10971    10984   +13     
  Misses        743      743           
- Partials      296      297    +1

Flag	Coverage Δ
unittest	`91.35% <92.85%> (+<0.01%)`	⬆️

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

Impacted Files	Coverage Δ
...-plugin/src/rules/no-unsafe-declaration-merging.ts	`92.85% <92.85%> (ø)`

JoshuaKGoldberg

Looks great, thanks for sending this in! Mostly requesting a bit more test coverage.

packages/eslint-plugin/docs/rules/no-unsafe-declaration-merging.md

packages/eslint-plugin/src/rules/no-unsafe-declaration-merging.ts

packages/eslint-plugin/tests/rules/no-unsafe-declaration-merging.test.ts

packages/eslint-plugin/src/rules/no-unsafe-declaration-merging.ts

packages/eslint-plugin/tests/rules/no-unsafe-declaration-merging.test.ts

yeonjuan · 2022-10-18T12:13:34Z

@JoshuaKGoldberg Thanks for the reviews. I fixed it.

And, I changed the reported node with the Identifier node, because reporting the whole class or interface declaration can overlap other errors inside the declaration body.

// from
context.report({
         node: node.parent, // class or interface declaration node
         messageId: 'unsafeMerging',
 });
 // to
 context.report({
          node: node, // identifier node
          messageId: 'unsafeMerging',
});

JoshuaKGoldberg

Fantastic, thanks for sending this in @yeonjuan! 🙌

packages/eslint-plugin/docs/rules/no-unsafe-declaration-merging.md

bradzacher · 2022-10-19T11:41:43Z

packages/eslint-plugin/docs/rules/no-unsafe-declaration-merging.md

+TypeScript's "declaration merging" supports merging separate declarations with the same name.
+
+Declaration merging between classes and interfaces is unsafe.
+The TypeScript compiler doesn't check whether properties are initialized, which can cause lead to TypeScript not detecting code that will cause runtime errors.


oops typo!

Suggested change

The TypeScript compiler doesn't check whether properties are initialized, which can cause lead to TypeScript not detecting code that will cause runtime errors.

The TypeScript compiler doesn't check whether properties are initialized, which can lead to TypeScript not detecting code that will cause runtime errors.

bradzacher · 2022-10-19T11:46:13Z

packages/eslint-plugin/src/rules/no-unsafe-declaration-merging.ts

+    docs: {
+      description: 'Disallow unsafe declaration merging',
+      recommended: 'strict',
+      requiresTypeChecking: true,


We should actually be able to do this without type info and just with the scope analysis APIs.

playground

You can see that if the names clash, then we can iterate through the variable.defs array and do a similar comparison as you've done here - variable.defs.some(def => def.node.type === unsafeType) where
unsafeType == AST_NODE_TYPES.TSInterfaceDeclaration | AST_NODE_TYPES.ClassDeclaration

Ah, I should finally get familiar with the scope manager 😄. #5854

@yeonjuan do you have time to tackle this soon? I can if not, no worries 😄

Hi @bradzacher, @JoshuaKGoldberg I can fix this soon. I'll make a PR for it. (including fixing typo)
Thanks!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.40.1` -> `5.41.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.40.1/5.41.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.40.1` -> `5.41.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.40.1/5.41.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.41.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5410-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5401v5410-2022-10-24) [Compare Source](typescript-eslint/typescript-eslint@v5.40.1...v5.41.0) ##### Bug Fixes - **eslint-plugin:** \[no-base-to-string] ignore Error, URL, and URLSearchParams by default ([#5839](typescript-eslint/typescript-eslint#5839)) ([96e1c6c](typescript-eslint/typescript-eslint@96e1c6c)) - **type-utils:** prevent stack overflow in `isTypeReadonly` ([#5860](typescript-eslint/typescript-eslint#5860)) ([a6d8f7e](typescript-eslint/typescript-eslint@a6d8f7e)), closes [#4476](typescript-eslint/typescript-eslint#4476) ##### Features - **eslint-plugin:** \[no-unsafe-declaration-merging] switch to use scope analysis instead of type information ([#5865](typescript-eslint/typescript-eslint#5865)) ([e70a10a](typescript-eslint/typescript-eslint@e70a10a)) - **eslint-plugin:** add no-unsafe-declaration-merging ([#5840](typescript-eslint/typescript-eslint#5840)) ([3728031](typescript-eslint/typescript-eslint@3728031)) #### [5.40.1](typescript-eslint/typescript-eslint@v5.40.0...v5.40.1) (2022-10-17) ##### Bug Fixes - **eslint-plugin:** Skip missing 'rest' tuple type arguments in no-misused-promises ([#5809](typescript-eslint/typescript-eslint#5809)) ([c5beaa2](typescript-eslint/typescript-eslint@c5beaa2)), closes [#5807](typescript-eslint/typescript-eslint#5807) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.41.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5410-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5401v5410-2022-10-24) [Compare Source](typescript-eslint/typescript-eslint@v5.40.1...v5.41.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.40.1](typescript-eslint/typescript-eslint@v5.40.0...v5.40.1) (2022-10-17) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) </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 these updates 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/1604 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>

feat(eslint-plugin): add no-unsafe-declaration-merging

1417919

JoshuaKGoldberg requested changes Oct 17, 2022

View reviewed changes

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Oct 17, 2022

Apply reviews

28560e0

yeonjuan requested a review from JoshuaKGoldberg October 18, 2022 12:22

fix

944a5a4

JoshuaKGoldberg previously approved these changes Oct 19, 2022

View reviewed changes

packages/eslint-plugin/docs/rules/no-unsafe-declaration-merging.md Outdated Show resolved Hide resolved

packages/eslint-plugin/docs/rules/no-unsafe-declaration-merging.md Outdated Show resolved Hide resolved

JoshuaKGoldberg dismissed their stale review via 231ff6f October 19, 2022 02:55

JoshuaKGoldberg added 2 commits October 18, 2022 22:55

Apply suggestions from code review

231ff6f

Merge branch 'main' into fix/typescript-eslint#5275

9be6acc

JoshuaKGoldberg approved these changes Oct 19, 2022

View reviewed changes

JoshuaKGoldberg enabled auto-merge (squash) October 19, 2022 02:56

JoshuaKGoldberg merged commit 3728031 into typescript-eslint:main Oct 19, 2022

bradzacher reviewed Oct 19, 2022

View reviewed changes

JoshuaKGoldberg mentioned this pull request Oct 20, 2022

Enhancement: [no-unsafe-declaration-merging] Switch to scope manager #5854

Closed

4 tasks

sync-by-unito bot mentioned this pull request Oct 25, 2022

build(deps-dev): bump @typescript-eslint/eslint-plugin from 5.36.1 to 5.41.0 numbersprotocol/capture-lite#2211

Closed

sync-by-unito bot mentioned this pull request Nov 1, 2022

build(deps-dev): bump @typescript-eslint/eslint-plugin from 5.36.1 to 5.42.0 numbersprotocol/capture-lite#2265

Closed

github-actions bot locked as resolved and limited conversation to collaborators Nov 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): add no-unsafe-declaration-merging #5840

feat(eslint-plugin): add no-unsafe-declaration-merging #5840

yeonjuan commented Oct 17, 2022

typescript-eslint bot commented Oct 17, 2022

nx-cloud bot commented Oct 17, 2022 •

edited

netlify bot commented Oct 17, 2022 •

edited

codecov bot commented Oct 17, 2022 •

edited

JoshuaKGoldberg left a comment

yeonjuan commented Oct 18, 2022 •

edited

JoshuaKGoldberg left a comment

bradzacher Oct 19, 2022

bradzacher Oct 19, 2022

JoshuaKGoldberg Oct 20, 2022

JoshuaKGoldberg Oct 20, 2022

yeonjuan Oct 22, 2022

	The TypeScript compiler doesn't check whether properties are initialized, which can cause lead to TypeScript not detecting code that will cause runtime errors.
	The TypeScript compiler doesn't check whether properties are initialized, which can lead to TypeScript not detecting code that will cause runtime errors.

feat(eslint-plugin): add no-unsafe-declaration-merging #5840

feat(eslint-plugin): add no-unsafe-declaration-merging #5840

Conversation

yeonjuan commented Oct 17, 2022

PR Checklist

Overview

typescript-eslint bot commented Oct 17, 2022

nx-cloud bot commented Oct 17, 2022 • edited

☁️ Nx Cloud Report

netlify bot commented Oct 17, 2022 • edited

✅ Deploy Preview for typescript-eslint ready!

codecov bot commented Oct 17, 2022 • edited

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

yeonjuan commented Oct 18, 2022 • edited

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

bradzacher Oct 19, 2022

Choose a reason for hiding this comment

bradzacher Oct 19, 2022

Choose a reason for hiding this comment

JoshuaKGoldberg Oct 20, 2022

Choose a reason for hiding this comment

JoshuaKGoldberg Oct 20, 2022

Choose a reason for hiding this comment

yeonjuan Oct 22, 2022

Choose a reason for hiding this comment

nx-cloud bot commented Oct 17, 2022 •

edited

netlify bot commented Oct 17, 2022 •

edited

codecov bot commented Oct 17, 2022 •

edited

yeonjuan commented Oct 18, 2022 •

edited