burdamagazinorg/composer-patches

Provides a way to patch Composer packages.

1.5.0 2016-03-28 18:54 UTC

Requires

• php: >=5.3.0
• composer-plugin-api: ^1.0

Requires (Dev)

• composer/composer: ~1.0
• phpunit/phpunit: ~4.6

BSD

• Cameron Eagans

README

Simple patches plugin for Composer. Applies a patch from a local or remote file to any package required with composer.

Usage

Example composer.json:

{
  "require": {
    "cweagans/composer-patches": "~1.0",
    "drupal/drupal": "8.0.*@dev"
  },
  "config": {
    "preferred-install": "source"
  },
  "extra": {
    "patches": {
      "drupal/drupal": {
        "Add startup configuration for PHP server": "https://www.drupal.org/files/issues/add_a_startup-1543858-30.patch"
      }
    }
  }
}

Using an external patch file

Instead of a patches key in your root composer.json, use a patches-file key.

{
  "require": {
    "cweagans/composer-patches": "~1.0",
    "drupal/drupal": "8.0.*@dev"
  },
  "config": {
    "preferred-install": "source"
  },
  "extra": {
    "patches-file": "local/path/to/your/composer.patches.json"
  }
}

Then your composer.patches.json should look like this:

{
  "patches": {
    "vendor/project": {
      "Patch title": "http://example.com/url/to/patch.patch"
    }
  }
}

Difference between this and netresearch/composer-patches-plugin

• This plugin is much more simple to use and maintain
• This plugin doesn't require you to specify which package version you're patching
• This plugin is easy to use with Drupal modules (which don't use semantic versioning).
• This plugin will gather patches from all dependencies and apply them as if they were in the root composer.json

Credits

A ton of this code is adapted or taken straight from https://github.com/jpstacey/composer-patcher, which is abandoned in favor of https://github.com/netresearch/composer-patches-plugin, which is (IMHO) overly complex and difficult to use.