[Fix] dynamic-import-chunkname: add handling webpack magic comments
#2330
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MhMadHamster
changed the title
ljharb
reviewed
Dec 18, 2021
|
(I marked the PR as a draft, since that's how one indicates a PR isn't yet ready for review) |
Codecov Report
@@ Coverage Diff @@
## main #2330 +/- ##
==========================================
- Coverage 95.07% 94.65% -0.43%
==========================================
Files 66 65 -1
Lines 2721 2692 -29
Branches 915 892 -23
==========================================
- Hits 2587 2548 -39
- Misses 134 144 +10
Continue to review full report at Codecov.
|
Sure, however, it would be nice if someone from code owners/maintainers can make a decision in regards to rule's future and what I described in the main comment/objective, so i can finish off this PR. |
|
@MhMadHamster I think it's totally reasonable for this rule - whose purpose is to validate a magic webpack comment's chunk name - to also report on a syntactically invalid webpack magic comment (or alternatively, not to crash on them). Does that answer your question? |
Yes, thanks. I would suggest changing this error message to this because it now will fail not only on wrong chunkName comment but on anything that is not valid magic comment. |
|
That seems reasonable to me for when it's an invalid magic comment; when it's valid but doesn't have a correct chunkName, then i'd expect the current error. |
MhMadHamster
force-pushed
the
dynamic-import-chunkname-handle-magic-comments
branch
from
cfcf2ff
to
ee3b85f
Compare
MhMadHamster
commented
Dec 25, 2021
MhMadHamster
force-pushed
the
dynamic-import-chunkname-handle-magic-comments
branch
from
be53beb
to
bcbe162
Compare
|
@ljharb hey, can you please take a look, when you will have time |
ljharb
force-pushed
the
dynamic-import-chunkname-handle-magic-comments
branch
from
bcbe162
to
3318e7b
Compare
ljharb
approved these changes
Aug 26, 2022
ljharb
changed the title
dynamic-import-chunkname: add handling webpack magic comments
ljharb
force-pushed
the
dynamic-import-chunkname-handle-magic-comments
branch
from
3318e7b
to
47b529e
Compare
crapStone
pushed a commit
to Calciumdibromid/CaBr2
that referenced
this pull request
Jan 13, 2023
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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC45Ny41IiwidXBkYXRlZEluVmVyIjoiMzQuMTAwLjEifQ==--> 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR follows the conversation from #1411 and aims to add support for all of the magic comments that currently (at the point of opening this pr) supported by webpack itself. Webpack documentation and ImportParserPlugin are used as reference for rules.
This PR not yet ready for merge and more of a PoC (haven't updated docs/changelog yet). The reason why i consider this more of a PoC is because by introducing changes in this PR, IMO rule becomes more than a "check for a correct chunkname in a webpack dynamic import" because it now validates other magic comments as well. Following the conversation from #1411 i would suggest either completely removing anything unrelated to
webpackChunkname(i.e. rule just checks for presence ofwebpackChunknameand that it is a valid string, and doesn't care for anything else in a comment) OR renaming the rule to (for example)webpack-dynamic-importkeeping the changes from this PR and adding a separate flag, that you can enable, forwebpackChunknameto be required in your dynamic imports. I am, open for other suggestions.I dont see a point in adding "partial" support of magic comments suggested in #1411 You will be able to use invalid values, but rule will try to somewhat validate your comments anyway, why even validate anything aside from
webpackChunknamethen?Related:
#1407
#1840
#1904
#2306
#1411