mbrowniebytes/yii2-clean-vendors

Clean composer vendor/ directory by removing docs, tests, gits, etc

dev-master 2017-12-21 02:57 UTC

Requires

• yiisoft/yii2: *

MIT

• composer
• clean
• yii2
• vendor

README

Yii2 command extension to clean composer's vendor/ directory

This extension removes docs, tests, gits, etc from composer's vendor/ directory

It is based on barryvdh/composer-cleanup-plugin

The format of the rules and the removal logic have been copied.

The main changes are:

• Callable as a Yii2 command
• Provides progress feedback
• Default rule added

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require mbrowniebytes/yii2-clean-vendors:dev-master

or add

"mbrowniebytes/yii2-clean-vendors": "dev-master"

to the require section of your composer.json.

Usage

To use this extension, add the following code in your application configuration (console.php):

'controllerMap' => [
    'clean-vendors' => [
        'class' => 'mbrowniebytes\yii2cleanvendors\CleanVendorsController',
    ],
],

Then call the extension from the command line

/path/yii> php yii clean-vendors
Checking vendor/ to remove docs, gits, tests, etc ..
Checking 56 vendor packages ..
Done. Scanned 25 vendor packages, cleaned 10 files/dirs

or add the extension to the composer scripts section to always clean vendors

    "scripts": {
		"post-update-cmd": [
			"php yii clean-vendors"
		]
    },

Additional arguments

-dry-run	do not delete anything
-verbose	echo rules being run, dir/file being deleted
-silent		do not echo anything