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-restricted-imports] allow type import as long as there's one matching pattern #4898

Merged

Conversation

Josh-Cena
Copy link
Member

@Josh-Cena Josh-Cena commented May 3, 2022

PR Checklist

Overview

The problem with our current logic is that we require every allowed import pattern to match a given path, but in practice, they can well be disjoint! With this change, we will be more permissive and allow type import as long as one matcher matches.

This may lead to some false-negatives? For example, there are two matchers that both match a file, one with allowTypeImports, another without. Previously, we report an error; now we don't. To be fair, both seem like valid behaviors to me. We don't have existing test-cases covering that anyways, and it doesn't seem like we have this behavior specced in the docs, so I assume either is fine.

@nx-cloud
Copy link

nx-cloud bot commented May 3, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 6e60c92. 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

Thanks for the PR, @Josh-Cena!

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 May 3, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 6e60c92
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/62717c2fbf350b0009a2f3ff
😎 Deploy Preview https://deploy-preview-4898--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 May 3, 2022

Codecov Report

Merging #4898 (6e60c92) into main (47f4605) will increase coverage by 2.49%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #4898      +/-   ##
==========================================
+ Coverage   91.76%   94.25%   +2.49%     
==========================================
  Files         226      153      -73     
  Lines       10586     8300    -2286     
  Branches     3280     2700     -580     
==========================================
- Hits         9714     7823    -1891     
+ Misses        591      263     -328     
+ Partials      281      214      -67     
Flag Coverage Δ
unittest 94.25% <100.00%> (+2.49%) ⬆️

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

Impacted Files Coverage Δ
...s/eslint-plugin/src/rules/no-restricted-imports.ts 96.42% <100.00%> (-0.07%) ⬇️
packages/utils/src/ast-utils/helpers.ts
packages/utils/src/eslint-utils/deepMerge.ts
packages/utils/src/ts-eslint/SourceCode.ts
packages/typescript-estree/src/version-check.ts
packages/type-utils/src/propertyTypes.ts
packages/typescript-estree/src/convert.ts
packages/utils/src/ts-eslint-scope/Definition.ts
packages/typescript-estree/src/convert-comments.ts
packages/utils/src/eslint-utils/index.ts
... and 64 more

@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) May 3, 2022 19:04
@bradzacher bradzacher added the bug Something isn't working label May 3, 2022
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.

thanks for fixing this!

@JoshuaKGoldberg JoshuaKGoldberg merged commit 0419d28 into typescript-eslint:main May 3, 2022
@Josh-Cena Josh-Cena deleted the fix-restricted-import branch May 4, 2022 00:49
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request May 13, 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.22.0` -> `5.23.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.22.0/5.23.0) |
| [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.22.0` -> `5.23.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.22.0/5.23.0) |

---

### Release Notes

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

### [`v5.23.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5230-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5220v5230-2022-05-09)

[Compare Source](typescript-eslint/typescript-eslint@v5.22.0...v5.23.0)

##### Bug Fixes

-   **eslint-plugin:** \[no-restricted-imports] allow type import as long as there's one matching pattern ([#&#8203;4898](typescript-eslint/typescript-eslint#4898)) ([0419d28](typescript-eslint/typescript-eslint@0419d28))
-   **eslint-plugin:** \[no-unnecessary-type-constraint] change to suggestion fix, fix multiple trailing comma failures ([#&#8203;4901](typescript-eslint/typescript-eslint#4901)) ([4507ac8](typescript-eslint/typescript-eslint@4507ac8))

</details>

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

### [`v5.23.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5230-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5220v5230-2022-05-09)

[Compare Source](typescript-eslint/typescript-eslint@v5.22.0...v5.23.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.

---

 - [x] <!-- 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/1345
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 Jun 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[no-restricted-imports] 2 pattern rules with different globs and allowTypeImports break validation
3 participants