docs(migration): add assets names array hint to avoid breaking the build when manifest enabled #18846
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
…ild when manifest enabled
benmccann
reviewed
Nov 30, 2024
| @@ -81,6 +81,8 @@ If you prefer to stick with `style.css` like in Vite 5, you can set `build.lib.c | |||
|
|
|||
| There are other breaking changes which only affect few users. | |||
|
|
|||
| - [[#18240] refactor: use `originalFileNames/names`](https://github.com/vitejs/vite/pull/18240): | |||
| - any plugin that emits assets with type `asset` must include the `names` array in the asset to avoid breaking the build when the manifest is enabled. Older versions of Vite use the `name` field to check whether the asset should be included in the manifest. | |||
There was a problem hiding this comment.
It's not just older versions. Vite 6 does too
vite/packages/vite/src/node/plugins/asset.ts
Line 400 in b39e696
There was a problem hiding this comment.
maybe only when using generateBundle hook adding the asset to the bundle?
|
I think #18240 is not a breaking change. Rollup 4.23.0 added the properties as non-optional so it's valid to rely on the fact. You can argue that that change was a breaking change though. But I guess won't break anything, unless you assign to the bundle object, which is discouraged by the document. |
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.
Description
Changes included in #18240 can break the build when the manifest is enabled and missing names if some plugin emit any asset without the entry (with
type='asset').Vite <6 using
nameentry to check whether the asset should be included in the manifest (nameis deprecated, not sure when was deprecated in Rollup).For example, vite-plugin-pwa emits 2 assets (not registered in the manifest): vite-pwa/vite-plugin-pwa@58553f8