Changeset 44359 for trunk/src/index.php

Timestamp:

12/24/2018 01:28:22 PM (6 years ago)

Author:

atimmer

Message:

Build tools: Allow building WordPress to src.

After the JavaScript reorganization in [43309], it was no longer possible to test WordPress from the src folder. That meant a build step was required to test PHP modifications. That is suboptimal as even a simple copy is slower than a web server just serving the new file.

We achieve building to src by setting a WORKING_DIR constant in the Gruntfile that is build by default, but changes to src when the --dev flag is present on any Grunt command. We provide sensible defaults so some commands, such as copying version.php, always build to build.

Because testing from build is no longer required, we change the messages present in index.php and wp-admin/index.php to be more broadly about building WordPress.

We also change the webpack config to have more straightforward behavior based on the buildTarget argument. It only determines the build target now and has no implicit behavior anymore. grunt build still works as it worked before, to make sure that the build server produces the same wordpress.zip we are used to.

We do all this instead of a symlink setup because symlinks don't work on every platform.

Props omarreiss, netweb, flixos90, SergeyBiryukov.
Fixes #44492.

File:

• trunk/src/index.php (modified) (3 diffs)

trunk/src/index.php

@@ -2 +2 @@
 
 /**
- * Note: this file exists only to remind developers to run WordPress from the
- * build directory. For the real index.php that gets built and boots WordPress,
+ * Note: this file exists only to remind developers to build the assets.
+ * For the real index.php that gets built and boots WordPress,
  * please refer to _index.php.
  */
@@ -10 +10 @@
 if ( ! defined( 'ABSPATH' ) ) {
     define( 'ABSPATH', dirname( __FILE__ ) . '/' );
+}
+
+if ( file_exists( ABSPATH . 'wp-includes/js/dist/edit-post.js' ) ) {
+    require_once ABSPATH . '/_index.php';
+    return;
 }
 
@@ -27 +32 @@
 // Die with an error message
 $die = sprintf(
-    /* translators: %1$s: WordPress, %2$s: src, %3$s: build */
-    __( 'You seem to be running %1$s from the %2$s directory. %1$s needs to be built and run from the %3$s directory before we can get started.' ),
-    'WordPress',
-    '<code>src</code>',
-    '<code>build</code>'
-) . '</p>';
-$die .= '<p>' . sprintf(
-    /* translators: %s: WordPress */
-    __( 'You can build %s by running:' ),
+    /* translators: %1$s: WordPress */
+    __( 'You are running %1$s without JavaScript and CSS files. These need to be built.' ),
     'WordPress'
 ) . '</p>';
-$die .= '<p><code>npm install && grunt build</code></p>';
+
+$die .= '<p>' . __( 'Before running any grunt tasks you need to make sure the dependencies are installed. You can install these by running ');
+$die .= '<code style="color: green;">npm install</code>.</p>';
+
+$die .= '<ul>';
+$die .= '<li>' . sprintf(
+    /* translators: %s: WordPress */
+        __( 'To build %s while developing run:' ),
+        'WordPress'
+    ) . '<br /><br />';
+$die .= '<code style="color: green;">grunt build --dev</code></li>';
+$die .= '<li>' . sprintf(
+        __( 'To build files automatically when changing the source files run:' ),
+        'WordPress'
+    ) . '<br /><br />';
+$die .= '<code style="color: green;">grunt watch</code></li>';
+$die .= '<li>' . sprintf(
+        __( 'To create a production build of %s run:' ),
+        'WordPress'
+    ) . '<br /><br />';
+$die .= '<code style="color: green;">grunt build</code></li>';
+$die .= '</ul>';
+
+
 $die .= '<p>' . sprintf(
     /* translators: %1$s: NPM URL, %2$s: Grunt URL */