ACMS-1890: Validate new DRS plugin with BLT (#4709)

* ACMS-1890: Get settings from DRS and remove from BLT.

* ACMS-1890: Introduce migrate command for existing users.

* ACMS-1890: Alter package to allow DRS.

* ACMS-1890: Refactor overall code.

* ACMS-1890: Refractor code block.

* ACMS-1890: Updating blt_override_config_directories to drs_override_config_directories in settings file.

* ACMS-1890: PR feedback for drs config override.

* ACMS-3622: Fix logic for local settings file.

* ACMS-1890: Update Settings command to run drush command to generate settings.

* ACMS-1890: Include acquia/drupal-recommended-settings.

* ACMS-1890: Update code to replace BLT settinsg to DRS settings.

---------

Co-authored-by: Ankit Pathak <[email protected]>
Co-authored-by: Deepak Mishra <[email protected]>
Co-authored-by: Vishal Khode <[email protected]>

composer.json

@@ -24,6 +24,7 @@
         "composer-plugin-api": "^2.0",
         "composer-runtime-api": "^2.0",
         "acquia/drupal-environment-detector": "^1.5.3",
+        "acquia/drupal-recommended-settings": "^1",
         "consolidation/comments": "^1.0",
         "consolidation/config": "^2.0.0",
         "consolidation/robo": "^4",
@@ -67,7 +68,8 @@
     ],
     "config": {
         "allow-plugins": {
-            "dealerdirect/phpcodesniffer-composer-installer": true
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "acquia/drupal-recommended-settings": true
         },
         "php": "8",
         "platform": {

docs/README.md

@@ -26,6 +26,50 @@ Acquia has announced the end of life for BLT. For more details, see https://gith
 
 PHP 8.2, Drush 12, and Drupal 10 support is unstable.
 
+## Steps to use Acquia Drupal Recommended Settings with BLT.
+
+- Update the BLT plugin to the latest release, which includes acquia/drupal-recommended-settings OOTB.
+```
+composer update acquia/blt -W
+```
+
+### Manual Process:
+
+- Remove BLT reference from settings.php file located at `/docroot/sites/<site-name>/settings.php`.
+```diff
+- require DRUPAL_ROOT . "/../vendor/acquia/blt/settings/blt.settings.php";
+- /**
+-  * IMPORTANT.
+-  *
+-  * Do not include additional settings here. Instead, add them to settings
+-  * included by `blt.settings.php`. See BLT's documentation for more detail.
+-  *
+-  * @link https://docs.acquia.com/blt/
+-  */
++ require DRUPAL_ROOT . "/../vendor/acquia/drupal-recommended-settings/settings/acquia-recommended.settings.php";
++ /**
++  * IMPORTANT.
++  *
++  * Do not include additional settings here. Instead, add them to settings
++  * included by `acquia-recommended.settings.php`. See Acquia's documentation for more detail.
++  *
++  * @link https://docs.acquia.com/
++  */
+```
+
+- Update `default.local.settings.php` and `local.settings.php` to use the
+  Environment Detector provided by this DSR plugin instead of BLT:
+```diff
+- use Acquia\Blt\Robo\Common\EnvironmentDetector;
++ use Acquia\Drupal\RecommendedSettings\Helpers\EnvironmentDetector;
+```
+
+### Automated Process:
+- Use migrate command provided in BLT.
+```
+./vendor/bin/blt blt:migrate
+```
+
 # License
 
 Copyright (C) 2020 Acquia, Inc.