Changeset 59038

Timestamp:

09/17/2024 10:25:03 PM (3 weeks ago)

Author:

TimothyBlynJacobs

Message:

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 #52668.

Location:

trunk

Files:

• .env.example (moved) (moved from trunk/.env)
• .gitignore (modified) (1 diff)
• tools/local-env/scripts/start.js (modified) (1 diff)

trunk/.gitignore

@@ -2 +2 @@
 
 # Configuration files with possibly sensitive information
+.env
 wp-config.php
 wp-tests-config.php

trunk/tools/local-env/scripts/start.js

@@ -2 +2 @@
 const dotenvExpand = require( 'dotenv-expand' );
 const { execSync } = require( 'child_process' );
+
+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' } );
+}
+
 
 dotenvExpand.expand( dotenv.config() );