Configure PHP Code Sniffer after Composer Install/Update

I've raised a Pull Request against the Packagist source repository for drupal/coder. You can see that here:

Github klausi/coder #22

I can also paste the patch here for discussion. Not sure if you're using the Drupal/CVS workflow or Git/Github workflow.

I've made some further changes to the initial patch, so refer to Github klausi/coder #22 for the up-to-date code.

I've closed that Pull Request, opting instead to use existing Composer Installer Plugins for the job. We could support use of this:

https://github.com/DealerDirect/phpcodesniffer-composer-installer

The Plugin does the configuration after install by looking for packages with the type: "phpcodesniffer-standard"

diff --git a/composer.json b/composer.json
index f80ac5a..08f54d3 100644
--- a/composer.json
+++ b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "drupal/coder",
-    "type": "library",
+    "type": "phpcodesniffer-standard",
     "description": "Coder is a library to review Drupal code.",
     "homepage": "https://www.drupal.org/project/coder",
     "support": {

Thoughts anyone? I'm using it now with this in my composer.json

  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/christopher-hopper/coder"
    },
    {
      "type": "vcs",
      "url": "https://github.com/christopher-hopper/phpcodesniffer-composer-installer"
    }
  ],
  "require": {
    "php": ">=5.4"
  },
  "require-dev": {
    "dealerdirect/phpcodesniffer-composer-installer": "dev-master",
    "drupal/coder": "dev-8.x-2.x"
  }

@klausi I managed to find a Composer Installer Plugin that does not require any change to the directory structure of Coder. It's called dealerdirect/phpcodesniffer-composer-installer and is very well supported and maintained. Works a treat.

The maintainers helped me/us out by accepting my pull request to get it working with Drupal Coder. This plugin (like any Composer Installer Plugin) requires that Coder use a Composer package type that it will recognise.

Change required

Changing the package type from "library" to "phpcodesniffer-standard" is all we'd need to do. One line in the composer.json. I'll submit a pull request for your consideration.

Changing the Composer package type for Coder should not affect users who aren't using an installer plugin.

Testing the change

Here's working examples to show how it works with the Coder package type changed. The custom repository is a clone of Drupal Coder, with the package type changed. Note the repositories additions below will not be required if the package type in Coder is changed as described above.

Project installs

To test for a project installation use a composer.json like this:

{
  "name": "example/project",
  "type": "metapackage",
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/christopher-hopper/coder"
    }
  ],
  "require": {
    "php": ">=5.4"
  },
  "require-dev": {
    "dealerdirect/phpcodesniffer-composer-installer": "dev-master",
    "drupal/coder": "dev-8.x-2.x"
  }
}

Global installs

To test the global installer follow these steps:

1. Add the following to your global Composer ~/.composer/config.json file:
   

   {
       "config": {
           "preferred-install": "dist"
       },
       "repositories": [
           {
               "type": "vcs",
               "url": "https://github.com/christopher-hopper/coder"
           }
       ]
   }
   

2. Run these Composer commands:
   

   composer global require "dealerdirect/phpcodesniffer-composer-installer:dev-master"
   composer global require "drupal/coder:dev-8.x-2.x"
   

I've opened a pull request for the required change to Drupal Coder.

klausi/coder #24

I'm now asking the dealerdirect/phpcodesniffer-composer-installer maintainers to bump a new release version so that the `dev-master` version constraint can be more like ^0.2.2 and to ensure the plugin can be used when Composer minimum stability is set to stable.

I'll provide a pull request with suggested updates to README.

See the following Pull Request for suggested updates to the README that document usage with Composer Installer Plugins.

klausi/coder #27

See the following Pull Request for suggested updates to the README that document usage with Composer Installer Plugins.

pfrenssen/coder #1