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

fix(eslint-plugin): [no-namespace] fix false positive for exported namespaces when allowDeclarations=true #4844

Merged
merged 4 commits into from Apr 22, 2022

Conversation

zachkirsch
Copy link
Contributor

@zachkirsch zachkirsch commented Apr 20, 2022

PR Checklist

Overview

Before this PR, this doesn't produce any warnings if allowDeclarations is true:

declare namespace foo {
    namespace bar {
        namespace baz {}
    }
}

This DOES produce a warning if allowDeclarations is true

declare namespace foo {
    export namespace bar {
        namespace baz {}
    }
}

After this PR, the second example also doesn't produce a warning.

@nx-cloud
Copy link

nx-cloud bot commented Apr 20, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9b8961e. 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 43 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

typescript-eslint bot commented Apr 20, 2022

Thanks for the PR, @zachkirsch!

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.

@netlify
Copy link

netlify bot commented Apr 20, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 9b8961e
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6262e3c1db9f0c0009897acc
😎 Deploy Preview https://deploy-preview-4844--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

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
Copy link

codecov bot commented Apr 20, 2022

Codecov Report

Merging #4844 (58c1391) into main (88ed9ec) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Current head 58c1391 differs from pull request most recent head 9b8961e. Consider uploading reports for the commit 9b8961e to get more accurate results

@@           Coverage Diff           @@
##             main    #4844   +/-   ##
=======================================
  Coverage   94.23%   94.24%           
=======================================
  Files         152      152           
  Lines        8281     8282    +1     
  Branches     2694     2695    +1     
=======================================
+ Hits         7804     7805    +1     
  Misses        263      263           
  Partials      214      214           
Flag Coverage Δ
unittest 94.24% <100.00%> (+<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/no-namespace.ts 100.00% <100.00%> (ø)

armano2
armano2 previously approved these changes Apr 20, 2022
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg left a comment

I think what @armano2 meant was that more deeply nested namespaces need a bit more checking. Once you add a few more edge case tests I think you'll see.

Otherwise looks great so far!

export declare namespace foo {
export namespace bar {
namespace baz {}
}
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg Apr 21, 2022

Choose a reason for hiding this comment

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

I think there are few more edge cases that should be tested around declared namespaces inside a non-declared one, both exported and not:

namespace Outer {
  declare namespace Declared {
    /* export */ namespace InsideDeclared {
       // and maybe more namespaces in here
    }
  }
}

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Apr 21, 2022
@bradzacher bradzacher changed the title [no-namespace] Fix false positive for exported namespaces when allowDeclarations=true fix(eslint-plugin): [no-namespace] fix false positive for exported namespaces when allowDeclarations=true Apr 21, 2022
@bradzacher bradzacher added the bug Something isn't working label Apr 22, 2022
@zachkirsch
Copy link
Contributor Author

zachkirsch commented Apr 22, 2022

@JoshuaKGoldberg thanks for the reply! I added a bunch more tests to check all the cases.

more deeply nested namespaces need a bit more checking.

I think these are handled by the recursive call at the end of isDeclaration()

Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Wonderful, thanks! 👍

@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) Apr 22, 2022
@JoshuaKGoldberg JoshuaKGoldberg merged commit 4e7c9be into typescript-eslint:main Apr 22, 2022
14 checks passed
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request May 1, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.20.0` -> `5.21.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.20.0/5.21.0) |
| [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.20.0` -> `5.21.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.20.0/5.21.0) |

---

### Release Notes

<details>
<summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/eslint-plugin)</summary>

### [`v5.21.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5210-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5200v5210-2022-04-25)

[Compare Source](typescript-eslint/typescript-eslint@v5.20.0...v5.21.0)

##### Bug Fixes

-   **eslint-plugin:** \[no-misused-promises] prioritize false returns when checking whether a function returns only void ([#&#8203;4841](typescript-eslint/typescript-eslint#4841)) ([ccadb60](typescript-eslint/typescript-eslint@ccadb60))
-   **eslint-plugin:** \[no-namespace] fix false positive for exported namespaces when allowDeclarations=true ([#&#8203;4844](typescript-eslint/typescript-eslint#4844)) ([4e7c9be](typescript-eslint/typescript-eslint@4e7c9be))
-   **eslint-plugin:** \[space-infix-ops] fix no error when right type is function ([#&#8203;4848](typescript-eslint/typescript-eslint#4848)) ([d74d559](typescript-eslint/typescript-eslint@d74d559))

##### Features

-   **eslint-plugin:** \[parameter-properties] add rule to replace `no-parameter-properties` ([#&#8203;4622](typescript-eslint/typescript-eslint#4622)) ([88ed9ec](typescript-eslint/typescript-eslint@88ed9ec))

</details>

<details>
<summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>

### [`v5.21.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5210-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5200v5210-2022-04-25)

[Compare Source](typescript-eslint/typescript-eslint@v5.20.0...v5.21.0)

**Note:** Version bump only for package [@&#8203;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/1319
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>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
awaiting response Issues waiting for a reply from the OP or another party bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[no-namespace] Adding 'export' yields false positive when allowDeclarations=true
4 participants