<!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>[59038] trunk: Build Tools: Allow easier customization of the .env file.</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/59038">59038</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/59038","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-09-17 22:25:03 +0000 (Tue, 17 Sep 2024)</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 Tools: Allow easier customization of the .env file.
The .env file allows for configuring how the WordPress Local environment should be configured. However, because the file is version controlled, developers must be careful not to commit their modifications.
This commit renames the .env file to be .env.example. During env start, the .env.example file is copied to .env if it does not exist. This allows for contributors to continue using the project without thinking about .env and to make changes when needed. This brings WordPress Core into the dotenv project guidelines.
Props johnbillion, afragen, h71, desrosj.
Fixes <a href="https://core.trac.wordpress.org/ticket/52668">#52668</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgitignore">trunk/.gitignore</a></li>
<li><a href="#trunktoolslocalenvscriptsstartjs">trunk/tools/local-env/scripts/start.js</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkenvexample">trunk/.env.example</a></li>
</ul>
<h3>Removed Paths</h3>
<ul>
<li><a href="#trunkenv">trunk/.env</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkenv"></a>
<div class="delfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Deleted: trunk/.env</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.env 2024-09-17 22:24:43 UTC (rev 59037)
+++ trunk/.env 2024-09-17 22:25:03 UTC (rev 59038)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,69 +0,0 @@
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-##
-# Default configuration options for the local dev environment.
-#
-# All of these options can be overridden by setting them as environment variables before starting
-# the environment. You will need to restart your environment when changing any of these.
-#
-# Below, the following substitutions can be made:
-# - '{version}': any major.minor PHP version from 5.2 onwards.
-##
-
-# The site will be available at http://localhost:LOCAL_PORT
-LOCAL_PORT=8889
-
-# Where to run WordPress from. Valid options are 'src' and 'build'.
-LOCAL_DIR=src
-
-# The PHP version to use. Valid options are 'latest', and '{version}-fpm'.
-LOCAL_PHP=latest
-
-# Whether or not to enable Xdebug.
-LOCAL_PHP_XDEBUG=false
-
-##
-# The Xdebug features to enable.
-#
-# By default, the following features are enabled in the local environment:
-# - Development helpers (`develop`).
-# - Step debugging (`debug`).
-#
-# To generate a code coverage report, `coverage` mode must be active.
-#
-# For a full list of accepted values, see https://xdebug.org/docs/all_settings#mode.
-##
-LOCAL_PHP_XDEBUG_MODE=develop,debug
-
-# Whether or not to enable Memcached.
-LOCAL_PHP_MEMCACHED=false
-
-##
-# The database software to use.
-#
-# Supported values are `mysql` and `mariadb`.
-##
-LOCAL_DB_TYPE=mysql
-
-##
-# The database version to use.
-#
-# Defaults to 8.0 with the assumption that LOCAL_DB_TYPE is set to `mysql` above.
-#
-# When using `mysql`, see https://hub.docker.com/_/mysql for valid versions.
-# When using `mariadb`, see https://hub.docker.com/_/mariadb for valid versions.
-##
-LOCAL_DB_VERSION=8.0
-
-# Whether or not to enable multisite.
-LOCAL_MULTISITE=false
-
-# The debug settings to add to `wp-config.php`.
-LOCAL_WP_DEBUG=true
-LOCAL_WP_DEBUG_LOG=true
-LOCAL_WP_DEBUG_DISPLAY=true
-LOCAL_SCRIPT_DEBUG=true
-LOCAL_WP_ENVIRONMENT_TYPE=local
-LOCAL_WP_DEVELOPMENT_MODE=core
-LOCAL_WP_TESTS_DOMAIN=example.org
-
-# The URL to use when running e2e tests.
-WP_BASE_URL=http://localhost:${LOCAL_PORT}
</del></span></pre></div>
<a id="trunkenvexamplefromrev59037trunkenv"></a>
<div class="copfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Copied: trunk/.env.example (from rev 59037, trunk/.env)</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.env.example (rev 0)
+++ trunk/.env.example 2024-09-17 22:25:03 UTC (rev 59038)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,69 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+##
+# Default configuration options for the local dev environment.
+#
+# All of these options can be overridden by setting them as environment variables before starting
+# the environment. You will need to restart your environment when changing any of these.
+#
+# Below, the following substitutions can be made:
+# - '{version}': any major.minor PHP version from 5.2 onwards.
+##
+
+# The site will be available at http://localhost:LOCAL_PORT
+LOCAL_PORT=8889
+
+# Where to run WordPress from. Valid options are 'src' and 'build'.
+LOCAL_DIR=src
+
+# The PHP version to use. Valid options are 'latest', and '{version}-fpm'.
+LOCAL_PHP=latest
+
+# Whether or not to enable Xdebug.
+LOCAL_PHP_XDEBUG=false
+
+##
+# The Xdebug features to enable.
+#
+# By default, the following features are enabled in the local environment:
+# - Development helpers (`develop`).
+# - Step debugging (`debug`).
+#
+# To generate a code coverage report, `coverage` mode must be active.
+#
+# For a full list of accepted values, see https://xdebug.org/docs/all_settings#mode.
+##
+LOCAL_PHP_XDEBUG_MODE=develop,debug
+
+# Whether or not to enable Memcached.
+LOCAL_PHP_MEMCACHED=false
+
+##
+# The database software to use.
+#
+# Supported values are `mysql` and `mariadb`.
+##
+LOCAL_DB_TYPE=mysql
+
+##
+# The database version to use.
+#
+# Defaults to 8.0 with the assumption that LOCAL_DB_TYPE is set to `mysql` above.
+#
+# When using `mysql`, see https://hub.docker.com/_/mysql for valid versions.
+# When using `mariadb`, see https://hub.docker.com/_/mariadb for valid versions.
+##
+LOCAL_DB_VERSION=8.0
+
+# Whether or not to enable multisite.
+LOCAL_MULTISITE=false
+
+# The debug settings to add to `wp-config.php`.
+LOCAL_WP_DEBUG=true
+LOCAL_WP_DEBUG_LOG=true
+LOCAL_WP_DEBUG_DISPLAY=true
+LOCAL_SCRIPT_DEBUG=true
+LOCAL_WP_ENVIRONMENT_TYPE=local
+LOCAL_WP_DEVELOPMENT_MODE=core
+LOCAL_WP_TESTS_DOMAIN=example.org
+
+# The URL to use when running e2e tests.
+WP_BASE_URL=http://localhost:${LOCAL_PORT}
</ins></span></pre></div>
<a id="trunkgitignore"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.gitignore</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.gitignore 2024-09-17 22:24:43 UTC (rev 59037)
+++ trunk/.gitignore 2024-09-17 22:25:03 UTC (rev 59038)
</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"> # gitignore file for WordPress Core
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> # Configuration files with possibly sensitive information
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.env
</ins><span class="cx" style="display: block; padding: 0 10px"> wp-config.php
</span><span class="cx" style="display: block; padding: 0 10px"> wp-tests-config.php
</span><span class="cx" style="display: block; padding: 0 10px"> .htaccess
</span></span></pre></div>
<a id="trunktoolslocalenvscriptsstartjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tools/local-env/scripts/start.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tools/local-env/scripts/start.js 2024-09-17 22:24:43 UTC (rev 59037)
+++ trunk/tools/local-env/scripts/start.js 2024-09-17 22:25:03 UTC (rev 59038)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,6 +2,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> const dotenvExpand = require( 'dotenv-expand' );
</span><span class="cx" style="display: block; padding: 0 10px"> const { execSync } = require( 'child_process' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+try {
+ execSync( 'test -f .env', { stdio: 'inherit' } );
+} catch ( e ) {
+ // test exits with a status code of 1 if the test fails.
+ // Alert the user on any other failure.
+ if ( e.status !== 1 ) {
+ throw e;
+ }
+
+ // The file does not exist, copy over the default example file.
+ execSync( 'cp .env.example .env', { stdio: 'inherit' } );
+}
+
+
</ins><span class="cx" style="display: block; padding: 0 10px"> dotenvExpand.expand( dotenv.config() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Check if the Docker service is running.
</span></span></pre>
</div>
</div>
</body>
</html>