nuvoleweb/drupal-component-scaffold

Scaffolding Composer plugin for Drupal modules and themes.

0.1.0 2017-10-09 20:31 UTC

Requires

• php: >=5.6
• composer-plugin-api: ^1.0.0
• composer/installers: ^1.2
• cweagans/composer-patches: ~1.0
• drupal-composer/drupal-scaffold: ^2.3

Requires (Dev)

• composer/composer: dev-master
• drupal/coder: ^8.2
• phpro/grumphp: ^0.11.3
• phpunit/phpunit: ~5

GPL-2.0+

• Nuvole Web

README

Drupal Component Scaffold is a Composer plugin that helps Drupal 8 project maintainers enjoy leaner development workflow: working on modules and themes will be like working on any other modern PHP component.

Once installed the plugin allows to:

• Specify all project's development dependencies in require-dev, like Drupal core, modules, themes or any needed testing libraries (PHPUnit, PHPSpec, Behat, etc.). See an example here.
• Build a fully functional Drupal site right within the project directory by bundling all listed dependencies by just running composer install.
• Have the same setup on both local development and continuous integration pipelines. This also leads to cleaner CI configuration files.

The plugin leverages the excellent Drupal Scaffold project and fires only after (and if) its main scaffolding tasks are ran.

Usage

Require it via Composer as follow:

$ composer require nuvoleweb/drupal-component-scaffold --dev

List all your dependencies (core version, modules, etc.) and run:

$ composer update

For example, take the following composer.json:

{
  "name": "drupal/my_module",
  "type": "drupal-module",
  "require": {
    "drupal/ds": "~3"
  },
  "require-dev": {
    "nuvoleweb/drupal-component-scaffold": "*",
    "drush/drush": "~8.0",
    "drupal/core": "~8",
    "drupal/panels": "~4",
  },
  "repositories": [
    {
      "type": "composer",
      "url": "https://packages.drupal.org/8"
    }
  ],
  "extra": {
    "installer-paths": {
      "web/core": ["type:drupal-core"],
      "web/modules/contrib/{$name}": ["type:drupal-module"]
    }
  }  
}

Running composer install will result in:

.
├── web
│   ├── autoload.php
│   ├── core
│   ├── modules
│   │   ├── contrib
│   │   │    └── panels
│   │   └── custom
│   │       └── my_module (symlink to project root)
│   └── sites
│       ├── default
│       │   ├── default.services.yml
│       │   ├── default.settings.php
│       │   ├── drushrc.php
│       │   └── settings.local.php
│       ├── development.services.yml
│       ├── example.settings.local.php
│       └── example.sites.php
├── vendor
├── composer.json
├── composer.lock
├── my_module.info.yml
└── my_module.module

Configuration

Build directory will be derived by the installer-paths, make sure you specify there where you wish to install your core, modules etc:

{
  "extra": {
    "installer-paths": {
      "web/core": ["type:drupal-core"],
      "web/modules/contrib/{$name}": ["type:drupal-module"]
    }
  }
}

Also, all options for Drupal Scaffold still apply, check the project's documentation for more.

Component scaffolding can be triggered at any time by running:

$ composer drupal-component-scaffold

Setup PHPUnit tests

To setup PHPUnit use the following phpunit.xml.dist template:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php" backupGlobals="true" colors="true" >
  <php>
    <ini name="error_reporting" value="32767"/>
    <var name="namespaces" value=""/>
    <ini name="memory_limit" value="-1"/>
    <env name="SIMPLETEST_DB" value="mysql://user:pass@host/database"/>
  </php>
  <testsuites>
    <testsuite>
      <directory>./tests/</directory>
    </testsuite>
  </testsuites>
</phpunit>

This will ensure that both Unit and Kernel tests tests will ran correctly. See an example here.

Inner workings

When fired the plugin will:

• Setup Composer Installers paths.
• Register a post-Drupal Scaffold event handler.

After Drupal Scaffold is done the plugin will:

• Prepare a custom projects directory at ./web/modules/custom.
• Make ./web/sites/default writable.
• Symlink your project at ./web/modules/custom/my_module (or at ./web/themes/custom/my_theme).
• Setup default Drush configuration file at ./web/sites/default/drushrc.php.
• Make sure that Twig cache is disabled on ./web/sites/development.services.yml.
• Setup local development settings at ./web/sites/default/settings.local.php.
• Patch Drupal core with kernel-test-base.patch allowing Kernel tests to run smoothly.

Note: the local development settings file above is disabled by default, to enable it un-comment the related lines in your settings.php file and clear the cache.