<!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>[56699] trunk/tools/webpack: Build: Introduce SCRIPT_DEBUG global in webpack processing</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/56699">56699</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/56699","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>2023-09-26 06:49:55 +0000 (Tue, 26 Sep 2023)</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: Introduce SCRIPT_DEBUG global in webpack processing
Backports the same changes to the webpack config in the Gutenberg plugin with https://github.com/WordPress/gutenberg/pull/50122.
The `warning` function from `@wordpress/warning` no longer worked correctly with webpack 5. In practice, it no longer called `console.warn`. To fix it, the usage of `process.env.NODE_ENV` check got replaced with another optional global: `SCRIPT_DEBUG`. All the tools used in the Gutenberg, get updated to work with this new constant, including `@wordpress/scripts`. This way, developers are able to guard code that should be run only in development mode. In WordPress core, the same constant needs to be added mostly to ensure that the code behind the check gets completely removed in production mode.
Fixes <a href="https://core.trac.wordpress.org/ticket/59407">#59407</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktoolswebpackblocksjs">trunk/tools/webpack/blocks.js</a></li>
<li><a href="#trunktoolswebpackpackagesjs">trunk/tools/webpack/packages.js</a></li>
<li><a href="#trunktoolswebpacksharedjs">trunk/tools/webpack/shared.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktoolswebpackblocksjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tools/webpack/blocks.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tools/webpack/blocks.js 2023-09-26 05:02:36 UTC (rev 56698)
+++ trunk/tools/webpack/blocks.js 2023-09-26 06:49:55 UTC (rev 56699)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,7 +1,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * External dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-const { DefinePlugin } = require( 'webpack' );
</del><span class="cx" style="display: block; padding: 0 10px"> const CopyWebpackPlugin = require( 'copy-webpack-plugin' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,7 +11,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Internal dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-const { normalizeJoin, stylesTransform, baseConfig, baseDir } = require( './shared' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+const { baseDir, getBaseConfig, normalizeJoin, stylesTransform } = require( './shared' );
</ins><span class="cx" style="display: block; padding: 0 10px"> const {
</span><span class="cx" style="display: block; padding: 0 10px"> isDynamic,
</span><span class="cx" style="display: block; padding: 0 10px"> toDirectoryName,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -62,8 +61,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> noErrorOnMissing: true,
</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">+ const baseConfig = getBaseConfig( env );
</ins><span class="cx" style="display: block; padding: 0 10px"> const config = {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ...baseConfig( env ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ...baseConfig,
</ins><span class="cx" style="display: block; padding: 0 10px"> entry: {
</span><span class="cx" style="display: block; padding: 0 10px"> 'file/view': normalizeJoin(baseDir, `node_modules/@wordpress/block-library/build-module/file/view` ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'navigation/view': normalizeJoin(baseDir, `node_modules/@wordpress/block-library/build-module/navigation/view` ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,13 +76,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> path: normalizeJoin(baseDir, `${ buildTarget }/blocks` ),
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> plugins: [
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- new DefinePlugin( {
- // Inject the `IS_GUTENBERG_PLUGIN` global, used for feature flagging.
- 'process.env.IS_GUTENBERG_PLUGIN': false,
- 'process.env.FORCE_REDUCED_MOTION': JSON.stringify(
- process.env.FORCE_REDUCED_MOTION,
- ),
- } ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ...baseConfig.plugins,
</ins><span class="cx" style="display: block; padding: 0 10px"> new DependencyExtractionPlugin( {
</span><span class="cx" style="display: block; padding: 0 10px"> injectPolyfill: false,
</span><span class="cx" style="display: block; padding: 0 10px"> } ),
</span></span></pre></div>
<a id="trunktoolswebpackpackagesjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tools/webpack/packages.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tools/webpack/packages.js 2023-09-26 05:02:36 UTC (rev 56698)
+++ trunk/tools/webpack/packages.js 2023-09-26 06:49:55 UTC (rev 56699)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,7 +1,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * External dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-const { DefinePlugin } = require( 'webpack' );
</del><span class="cx" style="display: block; padding: 0 10px"> const CopyWebpackPlugin = require( 'copy-webpack-plugin' );
</span><span class="cx" style="display: block; padding: 0 10px"> const LiveReloadPlugin = require( 'webpack-livereload-plugin' );
</span><span class="cx" style="display: block; padding: 0 10px"> const UglifyJS = require( 'uglify-js' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,7 +16,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Internal dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-const { normalizeJoin, stylesTransform, baseConfig, baseDir } = require( './shared' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+const { baseDir, getBaseConfig, normalizeJoin, stylesTransform } = require( './shared' );
</ins><span class="cx" style="display: block; padding: 0 10px"> const { dependencies } = require( '../../package' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> const exportDefaultPackages = [
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -129,8 +128,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> to: normalizeJoin(baseDir, `src/${ phpFiles[ filename ] }` ),
</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">+ const baseConfig = getBaseConfig( env );
</ins><span class="cx" style="display: block; padding: 0 10px"> const config = {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ...baseConfig( env ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ...baseConfig,
</ins><span class="cx" style="display: block; padding: 0 10px"> entry: packages.reduce( ( memo, packageName ) => {
</span><span class="cx" style="display: block; padding: 0 10px"> memo[ packageName ] = {
</span><span class="cx" style="display: block; padding: 0 10px"> import: normalizeJoin(baseDir, `node_modules/@wordpress/${ packageName }` ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -151,15 +151,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> path: normalizeJoin(baseDir, `${ buildTarget }/js/dist` ),
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> plugins: [
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- new DefinePlugin( {
- // Inject the `IS_GUTENBERG_PLUGIN` global, used for feature flagging.
- 'process.env.IS_GUTENBERG_PLUGIN': false,
- // Inject the `IS_WORDPRESS_CORE` global, used for feature flagging.
- 'process.env.IS_WORDPRESS_CORE': true,
- 'process.env.FORCE_REDUCED_MOTION': JSON.stringify(
- process.env.FORCE_REDUCED_MOTION
- ),
- } ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ...baseConfig.plugins,
</ins><span class="cx" style="display: block; padding: 0 10px"> new DependencyExtractionPlugin( {
</span><span class="cx" style="display: block; padding: 0 10px"> injectPolyfill: true,
</span><span class="cx" style="display: block; padding: 0 10px"> combineAssets: true,
</span></span></pre></div>
<a id="trunktoolswebpacksharedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tools/webpack/shared.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tools/webpack/shared.js 2023-09-26 05:02:36 UTC (rev 56698)
+++ trunk/tools/webpack/shared.js 2023-09-26 06:49:55 UTC (rev 56699)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,6 +1,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * External dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+const { DefinePlugin } = require( 'webpack' );
</ins><span class="cx" style="display: block; padding: 0 10px"> const TerserPlugin = require( 'terser-webpack-plugin' );
</span><span class="cx" style="display: block; padding: 0 10px"> const postcss = require( 'postcss' );
</span><span class="cx" style="display: block; padding: 0 10px"> const { join } = require( 'path' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,7 +8,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> const baseDir = join( __dirname, '../../' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-const baseConfig = ( env ) => {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+const getBaseConfig = ( env ) => {
</ins><span class="cx" style="display: block; padding: 0 10px"> const mode = env.environment;
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -41,6 +42,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> stats: 'errors-only',
</span><span class="cx" style="display: block; padding: 0 10px"> watch: env.watch,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ plugins: [
+ new DefinePlugin( {
+ // Inject the `IS_GUTENBERG_PLUGIN` global, used for feature flagging.
+ 'process.env.IS_GUTENBERG_PLUGIN': false,
+ // Inject the `IS_WORDPRESS_CORE` global, used for feature flagging.
+ 'process.env.IS_WORDPRESS_CORE': true,
+ // Inject the `SCRIPT_DEBUG` global, used for dev versions of JavaScript.
+ SCRIPT_DEBUG: mode === 'development',
+ } ),
+ ],
</ins><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"> if ( mode === 'development' && env.buildTarget === 'build/' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,7 +90,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> module.exports = {
</span><span class="cx" style="display: block; padding: 0 10px"> baseDir,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- baseConfig,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ getBaseConfig,
</ins><span class="cx" style="display: block; padding: 0 10px"> normalizeJoin,
</span><span class="cx" style="display: block; padding: 0 10px"> stylesTransform,
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span></span></pre>
</div>
</div>
</body>
</html>