composer-plugin composer-ignore-plugin

light/composer-ignore-plugin

ignore files by yourself

Composer Ignore Plugin

This plugin help us to remove the unused file or directories in vendor., _(*1)

Installation

Both global or local install can work well., _(*2)

1.Install globally, so every project can use the plugin., _(*3)

$ composer global require "light/composer-ignore-plugin:~2.0"

2.Install locally, _(*4)

$ composer require "light/composer-ignore-plugin:~2.0" --dev

Usage

Define the ignore file or directory in composer.json, for example:, _(*5)

Before:, _(*6)

fzaninotto/faker/
├── CHANGELOG.md
├── composer.json
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── phpunit.xml.dist
├── readme.md
├── src
└── test

Configuration in composer.json:, _(*7)

{
    "extra": {
        "light-ignore-plugin": {
          "fzaninotto/faker": [
            "test", 
            "*.md", 
            "LICENSE",
            "Makefile",
            "phpunit.xml.dist"
          ]
        }
    }
}

After executed composer install, composer update, composer dump-autoload, The files will be removed., _(*8)

When execute the composer install or composer update will finally trigger the autoload dump event, _(*9)

After:, _(*10)

fzaninotto/faker/
├── composer.json
└── src

Why this?

Thanks to open source, there are many useful packages helped us., _(*11)

Generally, some files or folder in the installed package is useless, and when deploy to production system, reduce the files can make deploy clean., _(*12)

Of cause, a lot of package had done this by add .gitattributes file, But also not all, fzaninotto/faker for example., _(*13)

LICENSE

MIT, _(*14)