Improved codesniffer support.

Author: codebymikey

.ddev/commands/web/phpcbf

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+## Description: Run PHP_CodeSniffer's code beautifier
+## Usage: phpcbf [flags] [args]
+## Example: "ddev phpcbf --standard=core/phpcs.xml.dist index.php" or "ddev phpcbf index.php"
+## HostWorkingDir: true
+## ExecRaw: true
+
+if ! command -v phpcbf >/dev/null; then
+  echo "phpcbf is not available. You may need to 'ddev composer require squizlabs/php_codesniffer'"
+  exit 1
+fi
+phpcbf "$@"

.ddev/commands/web/phpcs

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+## Description: Run PHP_CodeSniffer's codesniffer
+## Usage: phpcs [flags] [args]
+## Example: "ddev phpcs --standard=core/phpcs.xml.dist index.php" or "ddev phpcs index.php"
+## HostWorkingDir: true
+## ExecRaw: true
+
+if ! command -v phpcs >/dev/null; then
+  echo "phpcs is not available. You may need to 'ddev composer require squizlabs/php_codesniffer'"
+  exit 1
+fi
+phpcs "$@"

.gitpod/drupal/drupalpod-setup/drupalpod-setup.sh

@@ -83,9 +83,12 @@ if [ ! -f "${GITPOD_REPO_ROOT}"/.drupalpod_initiated ]; then
     fi
 
     time "${GITPOD_REPO_ROOT}"/.gitpod/drupal/install-essential-packages.sh
-    # Configure phpcs for drupal.
-    cd "$GITPOD_REPO_ROOT" &&
-        vendor/bin/phpcs --config-set installed_paths vendor/drupal/coder/coder_sniffer
+
+    # Configure phpcs for drupal if it's not already set up by the
+    # dealerdirect/phpcodesniffer-composer-installer composer plugin.
+    if ! ddev phpcs --config-show | \grep -q 'installed_paths:'; then
+        ddev phpcs --config-set installed_paths vendor/drupal/coder/coder_sniffer
+    fi
 
     # ddev config auto updates settings.php and generates settings.ddev.php
     ddev config --auto

.gitpod/utils/env-setup.sh

@@ -17,6 +17,15 @@ sudo cp protect-my-git.template.sh /usr/local/bin/protect-my-git
 # Create php command (run php inside ddev container)
 sudo cp ddev-php.template.sh /usr/local/bin/php
 
+# Create phpunit command (run phpunit inside ddev container)
+sudo cp ddev-phpunit.template.sh /usr/local/bin/phpunit
+
+# Create phpcs command (run phpcs inside ddev container)
+sudo cp ddev-phpcs.template.sh /usr/local/bin/phpcs
+
+# Create phpcbf command (run phpcbf inside ddev container)
+sudo cp ddev-phpcbf.template.sh /usr/local/bin/phpcbf
+
 # Create drush command (run drush inside ddev container)
 sudo cp ddev-drush.template.sh /usr/local/bin/drush
 

.gitpod/utils/script-templates/ddev-phpcbf.template.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+>&2 echo "Notice: running 'phpcbf $*' in ddev"
+
+if [ -n "${GITPOD_REPO_ROOT:-}" ]; then
+  # Replace all references to the absolute paths to the repo root.
+  # This will ensure IDEs like PHPStorm can pass files into it without issue.
+  arguments=()
+  for arg in "$@"; do
+    new_arg="${arg//${GITPOD_REPO_ROOT}//var/www/html}"
+    arguments+=("$new_arg")
+  done
+else
+  arguments=("$@")
+fi
+
+ddev exec_d phpcbf "${arguments[@]}"

.gitpod/utils/script-templates/ddev-phpcs.template.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+>&2 echo "Notice: running 'phpcs $*' in ddev"
+
+if [ -n "${GITPOD_REPO_ROOT:-}" ]; then
+  # Replace all references to the absolute paths to the repo root.
+  # This will ensure IDEs like PHPStorm can pass files into it without issue.
+  arguments=()
+  for arg in "$@"; do
+    new_arg="${arg//${GITPOD_REPO_ROOT}//var/www/html}"
+    arguments+=("$new_arg")
+  done
+else
+  arguments=("$@")
+fi
+
+ddev exec_d phpcs "${arguments[@]}"

.gitpod/utils/script-templates/ddev-phpunit.template.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+>&2 echo "Notice: running 'phpunit $*' in ddev"
+ddev exec_d phpunit "$@"