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

Add support for scriptModule and viewScriptModule assets #372

Merged
merged 16 commits into from
Mar 27, 2024

Conversation

fabiankaegy
Copy link
Member

@fabiankaegy fabiankaegy commented Feb 22, 2024

Related Issue/RFC: #368

Description of the Change

Add support for scriptModule and viewScriptModule assets defined in block.json files.

These assets are handled by a separate instance of Webpack which is configured to output JS Modules instead of commonjs bundles.

In order to make this work we needed to split up the Webpack setup into two separate instances. One side-effect of this is that we can no longer run clean during watch mode since it would clean assets from the other webpack instance and therefore cause unexpected issues.

Important

We need to determine what impact this PR has on how easy it is to extend toolkit with a custom Webpack config. Because we are changing the interface that we export from an object to now an array of objects.

Alternate Designs

I can't think of alternative designs for this.

Possible Drawbacks

The extensibility needs to be figured out. Also with two separate webpack instances this may be a little slower / use more resources.

Verification Process

The bundled example block in the 10up-theme project has both a regular script and also a view module which uses the interactivity API.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.
  • I have added a changeset to my PR. See CONTRIBUTING document for instructions

@fabiankaegy fabiankaegy self-assigned this Feb 22, 2024
Copy link

changeset-bot bot commented Feb 22, 2024

🦋 Changeset detected

Latest commit: fac2194

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@fabiankaegy fabiankaegy force-pushed the feature/wp-block-module-support branch from 8bd6d19 to a07dcbe Compare March 19, 2024 19:16
@fabiankaegy fabiankaegy requested a review from nicholasio March 19, 2024 21:03
@fabiankaegy fabiankaegy changed the title add basic module support as a POC Add support for scriptModule and viewScriptModule assets Mar 19, 2024
@fabiankaegy fabiankaegy marked this pull request as ready for review March 19, 2024 21:18
@fabiankaegy fabiankaegy added JS Dependencies Pull requests that update a dependency file labels Mar 19, 2024
@fabiankaegy fabiankaegy added this to the [email protected] milestone Mar 19, 2024
@fabiankaegy fabiankaegy requested a review from nicholasio March 26, 2024 17:15
Copy link
Member

@nicholasio nicholasio left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dependencies Pull requests that update a dependency file JS [Type] Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants