[Refactor] `no-extraneous-dependencies` improve performance #2374

meowtec · 2022-01-27T03:56:42Z

In my project this will reduce the time from

import/no-extraneous-dependencies         |  3442.375 |     5.9%

to

import/no-extraneous-dependencies         |  1903.296 |     3.5%

codecov · 2022-01-27T06:55:02Z

Codecov Report

Base: 95.20% // Head: 95.15% // Decreases project coverage by -0.05% ⚠️

Coverage data is based on head (7f251b2) compared to base (d7c4f94).
Patch coverage: 85.71% of modified lines in pull request are covered.

❗ Current head 7f251b2 differs from pull request most recent head 9b9ae94. Consider uploading reports for the commit 9b9ae94 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2374      +/-   ##
==========================================
- Coverage   95.20%   95.15%   -0.06%     
==========================================
  Files          66       66              
  Lines        2818     2828      +10     
  Branches      948      949       +1     
==========================================
+ Hits         2683     2691       +8     
- Misses        135      137       +2

Impacted Files	Coverage Δ
src/rules/no-extraneous-dependencies.js	`98.16% <85.71%> (-1.84%)`	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

ljharb · 2022-01-27T18:40:55Z

src/rules/no-extraneous-dependencies.js

+function getPackageDepFields(packageJsonPath) {
+  if (!depFieldCache.has(packageJsonPath)) {
+    const depFields = extractDepFields(
+      JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')),


what happens if the package.json file has invalid syntax, or doesn't exist?

ljharb · 2022-01-27T18:41:08Z

src/core/importType.js

  const { settings } = context;
  if (isInternalRegexMatch(name, settings)) { return 'internal'; }
-  if (isAbsolute(name, settings, path)) { return 'absolute'; }
+  if (isAbsolute(name, settings)) { return 'absolute'; }


i very intentionally had all of these pass all three arguments, for consistency. if we're changing that, then this only takes 1 argument.

Suggested change

if (isAbsolute(name, settings)) { return 'absolute'; }

if (isAbsolute(name)) { return 'absolute'; }

(similar feedback on all the others)

ljharb · 2022-01-28T05:51:31Z

src/core/importType.js

+  if (isRelativeToSibling(name)) { return 'sibling'; }
+
+  // `resolve` is expensive, do it only when necessary
+  const path = getPath();
  if (isBuiltIn(name, settings, path)) { return 'builtin'; }


this change moves isBuiltIn below absolute/relativeToParent/index/relativeToSibling - this might be a breaking change for anyone relying on the import/core-modules setting, which currently takes precedence.

Could we make this change in next major version?

There's unlikely to be a major version any time soon, if ever.

ljharb · 2022-09-02T21:03:11Z

@meowtec i'd love to incorporate these speed improvements if we can avoid the breaking change - can you update this PR to do that?

Extracted from import-js#2374.

ljharb · 2022-09-02T22:18:33Z

I've reordered the commits, and added "clear the cache on program exit" so that long-running eslint processes won't have a memory leak. I plan to pull the cache commit into main directly, and leave this PR containing just the "lazy resolve" commit so we can keep working on it.

Extracted from import-js#2374.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import) | devDependencies | minor | [`2.26.0` -> `2.27.4`](https://renovatebot.com/diffs/npm/eslint-plugin-import/2.26.0/2.27.4) | --- ### Release Notes <details> <summary>import-js/eslint-plugin-import</summary> ### [`v2.27.4`](https://github.com/import-js/eslint-plugin-import/blob/HEAD/CHANGELOG.md#2274---2023-01-11) [Compare Source](import-js/eslint-plugin-import@v2.27.3...v2.27.4) ##### Fixed - `semver` should be a prod dep (\[[#2668](import-js/eslint-plugin-import#2668)]) ### [`v2.27.3`](https://github.com/import-js/eslint-plugin-import/blob/HEAD/CHANGELOG.md#2273---2023-01-11) [Compare Source](import-js/eslint-plugin-import@v2.27.2...v2.27.3) ##### Fixed - \[`no-empty-named-blocks`]: rewrite rule to only check import declarations (\[[#2666](import-js/eslint-plugin-import#2666)]) ### [`v2.27.2`](https://github.com/import-js/eslint-plugin-import/blob/HEAD/CHANGELOG.md#2272---2023-01-11) [Compare Source](import-js/eslint-plugin-import@v2.27.1...v2.27.2) ##### Fixed - \[`no-duplicates`]: do not unconditionally require `typescript` (\[[#2665](import-js/eslint-plugin-import#2665)]) ### [`v2.27.1`](https://github.com/import-js/eslint-plugin-import/blob/HEAD/CHANGELOG.md#2271---2023-01-11) [Compare Source](import-js/eslint-plugin-import@v2.27.0...v2.27.1) ##### Fixed - `array.prototype.flatmap` should be a prod dep (\[[#2664](import-js/eslint-plugin-import#2664)], thanks \[[@cristobal](https://github.com/cristobal)]) ### [`v2.27.0`](https://github.com/import-js/eslint-plugin-import/blob/HEAD/CHANGELOG.md#2270---2023-01-11) [Compare Source](import-js/eslint-plugin-import@v2.26.0...v2.27.0) ##### Added - \[`newline-after-import`]: add `considerComments` option (\[[#2399](import-js/eslint-plugin-import#2399)], thanks \[[@pri1311](https://github.com/pri1311)]) - \[`no-cycle`]: add `allowUnsafeDynamicCyclicDependency` option (\[[#2387](import-js/eslint-plugin-import#2387)], thanks \[[@GerkinDev](https://github.com/GerkinDev)]) - \[`no-restricted-paths`]: support arrays for `from` and `target` options (\[[#2466](import-js/eslint-plugin-import#2466)], thanks \[[@AdriAt360](https://github.com/AdriAt360)]) - \[`no-anonymous-default-export`]: add `allowNew` option (\[[#2505](import-js/eslint-plugin-import#2505)], thanks \[[@DamienCassou](https://github.com/DamienCassou)]) - \[`order`]: Add `distinctGroup` option (\[[#2395](import-js/eslint-plugin-import#2395)], thanks \[[@hyperupcall](https://github.com/hyperupcall)]) - \[`no-extraneous-dependencies`]: Add `includeInternal` option (\[[#2541](import-js/eslint-plugin-import#2541)], thanks \[[@bdwain](https://github.com/bdwain)]) - \[`no-extraneous-dependencies`]: Add `includeTypes` option (\[[#2543](import-js/eslint-plugin-import#2543)], thanks \[[@bdwain](https://github.com/bdwain)]) - \[`order`]: new `alphabetize.orderImportKind` option to sort imports with same path based on their kind (`type`, `typeof`) (\[[#2544](import-js/eslint-plugin-import#2544)], thanks \[[@stropho](https://github.com/stropho)]) - \[`consistent-type-specifier-style`]: add rule (\[[#2473](import-js/eslint-plugin-import#2473)], thanks \[[@bradzacher](https://github.com/bradzacher)]) - Add \[`no-empty-named-blocks`] rule (\[[#2568](import-js/eslint-plugin-import#2568)], thanks \[[@guilhermelimak](https://github.com/guilhermelimak)]) - \[`prefer-default-export`]: add "target" option (\[[#2602](import-js/eslint-plugin-import#2602)], thanks \[[@azyzz228](https://github.com/azyzz228)]) - \[`no-absolute-path`]: add fixer (\[[#2613](import-js/eslint-plugin-import#2613)], thanks \[[@adipascu](https://github.com/adipascu)]) - \[`no-duplicates`]: support inline type import with `inlineTypeImport` option (\[[#2475](import-js/eslint-plugin-import#2475)], thanks \[[@snewcomer](https://github.com/snewcomer)]) ##### Fixed - \[`order`]: move nested imports closer to main import entry (\[[#2396](import-js/eslint-plugin-import#2396)], thanks \[[@pri1311](https://github.com/pri1311)]) - \[`no-restricted-paths`]: fix an error message (\[[#2466](import-js/eslint-plugin-import#2466)], thanks \[[@AdriAt360](https://github.com/AdriAt360)]) - \[`no-restricted-paths`]: use `Minimatch.match` instead of `minimatch` to comply with Windows Native paths (\[[#2466](import-js/eslint-plugin-import#2466)], thanks \[[@AdriAt360](https://github.com/AdriAt360)]) - \[`order`]: require with member expression could not be fixed if alphabetize.order was used (\[[#2490](import-js/eslint-plugin-import#2490)], thanks \[[@msvab](https://github.com/msvab)]) - \[`order`]: leave more space in rankings for consecutive path groups (\[[#2506](import-js/eslint-plugin-import#2506)], thanks \[[@Pearce-Ropion](https://github.com/Pearce-Ropion)]) - \[`no-cycle`]: add ExportNamedDeclaration statements to dependencies (\[[#2511](import-js/eslint-plugin-import#2511)], thanks \[[@BenoitZugmeyer](https://github.com/BenoitZugmeyer)]) - \[`dynamic-import-chunkname`]: prevent false report on a valid webpack magic comment (\[[#2330](import-js/eslint-plugin-import#2330)], thanks \[[@mhmadhamster](https://github.com/mhmadhamster)]) - \[`export`]: do not error on TS export overloads (\[[#1590](import-js/eslint-plugin-import#1590)], thanks \[[@ljharb](https://github.com/ljharb)]) - \[`no-unresolved`], \[`extensions`]: ignore type only exports (\[[#2436](import-js/eslint-plugin-import#2436)], thanks \[[@Lukas-Kullmann](https://github.com/Lukas-Kullmann)]) - `ExportMap`: add missing param to function (\[[#2589](import-js/eslint-plugin-import#2589)], thanks \[[@Fdawgs](https://github.com/Fdawgs)]) - \[`no-unused-modules`]: `checkPkgFieldObject` filters boolean fields from checks (\[[#2598](import-js/eslint-plugin-import#2598)], thanks \[[@mpint](https://github.com/mpint)]) - \[`no-cycle`]: accept Flow `typeof` imports, just like `type` (\[[#2608](import-js/eslint-plugin-import#2608)], thanks \[[@gnprice](https://github.com/gnprice)]) - \[`no-import-module-exports`]: avoid a false positive for import variables (\[[#2315](import-js/eslint-plugin-import#2315)], thanks \[[@BarryThePenguin](https://github.com/BarryThePenguin)]) ##### Changed - \[Tests] \[`named`]: Run all TypeScript test (\[[#2427](import-js/eslint-plugin-import#2427)], thanks \[[@ProdigySim](https://github.com/ProdigySim)]) - \[readme] note use of typescript in readme `import/extensions` section (\[[#2440](import-js/eslint-plugin-import#2440)], thanks \[[@OutdatedVersion](https://github.com/OutdatedVersion)]) - \[Docs] \[`order`]: use correct default value (\[[#2392](import-js/eslint-plugin-import#2392)], thanks \[[@hyperupcall](https://github.com/hyperupcall)]) - \[meta] replace git.io link in comments with the original URL (\[[#2444](import-js/eslint-plugin-import#2444)], thanks \[[@liby](https://github.com/liby)]) - \[Docs] remove global install in readme (\[[#2412](import-js/eslint-plugin-import#2412)], thanks \[[@aladdin-add](https://github.com/aladdin-add)]) - \[readme] clarify `eslint-import-resolver-typescript` usage (\[[#2503](import-js/eslint-plugin-import#2503)], thanks \[[@JounQin](https://github.com/JounQin)]) - \[Refactor] \[`no-cycle`]: Add per-run caching of traversed paths (\[[#2419](import-js/eslint-plugin-import#2419)], thanks \[[@nokel81](https://github.com/nokel81)]) - \[Performance] `ExportMap`: add caching after parsing for an ambiguous module (\[[#2531](import-js/eslint-plugin-import#2531)], thanks \[[@stenin-nikita](https://github.com/stenin-nikita)]) - \[Docs] \[`no-useless-path-segments`]: fix paths (\[[#2424](import-js/eslint-plugin-import#2424)], thanks \[[@s-h-a-d-o-w](https://github.com/s-h-a-d-o-w)]) - \[Tests] \[`no-cycle`]: add passing test cases (\[[#2438](import-js/eslint-plugin-import#2438)], thanks \[[@georeith](https://github.com/georeith)]) - \[Refactor] \[`no-extraneous-dependencies`] improve performance using cache (\[[#2374](import-js/eslint-plugin-import#2374)], thanks \[[@meowtec](https://github.com/meowtec)]) - \[meta] `CONTRIBUTING.md`: mention inactive PRs (\[[#2546](import-js/eslint-plugin-import#2546)], thanks \[[@stropho](https://github.com/stropho)]) - \[readme] make json for setting groups multiline (\[[#2570](import-js/eslint-plugin-import#2570)], thanks \[[@bertyhell](https://github.com/bertyhell)]) - \[Tests] \[`no-restricted-paths`]: Tests for `import type` statements (\[[#2459](import-js/eslint-plugin-import#2459)], thanks \[[@golergka](https://github.com/golergka)]) - \[Tests] \[`no-restricted-paths`]: fix one failing `import type` test case, submitted by \[[@golergka](https://github.com/golergka)], thanks \[[@azyzz228](https://github.com/azyzz228)] - \[Docs] automate docs with eslint-doc-generator (\[[#2582](import-js/eslint-plugin-import#2582)], thanks \[[@bmish](https://github.com/bmish)]) - \[readme] Increase clarity around typescript configuration (\[[#2588](import-js/eslint-plugin-import#2588)], thanks \[[@Nfinished](https://github.com/Nfinished)]) - \[Docs] update `eslint-doc-generator` to v1.0.0 (\[[#2605](import-js/eslint-plugin-import#2605)], thanks \[[@bmish](https://github.com/bmish)]) - \[Perf] \[`no-cycle`], \[`no-internal-modules`], \[`no-restricted-paths`]: use `anyOf` instead of `oneOf` (thanks \[[@ljharb](https://github.com/ljharb)], \[[@remcohaszing](https://github.com/remcohaszing)]) </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 this update 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/1724 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>

[Refactor] importType resolve path lazily

9b9ae94

meowtec changed the title ~~[Refactor] no extraneous dependencies improve performance~~ [Refactor] no-extraneous-dependencies improve performance Jan 27, 2022

meowtec marked this pull request as draft January 27, 2022 04:01

meowtec force-pushed the performance/no-extraneous-dependencies branch from 9d7efd5 to d144bb0 Compare January 27, 2022 04:41

meowtec marked this pull request as ready for review January 27, 2022 05:23

ljharb reviewed Jan 27, 2022

View reviewed changes

meowtec force-pushed the performance/no-extraneous-dependencies branch 4 times, most recently from 6343bfb to a84c08d Compare January 28, 2022 05:48

ljharb reviewed Jan 28, 2022

View reviewed changes

ljharb marked this pull request as draft September 2, 2022 21:03

ljharb pushed a commit to meowtec/eslint-plugin-import that referenced this pull request Sep 2, 2022

[Refactor] no-extraneous-dependencies improve performance using cache

5831fcd

Extracted from import-js#2374.

ljharb force-pushed the performance/no-extraneous-dependencies branch from a84c08d to 7c00c5a Compare September 2, 2022 22:17

ljharb pushed a commit to meowtec/eslint-plugin-import that referenced this pull request Sep 2, 2022

[Refactor] no-extraneous-dependencies improve performance using cache

7f251b2

Extracted from import-js#2374.

ljharb force-pushed the performance/no-extraneous-dependencies branch from 7c00c5a to 9b9ae94 Compare September 2, 2022 22:26

ljharb mentioned this pull request Jul 23, 2023

[import/no-extraneous-dependencies] Doesn't properly clear the dependency cache #2838

Open

MaxMood96 mentioned this pull request Nov 30, 2023

[Snyk] Fix for 1 vulnerabilities MaxMood96/eslint-plugin-import#34

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Refactor] `no-extraneous-dependencies` improve performance #2374

[Refactor] `no-extraneous-dependencies` improve performance #2374

meowtec commented Jan 27, 2022 •

edited

codecov bot commented Jan 27, 2022 •

edited

ljharb Jan 27, 2022

ljharb Jan 27, 2022

ljharb Jan 28, 2022

meowtec Jan 28, 2022

ljharb Jan 28, 2022

ljharb commented Sep 2, 2022

ljharb commented Sep 2, 2022

	if (isAbsolute(name, settings)) { return 'absolute'; }
	if (isAbsolute(name)) { return 'absolute'; }

[Refactor] no-extraneous-dependencies improve performance #2374

Are you sure you want to change the base?

[Refactor] no-extraneous-dependencies improve performance #2374

Conversation

meowtec commented Jan 27, 2022 • edited

codecov bot commented Jan 27, 2022 • edited

Codecov Report

ljharb Jan 27, 2022

Choose a reason for hiding this comment

ljharb Jan 27, 2022

Choose a reason for hiding this comment

ljharb Jan 28, 2022

Choose a reason for hiding this comment

meowtec Jan 28, 2022

Choose a reason for hiding this comment

ljharb Jan 28, 2022

Choose a reason for hiding this comment

ljharb commented Sep 2, 2022

ljharb commented Sep 2, 2022

[Refactor] `no-extraneous-dependencies` improve performance #2374

[Refactor] `no-extraneous-dependencies` improve performance #2374

meowtec commented Jan 27, 2022 •

edited

codecov bot commented Jan 27, 2022 •

edited