Add an option to configure site constants (#14371)

* Add an option to configure site constants

* Remove temporary override for one of the Travis jobs added for debugging purpose

* Update CONTRIBUTING.md

* Set all flags to true by default, disable on demand

* Remove WP_DEBUG_DISPLAY override

* Enable WP_DEBUG and SCRIPT_DEBUG

.travis.yml

@@ -65,7 +65,7 @@ jobs:
         - ./bin/run-wp-unit-tests.sh
 
     - name: E2E tests (Admin with plugins) (1/2)
-      env: WP_VERSION=latest POPULAR_PLUGINS=true
+      env: WP_VERSION=latest SCRIPT_DEBUG=false POPULAR_PLUGINS=true
       install:
         - ./bin/setup-local-env.sh
       script:
@@ -74,7 +74,7 @@ jobs:
         - npm run test-e2e -- --ci --cacheDirectory="$HOME/.jest-cache" --runTestsByPath $( awk 'NR % 2 == 0' < ~/.jest-e2e-tests )
 
     - name: E2E tests (Admin with plugins) (2/2)
-      env: WP_VERSION=latest POPULAR_PLUGINS=true
+      env: WP_VERSION=latest SCRIPT_DEBUG=false POPULAR_PLUGINS=true
       install:
         - ./bin/setup-local-env.sh
       script:
@@ -83,7 +83,7 @@ jobs:
         - npm run test-e2e -- --ci --cacheDirectory="$HOME/.jest-cache" --runTestsByPath $( awk 'NR % 2 == 1' < ~/.jest-e2e-tests )
 
     - name: E2E tests (Author without plugins) (1/2)
-      env: WP_VERSION=latest E2E_ROLE=author
+      env: WP_VERSION=latest SCRIPT_DEBUG=false E2E_ROLE=author
       install:
         - ./bin/setup-local-env.sh
       script:
@@ -92,7 +92,7 @@ jobs:
         - npm run test-e2e -- --ci --cacheDirectory="$HOME/.jest-cache" --runTestsByPath $( awk 'NR % 2 == 0' < ~/.jest-e2e-tests )
 
     - name: E2E tests (Author without plugins) (2/2)
-      env: WP_VERSION=latest E2E_ROLE=author
+      env: WP_VERSION=latest SCRIPT_DEBUG=false E2E_ROLE=author
       install:
         - ./bin/setup-local-env.sh
       script:

CONTRIBUTING.md

@@ -79,6 +79,12 @@ Alternatively, you can use your own local WordPress environment and clone this r
 
 Next, open a terminal (or if on Windows, a command prompt) and navigate to the repository you cloned. Now type `npm install` to get the dependencies all set up. Then you can type `npm run dev` in your terminal or command prompt to keep the plugin building in the background as you work on it.
 
+WordPress comes with specific [debug systems](https://codex.wordpress.org/Debugging_in_WordPress) designed to simplify the process as well as standardize code across core, plugins and themes. It is possible to use environment variables (`WP_DEBUG` and `SCRIPT_DEBUG`) to update a site's configuration constants located in `wp-config.php` file. Both flags can be disabled at any time by running the following command:
+```
+SCRIPT_DEBUG=false WP_DEBUG=false ./bin/setup-local-env.sh
+```
+By default, both flags will be set to `true`.
+
 ### On A Remote Server
 
 Open a terminal (or if on Windows, a command prompt) and navigate to the repository you cloned. Now type `npm install` to get the dependencies all set up. Once that finishes, you can type `npm run build`. You can now upload the entire repository to your `wp-content/plugins` directory on your web server and activate the plugin from the WordPress admin.

bin/bootstrap-env.sh

@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 
 WP_VERSION=${WP_VERSION-latest}
+WP_DEBUG=${WP_DEBUG-true}
+SCRIPT_DEBUG=${SCRIPT_DEBUG-true}
 DOCKER=${DOCKER-false}
 DOCKER_ENV=${DOCKER_ENV-ci}
 DOCKER_COMPOSE_FILE_OPTIONS="-f docker-compose.yml"

bin/install-wordpress.sh

@@ -90,6 +90,21 @@ if [ "$CURRENT_URL" != "http://localhost:$HOST_PORT" ]; then
 	docker-compose $DOCKER_COMPOSE_FILE_OPTIONS run --rm -u 33 $CLI option update siteurl "http://localhost:$HOST_PORT" --quiet
 fi
 
+# Configure site constants.
+echo -e $(status_message "Configuring site constants...")
+WP_DEBUG_CURRENT=$(docker-compose $DOCKER_COMPOSE_FILE_OPTIONS run -T --rm -u 33 $CLI config get --type=constant --format=json WP_DEBUG)
+if [ $WP_DEBUG != $WP_DEBUG_CURRENT ]; then
+	docker-compose $DOCKER_COMPOSE_FILE_OPTIONS run --rm -u 33 $CLI config set WP_DEBUG $WP_DEBUG --raw --type=constant --quiet
+	WP_DEBUG_RESULT=$(docker-compose $DOCKER_COMPOSE_FILE_OPTIONS run -T --rm -u 33 $CLI config get --type=constant --format=json WP_DEBUG)
+	echo -e $(status_message "WP_DEBUG: $WP_DEBUG_RESULT...")
+fi
+SCRIPT_DEBUG_CURRENT=$(docker-compose $DOCKER_COMPOSE_FILE_OPTIONS run -T --rm -u 33 $CLI config get --type=constant --format=json SCRIPT_DEBUG)
+if [ $SCRIPT_DEBUG != $SCRIPT_DEBUG_CURRENT ]; then
+	docker-compose $DOCKER_COMPOSE_FILE_OPTIONS run --rm -u 33 $CLI config set SCRIPT_DEBUG $SCRIPT_DEBUG --raw --type=constant --quiet
+	SCRIPT_DEBUG_RESULT=$(docker-compose $DOCKER_COMPOSE_FILE_OPTIONS run -T --rm -u 33 $CLI config get --type=constant --format=json SCRIPT_DEBUG)
+	echo -e $(status_message "SCRIPT_DEBUG: $SCRIPT_DEBUG_RESULT...")
+fi
+
 # Activate Gutenberg.
 echo -e $(status_message "Activating Gutenberg...")
 docker-compose $DOCKER_COMPOSE_FILE_OPTIONS run --rm -u 33 $CLI plugin activate gutenberg --quiet

docker-compose.yml

@@ -9,6 +9,9 @@ services:
     environment:
       WORDPRESS_DB_PASSWORD: example
       ABSPATH: /usr/src/wordpress/
+      WORDPRESS_DEBUG: 1
+      WORDPRESS_CONFIG_EXTRA: |
+        define('SCRIPT_DEBUG', true );
     volumes:
       - wordpress:/var/www/html
       - .:/var/www/html/wp-content/plugins/gutenberg
@@ -56,6 +59,9 @@ services:
       WORDPRESS_DB_NAME: wordpress_e2e_tests
       WORDPRESS_DB_PASSWORD: example
       ABSPATH: /usr/src/wordpress/
+      WORDPRESS_DEBUG: 1
+      WORDPRESS_CONFIG_EXTRA: |
+        define('SCRIPT_DEBUG', true );
     volumes:
       - wordpress_e2e_tests:/var/www/html
       - .:/var/www/html/wp-content/plugins/gutenberg