refactor: centralize DRUPAL_PROJECTS_PATH in config

- Move DRUPAL_PROJECTS_PATH to config.contrib.yaml
- Remove individual definitions from command files
- Improve documentation for theme support

Author: jameswilson

README.md

@@ -96,7 +96,11 @@ web_environment:
   - DRUPAL_PROJECTS_PATH=modules
 ```
 
-Then restart DDEV by running `ddev restart`.
+Then run `ddev restart` and then `ddev symlink-project` to update the symlink location.
+
+All [ddev-drupal-contrib commands](#commands) run against your project code in the configured symlink location.
+
+To use with Drupal themes, set `DRUPAL_PROJECTS_PATH=themes/custom` in your config.
 
 ## Example of successful test
 

commands/web/eslint

@@ -7,7 +7,6 @@
 ## Example: "ddev eslint"
 ## ExecRaw: true
 
-DRUPAL_PROJECTS_PATH=${DRUPAL_PROJECTS_PATH:-modules/custom}
 if "$DDEV_DOCROOT/core/node_modules/.bin/eslint" --version >/dev/null ; then
   # Configure prettier
   test -e .prettierrc.json || ln -s $DDEV_DOCROOT/core/.prettierrc.json .

commands/web/nightwatch

@@ -7,5 +7,4 @@
 ## Example: "ddev nightwatch"
 ## ExecRaw: true
 
-DRUPAL_PROJECTS_PATH=${DRUPAL_PROJECTS_PATH:-modules/custom}
 yarn --cwd "$DDEV_DOCROOT/core" test:nightwatch  "$DDEV_COMPOSER_ROOT/$DDEV_DOCROOT/$DRUPAL_PROJECTS_PATH/" "$@"

commands/web/phpcbf

@@ -7,7 +7,6 @@
 ## Example: "ddev phpcbf" or "ddev phpcbf -n"
 ## ExecRaw: true
 
-DRUPAL_PROJECTS_PATH=${DRUPAL_PROJECTS_PATH:-modules/custom}
 if ! command -v phpcbf >/dev/null; then
   echo "phpcbf is not available. You may need to 'ddev composer install'"
   exit 1

commands/web/phpcs

@@ -7,7 +7,6 @@
 ## Example: "ddev phpcs" or "ddev phpcs -n"
 ## ExecRaw: true
 
-DRUPAL_PROJECTS_PATH=${DRUPAL_PROJECTS_PATH:-modules/custom}
 if ! command -v phpcs >/dev/null; then
   echo "phpcs is not available. You may need to 'ddev composer install'"
   exit 1

commands/web/phpstan

@@ -7,7 +7,6 @@
 ## Example: "ddev phpstan" or "ddev phpstan -n"
 ## ExecRaw: true
 
-DRUPAL_PROJECTS_PATH=${DRUPAL_PROJECTS_PATH:-modules/custom}
 if ! command -v phpstan >/dev/null; then
   echo "phpstan is not available. You may need to 'ddev poser'"
   exit 1

commands/web/phpunit

@@ -7,7 +7,6 @@
 ## Example: "ddev phpunit" or "ddev phpunit --stop-on-failure"
 ## ExecRaw: true
 
-DRUPAL_PROJECTS_PATH=${DRUPAL_PROJECTS_PATH:-modules/custom}
 if ! command -v phpunit >/dev/null; then
   echo "phpunit is not available. You may need to 'ddev composer install'"
   exit 1

commands/web/stylelint

@@ -7,7 +7,6 @@
 ## Example: "ddev stylelint"
 ## ExecRaw: true
 
-DRUPAL_PROJECTS_PATH=${DRUPAL_PROJECTS_PATH:-modules/custom}
 if $DDEV_DOCROOT/core/node_modules/.bin/stylelint --version >/dev/null ; then
   # Change directory to the project root folder
   cd "$DDEV_DOCROOT/$DRUPAL_PROJECTS_PATH/${DDEV_SITENAME//-/_}" || exit

commands/web/symlink-project

@@ -8,7 +8,6 @@
 ## ExecRaw: true
 
 export _WEB_ROOT=$DDEV_DOCROOT
-export DRUPAL_PROJECTS_PATH=${DRUPAL_PROJECTS_PATH:-modules/custom}
 #todo use more dynamic ref.
 cd "$DDEV_COMPOSER_ROOT" || exit
 curl -OL https://git.drupalcode.org/project/gitlab_templates/-/raw/default-ref/scripts/symlink_project.php

config.contrib.yaml

@@ -1,5 +1,7 @@
 #ddev-generated
 ## Command provided by https://github.com/ddev/ddev-drupal-contrib
+## To customize this configuration, see:
+## https://ddev.readthedocs.io/en/stable/users/extend/customization-extendibility/
 web_environment:
   # To change the Drupal core version, see the README:
   # https://github.com/ddev/ddev-drupal-contrib/blob/main/README.md#changing-the-drupal-core-version
@@ -8,6 +10,8 @@ web_environment:
   - SIMPLETEST_BASE_URL=http://web
   - BROWSERTEST_OUTPUT_DIRECTORY=/tmp
   - BROWSERTEST_OUTPUT_BASE_URL=${DDEV_PRIMARY_URL}
+  # To change the symlink location, see: https://github.com/ddev/ddev-drupal-contrib/blob/main/README.md#changing-the-symlink-location
+  - DRUPAL_PROJECTS_PATH=modules/custom
 hooks:
   post-start:
     - exec-host: |