killua99/drupal-project-tweaks

Tweaked Project template for Drupal 8 projects with composer

Fork of Composer template for Drupal projects

This repository aim to add small tweaks for the Composer Template that are not require for the common of the Drupal Projects. This tweaks are especific settings that might be not interesting for the 99.99% of Drupal Projects., _(*1)

I'll keep adding the features from the original template plus adding extra tweaks., _(*2)

This project template should provide a kickstart for managing your site dependencies with Composer., _(*3)

If you want to know how to use it as replacement for Drush Make visit the Documentation on drupal.org., _(*4)

Usage

First you need to install composer., _(*5)

Note: The instructions below refer to the global composer installation. You might need to replace composer with php composer.phar (or similar) for your setup., _(*6)

I recommend to install globaly this component for composer to download parallel. hirak/prestissimo, _(*7)

After that you can create the project:, _(*8)

composer create-project killua99/drupal-project-tweaks awesome-project --no-progress --profile --prefer-dist

With composer require ... you can download new dependencies to your installation., _(*9)

cd awesome-project
composer require drupal/devel

What does the template do?

When installing the given composer.json some tasks are taken care of:, _(*10)

• Drupal will be installed in the web-directory.
• Autoloader is implemented to use the generated composer autoloader in vendor/autoload.php, instead of the one provided by Drupal (web/vendor/autoload.php).
• Modules (packages of type drupal-module) will be placed in web/modules/contrib/
• Theme (packages of type drupal-theme) will be placed in web/themes/contrib/
• Profiles (packages of type drupal-profile) will be placed in web/profiles/contrib/
• Creates default writable versions of settings.php and services.yml.
• Creates static-directory.
• Latest version of drush is installed locally for use at vendor/bin/drush.
• Latest version of DrupalConsole is installed locally for use at vendor/bin/drupal.
• Write a public_html to increase the security of Drupal see Moving to docroot I call it public_html (I think makes more sense).

Updating Drupal Core

I'm thinking how to keep it simple, for now I just run this command., _(*11)

composer update --prefer-dist -o

Generate composer.json from existing project

With using the "Composer Generate" drush extension you can now generate a basic composer.json file from an existing project. Note that the generated composer.json might differ from this project's file., _(*12)

FAQ

Should I commit the contrib modules I download

Composer recommends no. They provide argumentation against but also workrounds if a project decides to do it anyway., _(*13)

How can I apply patches to downloaded modules?

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., _(*14)

To add a patch to drupal module foobar insert the patches section in the extra section of composer.json:, _(*15)

"extra": {
    "patches": {
        "drupal/foobar": {
            "Patch description": "URL to patch"
        }
    }
}