Skip to content
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

fix(html): Template files should only include entry chunks #688

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

ianpurvis
Copy link

Rollup Plugin Name: html

This PR contains:

  • bugfix
  • feature
  • refactor
  • documentation
  • other

Are tests included?

  • yes (bugfixes and features will not be merged without tests)
  • no

Breaking Changes?

  • yes (breaking changes will not be merged unless absolutely necessary)
  • no

If yes, then include "BREAKING CHANGES:" in the first commit message body, followed by a description of what is breaking.

List any relevant issue numbers: #634

Description

I ran into a regression in #634 where non-entry scripts are injected into the default html template. This can cause unexpected behavior especially if those scripts have side-effects. This PR fixes the file filter and also adds a guard in case rollup emitted any javascript asset files.

@shellscape
Copy link
Collaborator

Thanks for the PR! You're on the right path, but just off of it. I think the idea is good for default behavior as well, and while it is breaking, it'll make default behavior for others easier to understand when the build gets a little bigger. So good call.

Where you want to make the change though, is here:

const scripts = (files.js || [])
.map(({ fileName }) => {
const attrs = makeHtmlAttributes(attributes.script);
return `<script src="${publicPath}${fileName}"${attrs}></script>`;
})
.join('\n');

@ianpurvis
Copy link
Author

@shellscape Sounds good- actually, I looked at that approach too but went the other direction because I thought the behavior change was a mistake in a1b2fc3. I'll update this PR 👍

Copy link
Collaborator

@shellscape shellscape left a comment

Choose a reason for hiding this comment

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

I appreciate that you're trying to make this easier for the use case on your end, but I don't think you're considering the flexibility needed for the userbase as a whole. I'd like the original getFiles to be reinstated, and the block I mentioned here #688 (comment) to filter for entry files like you had originally intended. That allows any custom template or consumer to get the full stack of build files as originally intended.

@ianpurvis
Copy link
Author

Wait, doesn't removing the filter from getFiles allow the template function to get the full stack of files? My intention in 233fe7c was to allow all files to flow to the template function, moving the isEntry filter to the default template implementation only.

About the filter itself, I am using some assumptions about Rollup's OutputAsset|OutputChunk type. Assuming that .type must equal 'chunk' or 'asset', the filter logic from a1b2fc3 already seems to be a no-op:

 (file) =>
      file.type === 'chunk' ||
      (typeof file.type === 'string' ? file.type === 'asset' : file.isAsset)

But maybe I am missing something- is that assumption invalid? Let me know, I am ready to tweak the PR as needed, just need more clarification...

@shellscape shellscape force-pushed the master branch 2 times, most recently from b353836 to 3038271 Compare October 21, 2022 19:01
@shellscape shellscape force-pushed the master branch 7 times, most recently from a69c299 to a9b9cd3 Compare October 25, 2023 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants