lemric/composer-cleaner

Victor The Cleaner: removes unnecessary files from vendor directory.

dev-master 2024-08-16 07:52 UTC

Requires

• php: ^8.3
• composer-plugin-api: ^2.0

Requires (Dev)

• composer/composer: ^1.10 || ^2.0
• phpstan/phpstan: ^1.11.10
• rector/rector: ^1.2.3

BSD-3-Clause

• Lemric
• David Grudl

• composer

README

This tool removes unnecessary files and directories from Composer vendor directory.

The Cleaner leaves only directories containing the source files needed to use the libraries. These are located according to the autoload section of composer.json in each installed library. Conversely for example, tests are files that are not needed for use, so they are removed.

Installation

composer require dg/composer-cleaner

Then simply run composer update or composer require ... and the Cleaner automatically removes unnecessary files when new libraries are installed.

Configuration

Some libraries also requires other files/directories, which the the Cleaner judged to be unnecessary. In this case, you can list them (specify paths to be ignored), in the configuration and the tool will keep them. Or you can specify that some libraries should not be cleaned at all.

Simply add a extra > cleaner-ignore section to composer.json file:

{
	"extra": {
		"cleaner-ignore": {
			"slevomat/eet-client": [  // name of package
				"wsdl*"               // list of files or subdirectories, you can use wildcards `*` and `?`
			],

			"mpdf/mpdf": true         // ignores whole package
		}
	}
}

Support Project

Do you like Victor The Cleaner? Are you looking forward to the new features?