Scripts: Copy PHP files from src into build

[ryanwelcher]

Description

When building dynamic blocks, there are many cases where splitting out the markup into an external PHP file is very helpful. The current build process copies the block.json file into the build directory but any .php files are not. This PR adds them to the copying process.

Testing Instructions

I created a block using npx @wordpress/create-block@ my-first-dynamic-block --template=@ryanwelcher/dynamic-block-template ( this contains an template.php file in the src directory )
Then ran node {FULLPATH}/gutenberg/packages/scripts/bin/wp-scripts.js -- build

Screenshots

Types of changes

Adds any .PHP files inside of src to it's corresponding location in build

Checklist:

• My code is tested.
• My code follows the WordPress code style.
• My code follows the accessibility standards.
• I've tested my changes with keyboard and screen readers.
• My code has proper inline documentation.
• I've included developer documentation if appropriate.
• I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).
• I've updated related schemas if appropriate.

[gziolo]

Looks great. I added a changelog entry since people will suddenly start seeing PHP files in the build folder which might be surprising for them.

[ryanwelcher]

Looks great. I added a changelog entry since people will suddenly start seeing PHP files in the build folder which might be surprising for them.

Thanks, @gziolo! I ALWAYS forget to add the changelog.

[herndlm]

Hi, is there a way to disable this? I guess I need to override the webpack config?

[gziolo]

Hi, is there a way to disable this? I guess I need to override the webpack config?

Yes, you would need to override the default config. Something like:

https://github.com/WordPress/gutenberg/tree/trunk/packages/scripts#extending-the-webpack-config

Can you explain the issue you have? It looks like the change introduced needs some tweaks so we are seeking more detailed feedback to provide better defaults.

[herndlm]

Sure, I'm happy to do so. We're using wordpress-scripts in some ouf WordPress PHP plugins where we also have JS parts. Maybe this is already a bit controversial. We have already some customization for that, but basically we have

• some generic PHP classes in src/
• a plugin-name.php in root, that adds e.g. a couple of shortcodes or bootstraps stuff that uses the classes from src/
• a TypeScript app in assets/src, for that one we use wordpress-scripts for testing, linting and building/transpiling it to public from where we load / enqueue it in plugin-name.php with plain WP code

So basically, our use-case is using wordpress-scripts in a WordPress environment that is not Gutenberg :) And in that case I don't want the generic PHP classes end up in public.

[delawski]

We have already some customization for that, but basically we have

• some generic PHP classes in src/
• a plugin-name.php in root, that adds e.g. a couple of shortcodes or bootstraps stuff that uses the classes from src/
• a TypeScript app in assets/src, for that one we use wordpress-scripts for testing, linting and building/transpiling it to public from where we load / enqueue it in plugin-name.php with plain WP code

We're using a similar directory structure in AMP WP plugin, i.e. the src directory stores PHP files while JS files are kept in assets/src and we're having analogical issues: ampproject/amp-wp#6947.

Right now the default source directory name of src is hardcoded in multiple places in the package (e.g. in the getWebpackEntryPoints() or in the webpack.config.js). I guess it'd be great to make it configurable in some way.

[ryanwelcher]

Follow up PR to move to an opt-in approach - #39171

[gziolo]

Follow up PR to move to an opt-in approach - #39171

Landed, I will publish shortly to npm to remove friction as discussed.