Merge pull request #1027 from xwp/release/dev-fix

Developer tooling fix and updates

Author: kasparsd

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "EditorConfig.EditorConfig",
+    "felixfbecker.php-debug",
+    "ikappas.phpcs"
+  ]
+}

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Listen for Stream XDebug",
+      "type": "php",
+      "request": "launch",
+      "port": 9000,
+      "pathMappings": {
+        "/var/www/html/wp-content/plugins/stream-src": "${workspaceRoot}",
+        "/var/www/html/wp-content/plugins/stream": "${workspaceRoot}/build",
+        "/var/www/html": "${workspaceRoot}/local/public"
+      }
+    }
+  ]
+}

contributing.md

@@ -7,7 +7,6 @@ Stream uses [npm](https://npmjs.com) for javascript dependencies, [Composer](htt
 
 Included is a local development environment built with [Docker](https://www.docker.com) which can be optionally run inside [Vagrant](https://www.vagrantup.com) for network isolation and better performance.
 
-
 ### Requirements
 
 - [VirtualBox](https://www.virtualbox.org)
@@ -22,7 +21,6 @@ We suggest using the [Homebrew package manager](https://brew.sh) on macOS to ins
 
 For setups with local Docker environment you don't need Vagrant and VirtualBox.
 
-
 ### Environment Setup
 
 1. See the [Git Flow](#git-flow) section below for how to fork the repository.
@@ -31,6 +29,13 @@ For setups with local Docker environment you don't need Vagrant and VirtualBox.
 4. Visit [stream.local](https://stream.local) and login using `admin` / `password`.
 5. Activate the Stream plugin.
 
+### PHP Xdebug
+
+The WordPress container includes the [Xdebug PHP extension](https://xdebug.org). It is configured to [autostart](https://xdebug.org/docs/remote#remote_autostart) and to [automatically detect the IP address of the connecting client](https://xdebug.org/docs/remote#remote_connect_back) running in your code editor. See [`.vscode/launch.json`](.vscode/launch.json) for the directory mapping from the WordPress container to the project directory in your code editor.
+
+### Mail Catcher
+
+We use a [MailHog](https://github.com/mailhog/MailHog) container to capture all emails sent by the WordPress container, available at [stream.local:8025](https://stream.local:8025).
 
 ### Scripts and Commands
 
@@ -153,6 +158,6 @@ Please use the [git flow for pull requests](#git-flow) and follow [WordPress Cod
    git push origin <topic-branch-name>
    ```
 
-7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) (with a clear title and description) to the `master` branch.
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) (with a clear title and description) to the `develop` branch.
 
 **IMPORTANT**: By submitting a patch, you agree to allow the project owner to license your work under the [GPL v2 license](https://www.gnu.org/licenses/gpl-2.0.html).

docker-compose.yml

@@ -21,12 +21,14 @@ services:
     ports:
       - "80:80"
       - "443:443"
+      - "9000:9000" # Xdebug
     volumes:
       - ./local/public:/var/www/html # Use host-mount to ensure correct permissions for all.
       - .:/var/www/html/wp-content/plugins/stream-src
       - ./build:/var/www/html/wp-content/plugins/stream
       - ./vendor/wordpress/wordpress/tests/phpunit:/var/www/html/tests/wordpress-phpunit
       - ./local/config/wp-tests-config.php:/var/www/html/tests/wordpress-phpunit/wp-tests-config.php
+      - ./local/docker/wordpress/php.ini:/usr/local/etc/php/php.ini
     restart: always
     environment:
       APACHE_RUN_USER: "#1000" # Ensure Apache can write to the filesystem.
@@ -43,6 +45,13 @@ services:
       MYSQL_DATABASE: "wordpress_test"
       MYSQL_ROOT_PASSWORD: ""
 
+  # Capture and display all email sent by WordPress.
+  mailhog:
+    image: mailhog/mailhog
+    ports:
+      - "1025:1025"
+      - "8025:8025"
+
 volumes:
   db_data: {}
   wp_data: {}

local/docker/wordpress/Dockerfile

@@ -6,9 +6,9 @@ ENV PATH="/var/www/html/wp-content/plugins/stream-src/vendor/bin:${PATH}"
 RUN apt-get update; \
 	apt-get install -y --no-install-recommends \
 	# WP-CLI dependencies.
-	bash less mysql-client git \
-	# Mailcatcher dependencies.
-	ssmtp;
+	bash less default-mysql-client git \
+	# MailHog dependencies.
+	msmtp;
 
 # Setup xdebug.
 RUN	pecl install xdebug; \

local/docker/wordpress/php.ini

@@ -0,0 +1,11 @@
+upload_max_filesize = 64M
+post_max_size = 64M
+
+# Forward mail to the MailHog container.
+sendmail_path = "/usr/bin/msmtp --host=mailhog --port=1025 [email protected] --read-recipients"
+
+# Enable remote Xdebug.
+xdebug.remote_enable = 1
+xdebug.remote_autostart = 1
+xdebug.remote_connect_back = 1
+xdebug.scream = 1