A Composer tool to show unused Composer dependencies by scanning your code.
Created by Andreas Frömer and contributors, logo by Caneco.
When working in a big repository, you sometimes lose track of your required Composer packages. There may be so many packages you can't be sure if they are actually used or not.
Unfortunately, the composer why command only gives you the information about why
a package is installed in dependency to another package.
How do we check whether the provided symbols of a package are used in our code?
composer unused to the rescue!
.phar archive or use PHIVE to install it locally.
Install via phive or grab the latest composer-unused.phar from the latest release:
phive install composer-unused --trust-gpg-keys DB82D6DEA49B570163338FA33135AA4CB4F1AB0B
curl -OL https://github.com/composer-unused/composer-unused/releases/latest/download/composer-unused.phar
You can also install composer-unused as a local development dependency:
composer require --dev icanhazstring/composer-unused
Depending on the kind of your installation the command might differ.
Note: Packages must be installed via composer install or composer update prior to running composer-unused.
The phar archive can be run directly in you project:
php composer-unused.phar
Having composer-unused as a local dependency you can run it using the shipped binary:
vendor/bin/composer-unused
Sometimes you don't want to scan a certain directory or ignore a Composer package while scanning.
In these cases, you can provide the --excludeDir or the --excludePackage option.
These options accept multiple values as shown next:
php composer-unused.phar --excludeDir=config --excludePackage=symfony/console
php composer-unused.phar \
--excludeDir=bin \
--excludeDir=config \
--excludePackage=symfony/assets \
--excludePackage=symfony/console
Make sure the package is named exactly as in your
composer.json
You can configure composer-unused by placing a composer-unused.php beside the projects composer.json
This configuration can look something like this: composer-unused.php
To ignore dependencies by their name, add the following line to your configuration:
$config->addNamedFilter(NamedFilter::fromString('dependency/name'));
To ignore dependencies by pattern, add the following line to your configuration
$config->addPatternFilter(PatternFilter::fromString('/dependency\/name/'));
You can ignore multiple dependencies by a single organization using
PatternFiltere.g./symfony\/.*/
Per default, composer-unused is using the composer.json autoload directive to determine where to look for files to parse.
Sometimes dependencies don't have their composer.json correctly set up, or files get loaded in another way.
Using this, you can define additional files on a per-dependency basis.
$config->setAdditionalFilesFor('dependency/name', [<list-of-file-paths>]);
Please have a look at CHANGELOG.md.
Please have a look at CONTRIBUTING.md.
Please have a look at CODE_OF_CONDUCT.md.
This package is licensed under the MIT License.