https://github.com/barryvdh/composer-cleanup-plugin

Composer plugin for cleaning up unused files from packages.
https://github.com/barryvdh/composer-cleanup-plugin

Last synced: 3 months ago
JSON representation

Composer plugin for cleaning up unused files from packages.

• Host: GitHub
• URL: https://github.com/barryvdh/composer-cleanup-plugin
• Owner: barryvdh
• Archived: true
• Created: 2014-08-19T11:39:57.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-03-09T07:46:22.000Z (8 months ago)
• Last Synced: 2024-07-05T06:55:22.899Z (4 months ago)
• Language: PHP
• Size: 28.3 KB
• Stars: 147
• Watchers: 7
• Forks: 32
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-composer - Composer-Cleanup-Plugin - Removes tests & documentation folders from the vendor dir. (Plugins / Support)

README

        
Composer Cleanup Plugin

=======================

Remove tests & documentation from the vendor dir. Based on [laravel-vendor-cleanup](https://github.com/barryvdh/laravel-vendor-cleanup) but implemented as a Composer Plugin instead of a Laravel command.

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 abandoned. Packages should add files they want to exclude to .gitattributes 

## Install

Require this package in your composer.json:

      "barryvdh/composer-cleanup-plugin": "0.4.x"

      

## Usage

This plugin will work automatically on any packages installed as `dist`. Therefore, if you are using it to build a package archive, simply run `composer install` with the `--prefer-dist` option.

## What does it do?

For every installed or updated package in the default list, in general:

1. Remove documentation, such as README files, docs folders, etc.

2. 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/CleanupRules.php] to add more rules for packages.

Make sure you test them first, sometimes tests dirs are classmapped and will error when deleted.

[src/CleanupRules.php]:                               ./src/CleanupRules.php