library laravel-vendor-cleanup

barryvdh/laravel-vendor-cleanup

A vendor cleanup package, to remove tests and documentation to save space

Laravel Vendor Cleanup Command

Remove tests & documentation from the vendor dir

Stand-alone Composer plugin: https://github.com/barryvdh/composer-cleanup-plugin

Don't use this when you hava ssh access, just use composer and don't worry about size!

If possible at all, just create a distribution script or use git to deploy!

Require this package in your composer.json:, _(*1)

"barryvdh/laravel-vendor-cleanup": "1.*"

And add the ServiceProvider to the providers array in app/config/app.php, _(*2)

'Barryvdh\VendorCleanup\VendorCleanupServiceProvider',

You can now remove all the docs/tests/examples/build scripts throught artisan, _(*3)

php artisan vendor-cleanup

You should change your composer file to use the dist version, without the .git history. You can configure your composer.json to do this, and cleanup after updating:, _(*4)

"scripts":{
    "post-install-cmd": [
        "php artisan vendor-cleanup",
        "php artisan optimize"
    ],
    "post-update-cmd":[
        "php artisan vendor-cleanup",
        "php artisan optimize"
    ]
},
"config": {
    "preferred-install": "dist"
},

Note: If you switch from prefer-source (the default composer setting for non-stable packages), you should delete your vendor dir and re-download all packages, without the .git history (and greatly reducing filesize). This will also prevent questions about changed files, because packages with .git history are checked for changes., _(*5)

When distributing, _(*6)

You can add your own rules, when you publish the config file., _(*7)

'commands' => array(
   'name/package' => 'CHANGELOG* phpunit.xml* tests docs',
),

This will look for files matching CHANGELOG* or phpunit.xml* or tests or docs in vendor/name/package and delete them., _(*8)

If the package is commonly used, please make a PR to add the command to src/Barryvdh/VendorCleanup/VendorCleanupCommand.php, _(*9)

Most of the cleanup commands are based on the SensioDistributionBundle build script; https://github.com/sensio/SensioDistributionBundle/blob/master/Resources/bin/build.sh, _(*10)

License

The Laravel Vendor Cleanup Command is open-sourced software licensed under the MIT license, _(*11)