Download the PHP package avto-dev/composer-cleanup-plugin without Composer
On this page you can find all versions of the php package avto-dev/composer-cleanup-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download avto-dev/composer-cleanup-plugin
More information about avto-dev/composer-cleanup-plugin
Files in avto-dev/composer-cleanup-plugin
Package composer-cleanup-plugin
Short Description A composer cleanup plugin, to remove tests and documentation to save space
License MIT
Informations about the package composer-cleanup-plugin
Composer Cleanup Plugin
Remove tests & documentation from the vendor dir. Based on barryvdh/composer-cleanup-plugin.
Usually disk size shouldn't be a problem, but when you have to use FTP to deploy or have very limited disk space, you can use this package to cut down the vendor directory by deleting files that aren't used in production (tests/docs etc).
Note: This package is still experimental, usage in production without detailed tests is not recommended.
Install
Require this package in your composer.json:
Usage
If you are using composer:v1
you need to add lines to run the clean command after each package is installed:
If you use composer:v2
then all packages are installed in parallel, so automatic cleanup occurs after all packages are installed and the event fires POST_AUTOLOAD_DUMP
.
What does it do?
For every installed or updated package in the default list, in general:
- Remove documentation, such as README files, docs folders, etc.
- Remove tests, PHPUnit configs, and other build/CI configuration.
Some packages don't obey the general rules, and remove more/less files. Packages that do not have rules added are ignored.
Adding rules
Please submit a PR to src/Rules.php to add more rules for packages. Make sure you test them first, sometimes tests dirs are classmapped and will error when deleted.
Testing
For package testing we use phpunit
framework and docker-ce
+ docker-compose
as develop environment. So, just write into your terminal after repository cloning:
Changes log
Changes log can be found here.
Support
If you will find any package errors, please, make an issue in current repository.
License
This is open-sourced software licensed under the MIT License.
All versions of composer-cleanup-plugin with dependencies
composer-plugin-api Version ^2.0