Skip to content

Update README.md#70609

Closed
darnado wants to merge 1 commit intoWordPress:trunkfrom
darnado:patch-1
Closed

Update README.md#70609
darnado wants to merge 1 commit intoWordPress:trunkfrom
darnado:patch-1

Conversation

@darnado
Copy link
Copy Markdown

@darnado darnado commented Jul 3, 2025

In projects using the --experimental-modules flag, the default @wordpress/scripts webpack configuration returns an array of configs instead of a single object.

This change normalizes the imported config to an array, applies custom rule modifications (e.g., support for .mp3 files), and exports it back in its original format. This ensures that custom webpack overrides are compatible with both single and multi-config setups, avoiding unexpected build errors.

What?

Update webpack config override example to support both single and multiple configurations returned by @wordpress/scripts/config/webpack.config.

Why?

The current example assumes a single configuration object. However, when the WP_EXPERIMENTAL_MODULES flag is enabled, the config returns an array. Without handling this, any custom override using the --experimental-modules flag would throw an error.

This change ensures compatibility in both scenarios.

How?

  • Normalizes the imported wpConfig to an array.
  • Maps over each config to inject a rule.
  • Exports the modified configs, returning a single object if the original wasn't an array.

Testing Instructions

Not applicable. This change updates a documentation example. No functional testing required.

Testing Instructions for Keyboard

Not applicable. This change updates a documentation example. No functional testing required.

Screenshots or screencast

Pull.Request.mp4

In projects using the --experimental-modules flag, the default
@wordpress/scripts webpack configuration returns an array of
configs instead of a single object.

This change normalizes the imported config to an array, applies
custom rule modifications (e.g., support for .mp3 files), and
exports it back in its original format. This ensures that
custom webpack overrides are compatible with both single and
multi-config setups, avoiding unexpected build errors.
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jul 3, 2025

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

1 similar comment
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jul 3, 2025

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jul 3, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: darnado <darnado@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Jul 3, 2025
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jul 3, 2025

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @darnado! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@t-hamano t-hamano added the [Type] Developer Documentation Documentation for developers label Jul 4, 2025
@darnado darnado closed this by deleting the head repository Jan 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants