fix(eslint-plugin): [no-import-type-side-effects] correctly ignore zero-specifier imports #6444

bradzacher · 2023-02-09T10:50:14Z

PR Checklist

Addresses an existing open issue: fixes Bug: [no-import-type-side-effects] doesn't allow side effects only imports #6431
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

…ro-specifier imports

typescript-eslint · 2023-02-09T10:50:17Z

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.

nx-cloud · 2023-02-09T10:50:17Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit f0dc4a6. 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 47 targets

Sent with 💌 from NxCloud.

netlify · 2023-02-09T10:50:20Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`f0dc4a6`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/63e4cfe83b29fa000828508f
😎 Deploy Preview	https://deploy-preview-6444--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 · 2023-02-09T11:06:49Z

Codecov Report

Merging #6444 (f0dc4a6) into main (a9cb860) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6444   +/-   ##
=======================================
  Coverage   91.53%   91.53%           
=======================================
  Files         371      371           
  Lines       12662    12664    +2     
  Branches     3721     3722    +1     
=======================================
+ Hits        11590    11592    +2     
  Misses        754      754           
  Partials      318      318

Flag	Coverage Δ
unittest	`91.53% <100.00%> (+<0.01%)`	⬆️

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

Impacted Files	Coverage Δ
...nt-plugin/src/rules/no-import-type-side-effects.ts	`100.00% <100.00%> (ø)`

JoshuaKGoldberg

LGTM! 🚀

JoshuaKGoldberg · 2023-02-09T21:19:53Z

packages/eslint-plugin/src/rules/no-import-type-side-effects.ts

      'ImportDeclaration[importKind!="type"]'(
        node: TSESTree.ImportDeclaration,
      ): void {
+        if (node.specifiers.length === 0) {
+          return;
+        }


Per our recent conversation somewhere, if you wanted to, ESQuery can reduce this code count a bit 😄

Suggested change

'ImportDeclaration[importKind!="type"]'(

node: TSESTree.ImportDeclaration,

): void {

if (node.specifiers.length === 0) {

return;

}

'ImportDeclaration[importKind!="type"][specifiers.0]'(

node: TSESTree.ImportDeclaration,

): void {

back in the day I was all in on esquery selectors. I thought it was great to dump everything into a selector and keep the code logic about processing the node.

now a days though I tend to feel that leaning too heavily into the custom DSL makes code less accessible and harder to understand / debug.
[specifiers.0] is one of those parts of the DSL that's super unclear as to what it's doing, IMO.

I think leveraging super clear parts of the DSL (prop existence, parents) are great and easy to understand, but for anything more complex it's better to write the clearer logic.

also as an interesting aside just because...
I figured out that selectors actually hide performance cost of rules! ESLint only tracks (1) time spent in create and (2) time spent in selector functions for a rule.

so time spent compiling and evaluation selector strings is perf cost in ESLint land - not for the rule.

Which is funny for rules like those in eslint-plugin-unicorn which heavily (ab)use selectors over logic, because they'll look like they're faster than other rules!

Ooh I wonder if we should have a lint rule for selectors. And maybe put it in eslint-plugin-eslint-plugin...

Separately I've also envisioned a lint rule that enforces the type annotation on the function arg matches the selector to improve safety.

EG

// bad 'ImportDeclaration[importKind != "type"]'(node: TSESTree.Literal) 'BlockStatement > *'(node: TSESTree.Literal) // good 'ImportDeclaration[importKind != "type"]'(node: TSESTree.ImportDeclaration) 'ImportDeclaration[importKind != "type"]'(node: TSESTree.ImportDeclaration & {importKind: 'type'}) 'BlockStatement > *'(node: TSESTree.Node)

but such a rule would be unnecessary if we build template literal types... hmmmm

Rule banning complex ESQuery selectors eslint-community/eslint-plugin-eslint-plugin#339

Rule enforcing typeAnnotation on a complex query is correct eslint-community/eslint-plugin-eslint-plugin#340

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.51.0` -> `5.52.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.51.0/5.52.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.51.0` -> `5.52.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.51.0/5.52.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.52.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5520-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5510v5520-2023-02-13) [Compare Source](typescript-eslint/typescript-eslint@v5.51.0...v5.52.0) ##### Bug Fixes - **eslint-plugin:** \[no-import-type-side-effects] correctly ignore zero-specifier imports ([#6444](typescript-eslint/typescript-eslint#6444)) ([d5a6688](typescript-eslint/typescript-eslint@d5a6688)) - **eslint-plugin:** \[no-unnecessary-condition] account for optional chaining on potentially void values ([#6432](typescript-eslint/typescript-eslint#6432)) ([e1d9c67](typescript-eslint/typescript-eslint@e1d9c67)), closes [#5255](typescript-eslint/typescript-eslint#5255) - **eslint-plugin:** \[no-unnecessary-condition] fix false positive when checking indexed access types ([#6452](typescript-eslint/typescript-eslint#6452)) ([d569924](typescript-eslint/typescript-eslint@d569924)) - **eslint-plugin:** fix key-spacing when type starts on next line ([#6412](typescript-eslint/typescript-eslint#6412)) ([3eb2eed](typescript-eslint/typescript-eslint@3eb2eed)) ##### Features - **eslint-plugin:** \[block-spacing] extending base rule for TS related blocks ([#6195](typescript-eslint/typescript-eslint#6195)) ([b2db3f5](typescript-eslint/typescript-eslint@b2db3f5)) - **eslint-plugin:** \[explicit-function-return-type] add allowFunctionsWithoutTypeParameters option ([#6105](typescript-eslint/typescript-eslint#6105)) ([113640e](typescript-eslint/typescript-eslint@113640e)) - **eslint-plugin:** \[explicit-function-return-type] add allowIIFEs option ([#6237](typescript-eslint/typescript-eslint#6237)) ([a1b3f7b](typescript-eslint/typescript-eslint@a1b3f7b)) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.52.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5520-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5510v5520-2023-02-13) [Compare Source](typescript-eslint/typescript-eslint@v5.51.0...v5.52.0) **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, check this box --- 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/1784 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>

fix(eslint-plugin): [no-import-type-side-effects] correctly ignore ze…

f0dc4a6

…ro-specifier imports

bradzacher added the bug Something isn't working label Feb 9, 2023

JoshuaKGoldberg approved these changes Feb 9, 2023

View reviewed changes

bradzacher merged commit d5a6688 into main Feb 9, 2023

bradzacher deleted the 6431-jfc-im-an-idoit branch February 9, 2023 22:42

This was referenced Feb 10, 2023

Rule banning complex ESQuery selectors eslint-community/eslint-plugin-eslint-plugin#339

Open

Rule enforcing typeAnnotation on a complex query is correct eslint-community/eslint-plugin-eslint-plugin#340

Open

github-actions bot locked as resolved and limited conversation to collaborators Feb 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [no-import-type-side-effects] correctly ignore zero-specifier imports #6444

fix(eslint-plugin): [no-import-type-side-effects] correctly ignore zero-specifier imports #6444

bradzacher commented Feb 9, 2023 •

edited

typescript-eslint bot commented Feb 9, 2023

nx-cloud bot commented Feb 9, 2023 •

edited

netlify bot commented Feb 9, 2023 •

edited

codecov bot commented Feb 9, 2023 •

edited

JoshuaKGoldberg left a comment

JoshuaKGoldberg Feb 9, 2023

bradzacher Feb 9, 2023 •

edited

JoshuaKGoldberg Feb 9, 2023

bradzacher Feb 9, 2023 •

edited

JoshuaKGoldberg Feb 10, 2023

fix(eslint-plugin): [no-import-type-side-effects] correctly ignore zero-specifier imports #6444

fix(eslint-plugin): [no-import-type-side-effects] correctly ignore zero-specifier imports #6444

Conversation

bradzacher commented Feb 9, 2023 • edited

PR Checklist

Overview

typescript-eslint bot commented Feb 9, 2023

nx-cloud bot commented Feb 9, 2023 • edited

☁️ Nx Cloud Report

netlify bot commented Feb 9, 2023 • edited

✅ Deploy Preview for typescript-eslint ready!

codecov bot commented Feb 9, 2023 • edited

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg Feb 9, 2023

Choose a reason for hiding this comment

bradzacher Feb 9, 2023 • edited

Choose a reason for hiding this comment

JoshuaKGoldberg Feb 9, 2023

Choose a reason for hiding this comment

bradzacher Feb 9, 2023 • edited

Choose a reason for hiding this comment

JoshuaKGoldberg Feb 10, 2023

Choose a reason for hiding this comment

bradzacher commented Feb 9, 2023 •

edited

nx-cloud bot commented Feb 9, 2023 •

edited

netlify bot commented Feb 9, 2023 •

edited

codecov bot commented Feb 9, 2023 •

edited

bradzacher Feb 9, 2023 •

edited

bradzacher Feb 9, 2023 •

edited