hardpixel/composer-janitor

A composer cleanup plugin, to remove tests and documentation to save space

Composer Janitor Plugin

Cleanup Composer packages to remove unneeded files and folders if you intend to keep you project dependencies in version control. The plugin removes files that belong to 4 default rule groups (docs, tests, system, wp) from all the project dependencies when you run composer install or composer-update. You can configure extra rule groups or disable default groups by adding options to the composer.json file., _(*1)

Configure

You can configure Composer Janitor Plugin by adding a cleanup key in your composer.json., _(*2)

disable : Disable default rule groups
rules : Define custom rule groups
packages : Define rules to specified packages, _(*3)

Below you can see an example configuration., _(*4)

"config": {
  "cleanup": {
    "disable": ["system"],
    "rules": {
      "custom": [
        ".git*",
        ".idea",
        ".htaccess",
        ".editorconfig",
        ".phpstorm.meta.php",
        ".php_cs",
        "*.iml",
        "composer.lock",
        "bower*"
      ]
    },
    "packages": {
      "masterminds/html5": ["sami.php", "bin"],
      "querypath/querypath": ["patches", "bin", "phar"],
      "mustache/mustache": "vendor",
      "pelago/emogrifier": "Configuration",
      "wpackagist-plugin/piklist": "add-ons",
      "wpackagist-plugin/polylang": "lingotek"
    }
  }
}