[Fix] `ExportMap` / flat config: include `languageOptions` in context #3052

michaelfaith · 2024-09-05T11:29:59Z

This change fixes a bug with flat config support. There is a function called childContext that's used by the ExportBuilder to "cleanse" the context object. This function wasn't including the new languageOptions object, which contains the parser. So by the time this cleansed context made it to the parse function, languageOptions wasn't there anymore.

Since parserPath was still being included in non-flat config scenarios, the parse function made it through ok and used parserPath. However, once you shift to flat config, parserPath is no longer defined, and the actual parser object needs to be there.

Fixes #3051

This change fixes a bug with flat config support. There is a function called `childContext` that's used by the ExportBuilder to "cleanse" the context object. This function wasn't including the new `languageOptions` object, which contains the parser. So by the time this cleansed context made it to the parse function, `languageOptions` wasn't there anymore. Since `parserPath` was still being included in non-flat config scenarios, the parse function made it through ok and used `parserPath`. However, once you shift to flat config, `parserPath` is no longer defined, and the actual parser object needs to be there. Fixes import-js#3051

codecov · 2024-09-05T11:41:49Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.29%. Comparing base (18787d3) to head (6ba9c0d).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3052      +/-   ##
==========================================
- Coverage   95.13%   90.29%   -4.84%     
==========================================
  Files          81       81              
  Lines        3411     3411              
  Branches     1195     1195              
==========================================
- Hits         3245     3080     -165     
- Misses        166      331     +165

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ljharb

Thanks! Any way we can test for this?

michaelfaith · 2024-09-05T16:57:58Z

Thanks! Any way we can test for this?

For sure. I can do that. I'm having issues running the unit test suite locally (I think my version of node is too new for this version of nyc), so it may take a few updates to the PR to get things just right, using CI as my feedback loop.

michaelfaith · 2024-09-05T17:18:24Z

Added a couple of tests for childContext (and I was able to get the tests running locally by updating the version of nyc to the latest, as well as making a few other tweaks to the setup).

ljharb

Thanks! It'd be really nice to have an actual eslint 9 test that matches the flow that exposed this issue, but this is sufficient for now :-)

michaelfaith · 2024-09-05T20:55:56Z

Thanks! It'd be really nice to have an actual eslint 9 test that matches the flow that exposed this issue, but this is sufficient for now :-)

Totally agree, and those'll be in @G-Rath's PR. Their v9 tests are failing right now because they need this change. So, once they bring this into their branch, those tests will be the v9 integration tests that cover this scenario.

G-Rath · 2024-09-05T20:58:02Z

(fwiw I did a poor cherry-pick before this landed and pushed that up and at least some of the tests were improved, and now locally I've rebased and am just sorting out the handling of env before I push again and start digging into the whole suite again etc etc 🙂)

ljharb · 2024-09-05T20:59:09Z

I'm waiting for CI, and then I'll be publishing eslint-module-utils, and then updating main to require it and use the new helpers, after which you'll need to rebase, so feel free to wait :-)

@G-Rath

| datasource | package | from | to | | ---------- | -------------------- | ------ | ------ | | npm | eslint-plugin-import | 2.30.0 | 2.31.0 | ## [v2.31.0](https://github.com/import-js/eslint-plugin-import/blob/HEAD/CHANGELOG.md#2310---2024-10-03) ##### Added - support eslint v9 (\[[#2996](import-js/eslint-plugin-import#2996)], thanks \[[@G-Rath](https://github.com/G-Rath)] \[[@michaelfaith](https://github.com/michaelfaith)]) - \[`order`]: allow validating named imports (\[[#3043](import-js/eslint-plugin-import#3043)], thanks \[[@manuth](https://github.com/manuth)]) - \[`extensions`]: add the `checkTypeImports` option (\[[#2817](import-js/eslint-plugin-import#2817)], thanks \[[@phryneas](https://github.com/phryneas)]) ##### Fixed - `ExportMap` / flat config: include `languageOptions` in context (\[[#3052](import-js/eslint-plugin-import#3052)], thanks \[[@michaelfaith](https://github.com/michaelfaith)]) - \[`no-named-as-default`]: Allow using an identifier if the export is both a named and a default export (\[[#3032](import-js/eslint-plugin-import#3032)], thanks \[[@akwodkiewicz](https://github.com/akwodkiewicz)]) - \[`export`]: False positive for exported overloaded functions in TS (\[[#3065](import-js/eslint-plugin-import#3065)], thanks \[[@liuxingbaoyu](https://github.com/liuxingbaoyu)]) - `exportMap`: export map cache is tainted by unreliable parse results (\[[#3062](import-js/eslint-plugin-import#3062)], thanks \[[@michaelfaith](https://github.com/michaelfaith)]) - `exportMap`: improve cacheKey when using flat config (\[[#3072](import-js/eslint-plugin-import#3072)], thanks \[[@michaelfaith](https://github.com/michaelfaith)]) - adjust "is source type module" checks for flat config (\[[#2996](import-js/eslint-plugin-import#2996)], thanks \[[@G-Rath](https://github.com/G-Rath)]) ##### Changed - \[Docs] \[`no-relative-packages`]: fix typo (\[[#3066](import-js/eslint-plugin-import#3066)], thanks \[[@joshuaobrien](https://github.com/joshuaobrien)]) - \[Performance] \[`no-cycle`]: dont scc for each linted file (\[[#3068](import-js/eslint-plugin-import#3068)], thanks \[[@soryy708](https://github.com/soryy708)]) - \[Docs] \[`no-cycle`]: add `disableScc` to docs (\[[#3070](import-js/eslint-plugin-import#3070)], thanks \[[@soryy708](https://github.com/soryy708)]) - \[Tests] use re-exported `RuleTester` (\[[#3071](import-js/eslint-plugin-import#3071)], thanks \[[@G-Rath](https://github.com/G-Rath)]) - \[Docs] \[`no-restricted-paths`]: fix grammar (\[[#3073](import-js/eslint-plugin-import#3073)], thanks \[[@unbeauvoyage](https://github.com/unbeauvoyage)]) - \[Tests] \[`no-default-export`], \[`no-named-export`]: add test case (thanks \[[@G-Rath](https://github.com/G-Rath)])

@G-Rath

| datasource | package | from | to | | ---------- | -------------------- | ------ | ------ | | npm | eslint-plugin-import | 2.30.0 | 2.31.0 | ## [v2.31.0](https://github.com/import-js/eslint-plugin-import/blob/HEAD/CHANGELOG.md#2310---2024-10-03) ##### Added - support eslint v9 (\[[#2996](import-js/eslint-plugin-import#2996)], thanks \[[@G-Rath](https://github.com/G-Rath)] \[[@michaelfaith](https://github.com/michaelfaith)]) - \[`order`]: allow validating named imports (\[[#3043](import-js/eslint-plugin-import#3043)], thanks \[[@manuth](https://github.com/manuth)]) - \[`extensions`]: add the `checkTypeImports` option (\[[#2817](import-js/eslint-plugin-import#2817)], thanks \[[@phryneas](https://github.com/phryneas)]) ##### Fixed - `ExportMap` / flat config: include `languageOptions` in context (\[[#3052](import-js/eslint-plugin-import#3052)], thanks \[[@michaelfaith](https://github.com/michaelfaith)]) - \[`no-named-as-default`]: Allow using an identifier if the export is both a named and a default export (\[[#3032](import-js/eslint-plugin-import#3032)], thanks \[[@akwodkiewicz](https://github.com/akwodkiewicz)]) - \[`export`]: False positive for exported overloaded functions in TS (\[[#3065](import-js/eslint-plugin-import#3065)], thanks \[[@liuxingbaoyu](https://github.com/liuxingbaoyu)]) - `exportMap`: export map cache is tainted by unreliable parse results (\[[#3062](import-js/eslint-plugin-import#3062)], thanks \[[@michaelfaith](https://github.com/michaelfaith)]) - `exportMap`: improve cacheKey when using flat config (\[[#3072](import-js/eslint-plugin-import#3072)], thanks \[[@michaelfaith](https://github.com/michaelfaith)]) - adjust "is source type module" checks for flat config (\[[#2996](import-js/eslint-plugin-import#2996)], thanks \[[@G-Rath](https://github.com/G-Rath)]) ##### Changed - \[Docs] \[`no-relative-packages`]: fix typo (\[[#3066](import-js/eslint-plugin-import#3066)], thanks \[[@joshuaobrien](https://github.com/joshuaobrien)]) - \[Performance] \[`no-cycle`]: dont scc for each linted file (\[[#3068](import-js/eslint-plugin-import#3068)], thanks \[[@soryy708](https://github.com/soryy708)]) - \[Docs] \[`no-cycle`]: add `disableScc` to docs (\[[#3070](import-js/eslint-plugin-import#3070)], thanks \[[@soryy708](https://github.com/soryy708)]) - \[Tests] use re-exported `RuleTester` (\[[#3071](import-js/eslint-plugin-import#3071)], thanks \[[@G-Rath](https://github.com/G-Rath)]) - \[Docs] \[`no-restricted-paths`]: fix grammar (\[[#3073](import-js/eslint-plugin-import#3073)], thanks \[[@unbeauvoyage](https://github.com/unbeauvoyage)]) - \[Tests] \[`no-default-export`], \[`no-named-export`]: add test case (thanks \[[@G-Rath](https://github.com/G-Rath)])

michaelfaith mentioned this pull request Sep 5, 2024

[New] support eslint 9 #2996

Merged

jordan-erisman approved these changes Sep 5, 2024

View reviewed changes

ljharb reviewed Sep 5, 2024

View reviewed changes

michaelfaith force-pushed the fix/include-lanugage-options-in-context branch from 53ae632 to 6ba9c0d Compare September 5, 2024 17:17

This comment was marked as off-topic.

Sign in to view

ljharb approved these changes Sep 5, 2024

View reviewed changes

ljharb force-pushed the fix/include-lanugage-options-in-context branch from 6ba9c0d to 186f248 Compare September 5, 2024 18:18

ljharb changed the title ~~fix(flatConfig): include languageOptions in context~~ [Fix] ExportMap / flat config: include languageOptions in context Sep 5, 2024

ljharb merged commit 186f248 into import-js:main Sep 5, 2024
308 of 309 checks passed

michaelfaith mentioned this pull request Sep 17, 2024

[utils] [fix] parse: espree parser isn't working with flat config #3061

Merged

shvlv mentioned this pull request Oct 2, 2024

Upgrade ESLint to v9 WordPress/gutenberg#65648

Draft

thlucas1 mentioned this pull request Oct 22, 2024

Bump eslint-plugin-import from 2.30.0 to 2.31.0 thlucas1/spotifyplus_card#3

Closed

ManuelDevWeb mentioned this pull request Oct 25, 2024

[Snyk] Upgrade eslint-plugin-import from 2.22.1 to 2.31.0 ManuelDevWeb/platziVideoReactRouterYRedux#339

Open

indy2kro mentioned this pull request Oct 25, 2024

[Snyk] Upgrade eslint-plugin-import from 2.30.0 to 2.31.0 indy2kro/laravel-git-hooks#14

Merged

alhugot-azpn mentioned this pull request Oct 25, 2024

security(snyk): upgrade eslint-plugin-import from 2.30.0 to 2.31.0 emerson-eps/eslint-config#277

Open

qdraw mentioned this pull request Oct 25, 2024

[Snyk] Upgrade eslint-plugin-import from 2.30.0 to 2.31.0 qdraw/starsky#1785

Merged

richyhoopd mentioned this pull request Oct 26, 2024

[Snyk] Upgrade eslint-plugin-import from 2.20.2 to 2.31.0 richyhoopd/Video-App#1239

Open

ManuelDevWeb mentioned this pull request Oct 26, 2024

[Snyk] Upgrade eslint-plugin-import from 2.22.1 to 2.31.0 ManuelDevWeb/platziVideoReact#339

Open

Vishesh7797 mentioned this pull request Oct 27, 2024

[Snyk] Upgrade eslint-plugin-import from 2.14.0 to 2.31.0 Vishesh7797/material-ui#4

Open

Exkaleburx mentioned this pull request Oct 27, 2024

[Snyk] Upgrade eslint-plugin-import from 2.20.1 to 2.31.0 Exkaleburx/plug-and-klay#19

Open

Mastermindzh mentioned this pull request Oct 27, 2024

[Snyk] Upgrade eslint-plugin-import from 2.26.0 to 2.31.0 Mastermindzh/eslint-config#47

Closed

DadonStyle mentioned this pull request Oct 27, 2024

[Snyk] Upgrade eslint-plugin-import from 2.25.4 to 2.31.0 DadonStyle/Crypto-Tower-FE#37

Open

This was referenced Oct 28, 2024

[Snyk] Upgrade eslint-plugin-import from 2.29.1 to 2.31.0 nodeshift/kube-service-bindings#242

Closed

[Snyk] Upgrade eslint-plugin-import from 2.27.5 to 2.31.0 nodeshift/opossum#902

Open

thlucas1 mentioned this pull request Nov 1, 2024

Bump eslint-plugin-import from 2.29.1 to 2.31.0 thlucas1/homeassistantcomponent_soundtouchplus_card#23

Closed

DadonStyle mentioned this pull request Nov 3, 2024

[Snyk] Upgrade eslint-plugin-import from 2.25.4 to 2.31.0 DadonStyle/Crypto-Tower-FE#42

Open

dpesall mentioned this pull request Nov 6, 2024

[Snyk] Upgrade eslint-plugin-import from 2.29.1 to 2.31.0 nasa/cmr-stac#377

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fix] `ExportMap` / flat config: include `languageOptions` in context #3052

[Fix] `ExportMap` / flat config: include `languageOptions` in context #3052

michaelfaith commented Sep 5, 2024

codecov bot commented Sep 5, 2024 •

edited

Loading

ljharb left a comment

michaelfaith commented Sep 5, 2024

michaelfaith commented Sep 5, 2024

This comment was marked as off-topic.

ljharb left a comment

michaelfaith commented Sep 5, 2024

G-Rath commented Sep 5, 2024 •

edited

Loading

ljharb commented Sep 5, 2024

[Fix] ExportMap / flat config: include languageOptions in context #3052

[Fix] ExportMap / flat config: include languageOptions in context #3052

Conversation

michaelfaith commented Sep 5, 2024

codecov bot commented Sep 5, 2024 • edited Loading

Codecov Report

ljharb left a comment

Choose a reason for hiding this comment

michaelfaith commented Sep 5, 2024

michaelfaith commented Sep 5, 2024

This comment was marked as off-topic.

ljharb left a comment

Choose a reason for hiding this comment

michaelfaith commented Sep 5, 2024

G-Rath commented Sep 5, 2024 • edited Loading

ljharb commented Sep 5, 2024

[Fix] `ExportMap` / flat config: include `languageOptions` in context #3052

[Fix] `ExportMap` / flat config: include `languageOptions` in context #3052

codecov bot commented Sep 5, 2024 •

edited

Loading

G-Rath commented Sep 5, 2024 •

edited

Loading