How to switch from this composer template to the drupal/recommended-project template? #535

geerlingguy · 2019-12-06T19:51:49Z

If I have a site with a codebase that was originally built with this Composer project template, I would like to know what steps are required to convert the codebase into one that is like drupal/recommended-project would produce.

As an example, I noticed that this project includes drush/drush (and a number of other dependencies the core template does not). It also has a ScriptHandler.php class that is required to be present for CLI stuff to work, which is referenced in the project composer.json (core does not have this, at least not in any non-vendored location).

Is there any easy way to switch a project built with this to the 'recommended-project' template? Or is it manual picking-apart to try to get the composer.json changes matched up?

The text was updated successfully, but these errors were encountered:

laradevitt · 2019-12-08T17:06:35Z

Thank you, @geerlingguy ! I would also like to know.

XTazFR · 2019-12-08T17:43:18Z

+1
Thanks

jcnventura · 2019-12-11T10:19:29Z

Maybe I can share a diff where I did this:

diff --git a/composer.json b/composer.json
--- a/composer.json
+++ b/composer.json
@@ -19,20 +18,20 @@
-        "drupal-composer/drupal-scaffold": "^2.5",
-        "drupal/core": "^8.8.0",
+        "drupal/core-composer-scaffold": "^8.8",
+        "drupal/core-recommended": "^8.8",
@@ -47,18 +46,15 @@
-        "webflo/drupal-finder": "^1.0.0",
-        "webmozart/path-util": "^2.3",
         "zaporylie/composer-drupal-optimizations": "^1.0"
     },
     "require-dev": {
+        "drupal/core-dev": "^8.8",
-        "webflo/drupal-core-require-dev": "^8.8.0"
     },
@@ -71,49 +67,25 @@
-    "autoload": {
-        "classmap": [
-            "scripts/composer/ScriptHandler.php"
-        ],
-        "files": ["load.environment.php"]
-    },
-    "scripts": {
-        "pre-install-cmd": [
-            "DrupalProject\\composer\\ScriptHandler::checkComposerVersion"
-        ],
-        "pre-update-cmd": [
-            "DrupalProject\\composer\\ScriptHandler::checkComposerVersion"
-        ],
-        "post-install-cmd": [
-            "DrupalProject\\composer\\ScriptHandler::createRequiredFiles"
-        ],
-        "post-update-cmd": [
-            "DrupalProject\\composer\\ScriptHandler::createRequiredFiles"
-        ],
-        "post-create-project-cmd": [
-            "DrupalProject\\composer\\ScriptHandler::removeInternalFiles"
-        ]
-    },
     "extra": {
+        "drupal-scaffold": {
+            "locations": {
+                "web-root": "web/"
+            }
+        },
         "installer-paths": {
             "web/core": ["type:drupal-core"],
             "web/libraries/{$name}": ["type:drupal-library"],
             "web/modules/contrib/{$name}": ["type:drupal-module"],
             "web/profiles/contrib/{$name}": ["type:drupal-profile"],
             "web/themes/contrib/{$name}": ["type:drupal-theme"],
-            "drush/Commands/{$name}": ["type:drupal-drush"]
-        },
-        "drupal-scaffold": {
-            "initial": {
-                ".editorconfig": "../.editorconfig",
-                ".gitattributes": "../.gitattributes"
-            }
+            "drush/Commands/contrib/{$name}": ["type:drupal-drush"],
+            "web/modules/custom/{$name}": ["type:drupal-custom-module"],
+            "web/themes/custom/{$name}": ["type:drupal-custom-theme"]

Note that the above diff has been edited to remove non-related lines.

In addition to this, I deleted the scripts/composer/ScriptHandler.php file.

worthwhileindustries · 2019-12-11T20:15:45Z

is this the new "drupal" core way to do things?

chrissnyder2337 · 2019-12-12T15:29:58Z

@worthwhileindustries According to this Drupal documentation it is: https://www.drupal.org/docs/8/update/update-core-via-composer#s-special-considerations-for-upgrading-to-drupal-880-and-later

simesy · 2019-12-22T04:23:09Z

@worthwhileindustries i would think of it as "an emerging, minimalist, canonical example" and you'd stick with drupal-composer/drupal-project for a practical real-world example, at least for now.

Vacilando · 2020-02-17T22:42:18Z

https://www.drupal.org/docs/8/update/update-core-via-composer#s-special-considerations-for-upgrading-to-drupal-880-and-later provides a working, excellent recipe to move away from webflo/drupal-core-strict and start with the new drupal/core-recommended.

We need to provide an equally clear step-by-step documentation about how to migrate from drupal-composer/drupal-project to drupal/core-recommended.

gagarine · 2020-03-22T12:43:23Z

Can someone post step by step instructions? I don't know enough about the inner working of drupal-composer/drupal-project and composer to be confident.

gagarine · 2020-03-22T13:32:45Z

I did that. Do not follow blindly, you may want to keep some stuff.

Migrate from .env

Update web/sites/default/settings.php if you migrate from .env

cleanup

rm .env
rm .env.example
rm load.environment.php
rm -r drush
rm -r scripts

Update your .gitignore

Compare your .gitignores with the default one from drupal
=> in particular rm settings.php from being commited if it was

Fix composer packages

rm composer.lock

composer remove drupal-composer/drupal-scaffold --no-update
composer remove drupal/core --no-update
composer remove webflo/drupal-finder --no-update
composer remove webmozart/path-util --no-update
composer remove webflo/drupal-core-require-dev --no-update
composer remove cweagans/composer-patches --no-update
composer remove vlucas/phpdotenv --no-update
composer remove zaporylie/composer-drupal-optimizations --no-update

composer require 'composer/installers:^1.7' --no-update
composer require 'drupal/core-composer-scaffold:^8.8' --no-update

Replace extra section in composer.json

"extra": {
    "drupal-scaffold": {
        "locations": {
            "web-root": "web/"
        }
    },
    "installer-paths": {
        "web/core": ["type:drupal-core"],
        "web/libraries/{$name}": ["type:drupal-library"],
        "web/modules/contrib/{$name}": ["type:drupal-module"],
        "web/profiles/contrib/{$name}": ["type:drupal-profile"],
        "web/themes/contrib/{$name}": ["type:drupal-theme"],
        "drush/Commands/contrib/{$name}": ["type:drupal-drush"],
        "web/modules/custom/{$name}": ["type:drupal-custom-module"],
        "web/themes/custom/{$name}": ["type:drupal-custom-theme"]
    }
}

Install drupal/core-recommended

rm -r vendor
composer require drupal/core-recommended:^8.8 --update-with-dependencies

AppLEaDaY · 2023-02-26T20:10:22Z

Hi, @gagarine.
Unfortunately I could just follow you blindly, since I'm a damn newbie struggling to get out of a nightmare.

You suggested a "rm -r scripts", though I got what mentioned below.

[RuntimeException]
Could not scan for classes inside "scripts/composer/ScriptHandler.php" which does not appear to be a file nor a folder

So I supposed the directory should be left where it is, shouldn't it?

Besides, I really hope, once the recommended project is in place, migrating to drupal 9 will be easy........

Thanks for you contribution and thanks in advance for what you may answer.

Andrea

gagarine · 2023-02-27T23:13:00Z

@AppLEaDaY in your composer.json you may have something like:

"autoload": {
        "classmap": [
            "scripts/composer/ScriptHandler.php"
        ],
        "files": ["load.environment.php"]
    },

Try to delete this autoload section.

I would also delete the scripts part if you have one

   "scripts": {
        "pre-install-cmd": [
            "DrupalProject\\composer\\ScriptHandler::checkComposerVersion"
        ],
        "pre-update-cmd": [
            "DrupalProject\\composer\\ScriptHandler::checkComposerVersion"
        ],
        "post-install-cmd": [
            "DrupalProject\\composer\\ScriptHandler::createRequiredFiles"
        ],
        "post-update-cmd": [
            "DrupalProject\\composer\\ScriptHandler::createRequiredFiles"
        ]
    },

AppLEaDaY · 2023-03-12T23:16:31Z

@gagarine, thanks.

I did try, with no luck, unfortunately.

I report below the last command you suggested.

composer require drupal/core-recommended:^8.8 --update-with-dependencies

It seems this command is dependent on the cli php version, anyway I get, alternatively

Your requirements could not be resolved to an installable set of packages (I suppose with php 8.1.16 in the path)
A blank page (after I specify a php 7.2.34 before ~/bin/composer)

What did I do wrong? I'm confused.

And besides I was wondering what .gitignore you were referring to.

Anyway I came across a guide that looks encouraging.

https://drupalize.me/tutorial/update-drupal-versions-prior-88x-using-composer

What about that?

Thanks in advance!

Andrea

P.S. For the sake of completeness, I have to say the drupal-composer/drupal-project where I started didn't look in good order, since I was facing some dependency problem (I can't recall how many) even if tried to remove a module with composer. How much does this matter?

AlexSkrypnyk · 2024-05-12T22:06:46Z

This pull request/issue has been inactive for over a year and is being closed due to inactivity. If the issue still persists or the contribution is still relevant, please feel free to reopen it or create a new one.

Thank you for your understanding and your contributions to the project!

geerlingguy mentioned this issue Dec 6, 2019

Switch to official Drupal core Composer project template geerlingguy/drupal-for-kubernetes#24

Closed

cnovak mentioned this issue Dec 14, 2019

Update for Drupal 8.8.0 apigee/devportal-kickstart-project-composer#20

Closed

petercossey mentioned this issue Dec 16, 2019

Future of drupal-composer/drupal-project compared to drupal/recommended-project #538

Closed

leymannx added question Type: Documentation labels Jan 12, 2021

AlexSkrypnyk closed this as completed May 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

How to switch from this composer template to the drupal/recommended-project template? #535

How to switch from this composer template to the drupal/recommended-project template? #535

geerlingguy commented Dec 6, 2019

laradevitt commented Dec 8, 2019

XTazFR commented Dec 8, 2019

jcnventura commented Dec 11, 2019 •

edited

worthwhileindustries commented Dec 11, 2019

chrissnyder2337 commented Dec 12, 2019

simesy commented Dec 22, 2019 •

edited

Vacilando commented Feb 17, 2020

gagarine commented Mar 22, 2020

gagarine commented Mar 22, 2020 •

edited

AppLEaDaY commented Feb 26, 2023 •

edited

gagarine commented Feb 27, 2023 •

edited

AppLEaDaY commented Mar 12, 2023 •

edited

AlexSkrypnyk commented May 12, 2024

How to switch from this composer template to the drupal/recommended-project template? #535

How to switch from this composer template to the drupal/recommended-project template? #535

Comments

geerlingguy commented Dec 6, 2019

laradevitt commented Dec 8, 2019

XTazFR commented Dec 8, 2019

jcnventura commented Dec 11, 2019 • edited

worthwhileindustries commented Dec 11, 2019

chrissnyder2337 commented Dec 12, 2019

simesy commented Dec 22, 2019 • edited

Vacilando commented Feb 17, 2020

gagarine commented Mar 22, 2020

gagarine commented Mar 22, 2020 • edited

Migrate from .env

cleanup

Update your .gitignore

Fix composer packages

Replace extra section in composer.json

Install drupal/core-recommended

AppLEaDaY commented Feb 26, 2023 • edited

gagarine commented Feb 27, 2023 • edited

AppLEaDaY commented Mar 12, 2023 • edited

AlexSkrypnyk commented May 12, 2024

jcnventura commented Dec 11, 2019 •

edited

simesy commented Dec 22, 2019 •

edited

gagarine commented Mar 22, 2020 •

edited

AppLEaDaY commented Feb 26, 2023 •

edited

gagarine commented Feb 27, 2023 •

edited

AppLEaDaY commented Mar 12, 2023 •

edited