<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[53140] trunk: Build: Enable React Fast Refresh for block development</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/53140">53140</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/53140","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>gziolo</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-04-11 16:08:12 +0000 (Mon, 11 Apr 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Build: Enable React Fast Refresh for block development
Brings the same functionality introduced in the Gutenberg plugin with https://github.com/WordPress/gutenberg/pull/28273. In effect, it brings React Fast Refresh support to WordPress core for block development with `@wordpress/scripts`.
Props walbo, antonvlasenko.
See <a href="https://core.trac.wordpress.org/ticket/51750">#51750</a>, <a href="https://core.trac.wordpress.org/ticket/55505">#55505</a>.
Follow-up <a href="https://core.trac.wordpress.org/changeset/53135">[53135]</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkGruntfilejs">trunk/Gruntfile.js</a></li>
<li><a href="#trunkpackagejson">trunk/package.json</a></li>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
<li><a href="#trunkwebpackconfigjs">trunk/webpack.config.js</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesassetsscriptloaderreactrefreshentryphp">trunk/src/wp-includes/assets/script-loader-react-refresh-entry.php</a></li>
<li><a href="#trunksrcwpincludesassetsscriptloaderreactrefreshruntimephp">trunk/src/wp-includes/assets/script-loader-react-refresh-runtime.php</a></li>
<li><a href="#trunktoolswebpackdevelopmentjs">trunk/tools/webpack/development.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkGruntfilejs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/Gruntfile.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/Gruntfile.js 2022-04-11 15:35:56 UTC (rev 53139)
+++ trunk/Gruntfile.js 2022-04-11 16:08:12 UTC (rev 53140)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,7 +124,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'webpack-assets': [
</span><span class="cx" style="display: block; padding: 0 10px"> WORKING_DIR + 'wp-includes/assets/*',
</span><span class="cx" style="display: block; padding: 0 10px"> WORKING_DIR + 'wp-includes/css/dist/',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '!' + WORKING_DIR + 'wp-includes/assets/script-loader-packages.php'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '!' + WORKING_DIR + 'wp-includes/assets/script-loader-*.php'
</ins><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> dynamic: {
</span><span class="cx" style="display: block; padding: 0 10px"> dot: true,
</span></span></pre></div>
<a id="trunkpackagejson"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/package.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/package.json 2022-04-11 15:35:56 UTC (rev 53139)
+++ trunk/package.json 2022-04-11 16:08:12 UTC (rev 53140)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,6 +24,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "last 2 Opera versions"
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><span class="cx" style="display: block; padding: 0 10px"> "devDependencies": {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "@pmmmwh/react-refresh-webpack-plugin": "0.5.5",
</ins><span class="cx" style="display: block; padding: 0 10px"> "@wordpress/babel-preset-default": "6.8.0",
</span><span class="cx" style="display: block; padding: 0 10px"> "@wordpress/dependency-extraction-webpack-plugin": "3.4.1",
</span><span class="cx" style="display: block; padding: 0 10px"> "@wordpress/e2e-test-utils": "5.4.10",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -62,6 +63,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "matchdep": "~2.0.0",
</span><span class="cx" style="display: block; padding: 0 10px"> "prettier": "npm:wp-prettier@2.0.5",
</span><span class="cx" style="display: block; padding: 0 10px"> "qunit": "~2.18.1",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "react-refresh": "0.10.0",
</ins><span class="cx" style="display: block; padding: 0 10px"> "sass": "^1.50.0",
</span><span class="cx" style="display: block; padding: 0 10px"> "sinon": "~13.0.1",
</span><span class="cx" style="display: block; padding: 0 10px"> "sinon-test": "~3.1.3",
</span></span></pre></div>
<a id="trunksrcwpincludesassetsscriptloaderreactrefreshentryphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/assets/script-loader-react-refresh-entry.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/assets/script-loader-react-refresh-entry.php (rev 0)
+++ trunk/src/wp-includes/assets/script-loader-react-refresh-entry.php 2022-04-11 16:08:12 UTC (rev 53140)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php return array('dependencies' => array('wp-react-refresh-runtime'), 'version' => '8151afc94a5ebc73b7a8229f0d7ee352');
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/src/wp-includes/assets/script-loader-react-refresh-entry.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunksrcwpincludesassetsscriptloaderreactrefreshruntimephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/assets/script-loader-react-refresh-runtime.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/assets/script-loader-react-refresh-runtime.php (rev 0)
+++ trunk/src/wp-includes/assets/script-loader-react-refresh-runtime.php 2022-04-11 16:08:12 UTC (rev 53140)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php return array('dependencies' => array(), 'version' => '4fb86f241c3b2d9d9e0411b507079823');
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/src/wp-includes/assets/script-loader-react-refresh-runtime.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunksrcwpincludesscriptloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php 2022-04-11 15:35:56 UTC (rev 53139)
+++ trunk/src/wp-includes/script-loader.php 2022-04-11 16:08:12 UTC (rev 53140)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -215,6 +215,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Registers development scripts that integrate with `@wordpress/scripts`.
+ *
+ * @see https://github.com/WordPress/gutenberg/tree/trunk/packages/scripts#start
+ *
+ * @since 6.0.0
+ *
+ * @param WP_Scripts $scripts WP_Scripts object.
+ */
+function wp_register_development_scripts( $scripts ) {
+ if (
+ ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG
+ || empty( $scripts->registered['react'] )
+ ) {
+ return;
+ }
+
+ $development_scripts = array(
+ 'react-refresh-entry',
+ 'react-refresh-runtime',
+ );
+
+ foreach ( $development_scripts as $script_name ) {
+ $assets = include ABSPATH . WPINC . '/assets/script-loader-' . $script_name . '.php';
+ if ( ! is_array( $assets ) ) {
+ return;
+ }
+ $scripts->add(
+ 'wp-' . $script_name,
+ '/wp-includes/js/dist/development/' . $script_name . '.js',
+ $assets['dependencies'],
+ $assets['version']
+ );
+ }
+
+ // See https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/main/docs/TROUBLESHOOTING.md#externalising-react.
+ $scripts->registered['react']->deps[] = 'wp-react-refresh-entry';
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Registers all the WordPress packages scripts that are in the standardized
</span><span class="cx" style="display: block; padding: 0 10px"> * `js/dist/` location.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -560,6 +599,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_default_packages( $scripts ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_default_packages_vendor( $scripts );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_register_development_scripts( $scripts );
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_register_tinymce_scripts( $scripts );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_default_packages_scripts( $scripts );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktoolswebpackdevelopmentjs"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tools/webpack/development.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tools/webpack/development.js (rev 0)
+++ trunk/tools/webpack/development.js 2022-04-11 16:08:12 UTC (rev 53140)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,61 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * External dependencies
+ */
+const { join } = require( 'path' );
+
+/**
+ * WordPress dependencies
+ */
+const DependencyExtractionWebpackPlugin = require( '@wordpress/dependency-extraction-webpack-plugin' );
+
+const baseDir = join( __dirname, '../../' );
+
+module.exports = function( env = { environment: 'production', buildTarget: false } ) {
+ const mode = env.environment;
+ const suffix = mode === 'production' ? '.min' : '';
+ let buildTarget = env.buildTarget ? env.buildTarget : ( mode === 'production' ? 'build' : 'src' );
+ buildTarget = buildTarget + '/wp-includes';
+
+ const sharedConfig = {
+ mode: 'development',
+ target: 'browserslist',
+ output: {
+ filename: `[name]${ suffix }.js`,
+ path: join( baseDir, `${ buildTarget }/js/dist/development` ),
+ },
+ };
+
+ // See https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/main/docs/TROUBLESHOOTING.md#externalising-react.
+ return [
+ {
+ ...sharedConfig,
+ name: 'react-refresh-entry',
+ entry: {
+ 'react-refresh-entry':
+ '@pmmmwh/react-refresh-webpack-plugin/client/ReactRefreshEntry.js',
+ },
+ plugins: [ new DependencyExtractionWebpackPlugin( {
+ outputFilename: '../../../assets/script-loader-[name].php',
+ } ) ],
+ },
+ {
+ ...sharedConfig,
+ name: 'react-refresh-runtime',
+ entry: {
+ 'react-refresh-runtime': {
+ import: 'react-refresh/runtime.js',
+ library: {
+ name: 'ReactRefreshRuntime',
+ type: 'window',
+ },
+ },
+ },
+ plugins: [
+ new DependencyExtractionWebpackPlugin( {
+ useDefaults: false,
+ outputFilename: '../../../assets/script-loader-[name].php'
+ } ),
+ ],
+ },
+ ];
+};
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tools/webpack/development.js
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunkwebpackconfigjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/webpack.config.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/webpack.config.js 2022-04-11 15:35:56 UTC (rev 53139)
+++ trunk/webpack.config.js 2022-04-11 16:08:12 UTC (rev 53140)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,4 +1,5 @@
</span><span class="cx" style="display: block; padding: 0 10px"> const blocksConfig = require( './tools/webpack/blocks' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+const developmentConfig = require( './tools/webpack/development' );
</ins><span class="cx" style="display: block; padding: 0 10px"> const mediaConfig = require( './tools/webpack/media' );
</span><span class="cx" style="display: block; padding: 0 10px"> const packagesConfig = require( './tools/webpack/packages' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,6 +14,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> const config = [
</span><span class="cx" style="display: block; padding: 0 10px"> blocksConfig( env ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ...developmentConfig( env ),
</ins><span class="cx" style="display: block; padding: 0 10px"> mediaConfig( env ),
</span><span class="cx" style="display: block; padding: 0 10px"> packagesConfig( env ),
</span><span class="cx" style="display: block; padding: 0 10px"> ];
</span></span></pre>
</div>
</div>
</body>
</html>