NotificationsYou must be signed in to change notification settings
Fork9.6k
Star30.3k

[AssetMapper] Add`--dry-run` option on`importmap:require` command#59464

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

fabpot merged 1 commit intosymfony:7.3fromchadyred:feat/command-importmap-require-details-2

Mar 10, 2025

Merged

[AssetMapper] Add`--dry-run` option on`importmap:require` command#59464

fabpot merged 1 commit intosymfony:7.3fromchadyred:feat/command-importmap-require-details-2

Mar 10, 2025

Conversation

Copy link

Contributor

chadyred commentedJan 10, 2025•
edited
Loading

Q	A
Branch?	7.3
Bug fix?	no
New feature?	yes
Deprecations?	no
License	MIT

We are working with@smnandre on several ideas toimprove AssetMapper DX, focusing here on theimportmap:require command.

Currently, there is no way to know in advance which dependent packages will be downloaded too, and the final output display lacks clarity.

This PR aims to solve both issues by adding a new--dry-run flag and reworking the command output (with-v verbosity)

Console output

php bin/console importmap:require bootstrap --dry-run -v[DRY-RUN] No changes will apply to the importmap configuration. -------------------------------------- --------- ----------------------------------------------------  Package                                Version   Path -------------------------------------- --------- ----------------------------------------------------  bootstrap                              5.3.3     assets/vendor/bootstrap/bootstrap.index.js  @popperjs/core                         2.11.8    assets/vendor/@popperjs/core/core.index.js  bootstrap/dist/css/bootstrap.min.css   5.3.3     assets/vendor/bootstrap/dist/css/bootstrap.min.css -------------------------------------- --------- ---------------------------------------------------- [OK] 3 new items (bootstrap, @popperjs/core, bootstrap/dist/css/bootstrap.min.css) added to the importmap.php![DRY-RUN] No changes applied to the importmap configuration.

New`--dry-run` option

This flag allows developers to simulate the installation process, without any alteration:

no modification ofimportmap.php file;
no file added or updated in theassets andpublic directories.

The--dry-run flag allows developers to:

check commands formistakes (e.g., typingbootrap instead ofbootstrap, orjquery);
list dependentpackages that will be installed (e.g., requiringbootstrap will also install@popperjs/core);
test for potential issues whiledownloading¹ files.

The console will display a line at start and end of execution to signal the dry-run mode.

Console output

php bin/console importmap:require bootstrap --dry-run[DRY-RUN] No changes will apply to the importmap configuration.                                                                                                                         [OK] 3 new items (bootstrap, @popperjs/core, bootstrap/dist/css/bootstrap.min.css) added to the importmap.php!                                                                                                                                 [DRY-RUN] No changes applied to the importmap configuration.

New`-v` verbose output

This PR also reworks the output for the-v (verbose) flag to provide more clarity when running the command with additional verbosity.

All feedback welcome!

Footnotes

AssetMapper recursively extracts the dependencies of JavaScript modules. Even with the--dry-run option, theimportmap:require command requires a workingHttpClient to download metadata and JavaScript files from various registries/repositories (mainly JSDelivr for now).↩