Skip to content

[AssetMapper] Adding infos to be forwarded to package maintainers in case of error #19565

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 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
Mar 25, 2024
Merged
Changes from all commits
Commits
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: 7 additions & 0 deletions frontend/asset_mapper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,11 @@ to add any `npm package`_:

$ php bin/console importmap:require bootstrap

.. note::

If you're getting a 404 error, you can contact the package maintainer and ask them to
include `"main":` and `"module":` to the package's `package.json`.

Copy link
Member

Choose a reason for hiding this comment

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

This cut the example in two. Could you group your two additions in a dedicated paragraph ?

And a 404 could have many other reasons, i fear this could be misdirecting :|

This adds the ``bootstrap`` package to your ``importmap.php`` file::

// importmap.php
Expand All @@ -207,6 +212,8 @@ This adds the ``bootstrap`` package to your ``importmap.php`` file::
such as ``@popperjs/core``. The ``importmap:require`` command will add both the
main package *and* its dependencies. If a package includes a main CSS file,
that will also be added (see :ref:`Handling 3rd-Party CSS <asset-mapper-3rd-party-css>`).
If the associated CSS file isn't added to the importmap, you can contact the package
Copy link
Member

Choose a reason for hiding this comment

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

This should be in the "handling 3rd party" section, as this paragraph states "if a packages includes a CSS files".

maintainer and ask them to include `"style":` to the package's `package.json`.

Now you can import the ``bootstrap`` package like usual:

Expand Down