digipolisgent/drupal-copy-profile

Can be used as a development in an install profile to copy the current profile in a web directory, so it can be used similary as drupal-composer/drupal-project.

drupal-copy-profile

, _(*1)

, _(*2)

Composer plugin to assist in installation profile development. This allows the install profile to be used as if your project is like drupal-composer/drupal-project, with your project being an install profile to test and being the root project., _(*3)

Credits

This project is basically a rip-off of drupal-composer/drupal-scaffold. Thanks to the developers of that package for the inspiration., _(*4)

Usage

Run composer require --dev digipolisgent/drupal-copy-profile:dev-master in your composer project before installing or updating drupal/core., _(*5)

Once drupal-copy-profile is required by your project, it will automatically copy the install profile in the project directory to the correct profiles directory in an installed drupal site., _(*6)

You can use this easily by requiring these packages in the require-dev section of the composer.json., _(*7)

• drupal/core
• composer/installers
• drupal-composer/drupal-scaffold

You'll also have to configure the drupal-scaffold paths as follows:, _(*8)

    "extra": {
        "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/contrib/{$name}": ["type:drupal-drush"]
        },
    }

Configuration

You can configure the plugin with providing some settings in the extra section of your root composer.json., _(*9)

{
  "extra": {
    "drupal-copy-profile": {
      "excludes": [
        "scripts"
      ],
      "profile-name": "lightning",
      "web-root": "www",
      "omit-defaults": false
    }
  }
}

With the drupal-copy-profile option excludes, you can provide additional paths that should not be copied from the root project. The plugin provides these default includes:, _(*10)

web-root
vendor-path
.git

web-root is configurable through the options, but defaults to the location where drupal/core is installed. vendor-path is taken from the composer config and defaults to vendor, _(*11)

When setting omit-defaults to true, the default excludes will not be used; in this instance, only those files explicitly listed in the excludes options will be considered. If omit-defaults is false (the default), then any items listed in excludes will be in addition to the usual defaults., _(*12)

The profile-name option allows you to set the install profile name. It defaults to the project name of the root package (the second part of the package name), _(*13)

The web-root option allows you to set an alternative path to copy the profile to. It defaults to the install location of drupal/core, which should be fine., _(*14)

Custom command

The plugin by default is executed on each composer install and update. If you want to call it manually, you can add the command callback to the scripts-section of your root composer.json, like this:, _(*15)

{
  "scripts": {
    "drupal-copy-profile": "DigipolisGent\\DrupalCopyProfile\\Plugin::copyProfile"
  }
}

After that you can manually copy the profile according to your configuration by using composer drupal-scaffold., _(*16)