Skip to content

[AssetMapper] Add docs for importmap:install command #18785

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 28, 2023
Merged

[AssetMapper] Add docs for importmap:install command #18785

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions frontend/asset_mapper.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,11 @@ If you want to download the package locally, use the ``--download`` option:
$ php bin/console importmap:require bootstrap --download

This will download the package into an ``assets/vendor/`` directory and update
the ``importmap.php`` file to point to it. You *should* commit this file to
your repository.
the ``importmap.php`` file to point to it. You can either commit this directory
to your repository, or ignore the directory in your ``.gitignore`` config file.
If the directory is ignored, you can run the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it « can » or « must » ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in 6.4, we should change the workflow from "must commit" to "should ignore". Let's rework the language for that - it'll be just like composer install: it's a "must" (assuming you are downloading assets locally).

In fact, would you mind opening a new recipe PR for AssetMapper 6.4 that includes assets/vendor/ in .gitignore?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While merging I did some tweaks according to your comments. See 5909e6b

``php bin/console importmap:install`` command to download the files on other
computers if some files are missing.

.. note::

Expand Down