:rocket: Composer template for Drupal projects. Quick installation via "composer create-project drupal-composer/drupal-project"
This project template provides a starter kit for managing your site
dependencies with Composer.
First you need to install Composer.
Note: The instructions below refer to the global Composer installation.
You might need to replacecomposer
withphp composer.phar
(or similar)
for your setup.
After that you can create the project:
composer create-project drupal-composer/drupal-project:9.x-dev some-dir --no-interaction
With composer require ...
you can download new dependencies to your
installation.
cd some-dir
composer require drupal/devel
The composer create-project
command passes ownership of all files to the
project that is created. You should create a new Git repository, and commit
all files not excluded by the .gitignore
file.
When installing the given composer.json
some tasks are taken care of:
web
-directory.vendor/autoload.php
,web/vendor/autoload.php
).drupal-module
) will be placed in web/modules/contrib/
drupal-theme
) will be placed in web/themes/contrib/
drupal-profile
) will be placed in web/profiles/contrib/
settings.php
and services.yml
.web/sites/default/files
-directory.vendor/bin/drush
.vendor/bin/drupal
.This project will attempt to keep all of your Drupal Core files up-to-date; the
project drupal/core-composer-scaffold
is used to ensure that your scaffold files are updated every time drupal/core is
updated. If you customize any of the “scaffolding” files (commonly .htaccess
),
you may need to merge conflicts if any of your modified files are updated in a
new release of Drupal core.
Follow the steps below to update your core files.
composer update "drupal/core-*" --with-dependencies
to update Drupal Core and its dependencies.git diff
to determine if any of the scaffolding files have changed..htaccess
or robots.txt
.web
will remain incore
when checking out branches or running git bisect
.git merge
to combine theComposer recommends no. They provide argumentation against but also
workrounds if a project decides to do it anyway.
The Drupal Composer Scaffold
plugin can download the scaffold files (like index.php, update.php, …) to the
web/ directory of your project. If you have not customized those files you could
choose to not check them into your version control system (e.g. git). If that is
the case for your project it might be convenient to automatically run the
drupal-scaffold plugin after every install or update of your project. You can
achieve that by registering @composer drupal:scaffold
as post-install and
post-update command in your composer.json:
"scripts": {
"post-install-cmd": [
"@composer drupal:scaffold",
"..."
],
"post-update-cmd": [
"@composer drupal:scaffold",
"..."
]
},
If you need to apply patches (depending on the project being modified, a pull
request is often a better solution), you can do so with the
composer-patches plugin.
To add a patch to drupal module foobar insert the patches section in the extra
section of composer.json:
"extra": {
"patches": {
"drupal/foobar": {
"Patch description": "URL or local path to patch"
}
}
}
This project supports PHP 7.4 as minimum version (see Drupal 9.4 PHP requirements) and Drop official PHP 7.3 support in Drupal 9.4, however it’s possible that a composer update
will upgrade some package that will then require PHP 7.4+.
To prevent this you can add this code to specify the PHP version you want to use in the config
section of composer.json
:
"config": {
"sort-packages": true,
"platform": {
"php": "7.4.30"
}
},