composer unused

compositeur-inutilisé

Un outil Composer pour afficher les dépendances Composer inutilisées en analysant votre code.

Créé par Andreas Frömer et contributeurs, logo par Caneco.

Si vous souhaitez utiliser cet outil en tant que plugin-compositeur, rendez-vous sur plugin-compositeur-unused-plugin.

Motivation

Lorsque vous travaillez dans un grand référentiel, vous perdez parfois la trace de vos packages Composer requis. Il peut y avoir tellement de packages que vous ne pouvez pas être sûr s'ils sont réellement utilisés ou non.

Malheureusement, la commande composer why ne vous donne que des informations sur la raison pour laquelle un package est installé en dépendance d'un autre package.

Comment vérifier si les symboles fournis d'un package sont utilisés dans notre code ?

composer unused à la rescousse !

Installation

Cet outil dépend fortement de certaines versions de ses dépendances. Une installation locale de cet outil n'est pas recommandée car il pourrait ne pas fonctionner comme prévu ou ne pas être installé correctement. Nous vous recommandons de télécharger l'archive .phar ou d'utiliser PHIVE pour l'installer localement.

PHAR (archive PHP) (recommandé)

Installez via phive ou récupérez le dernier composer-unused.phar de la dernière version :

phive install composer-unused
curl -OL https://github.com/composer-unused/composer-unused/releases/latest/download/composer-unused.phar

Locale

Vous pouvez également installer composer-unused en tant que dépendance de développement local :

composer require --dev icanhazstring/composer-unused

Usage

Selon le type de votre installation, la commande peut différer.

Remarque : les packages doivent être installés via composer install ou composer update avant d'exécuter composer-unused .

PHAR

L'archive phar peut être exécutée directement dans votre projet :

php composer-unused.phar

Locale

Ayant composer-unused comme dépendance locale, vous pouvez l'exécuter en utilisant le binaire fourni :

vendor/bin/composer-unused

Exclure des dossiers et des packages

Parfois, vous ne souhaitez pas analyser un certain répertoire ou ignorer un package Composer lors de l'analyse. Dans ces cas, vous pouvez fournir l’option --excludeDir ou --excludePackage . Ces options acceptent plusieurs valeurs, comme indiqué ci-dessous :

php composer-unused.phar --excludeDir=config --excludePackage=symfony/console
php composer-unused.phar 
    --excludeDir=bin 
    --excludeDir=config 
    --excludePackage=symfony/assets 
    --excludePackage=symfony/console

Assurez-vous que le package est nommé exactement comme dans votre composer.json

Configuration

Vous pouvez configurer composer-unused en plaçant un composer-unused.php à côté des projets composer.json Cette configuration peut ressembler à ceci : composer-unused.php

Ignorer les dépendances par leur nom

Pour ignorer les dépendances par leur nom, ajoutez la ligne suivante à votre configuration :

$config->addNamedFilter(NamedFilter::fromString('dependency/name'));

Ignorer les dépendances par modèle

Pour ignorer les dépendances par modèle, ajoutez la ligne suivante à votre configuration

$config->addPatternFilter(PatternFilter::fromString('/dependency/name/'));

Vous pouvez ignorer plusieurs dépendances par une seule organisation en utilisant PatternFilter par exemple /symfony/.*/

Fichiers supplémentaires à analyser

Par défaut, composer-unused utilise la directive de chargement automatique composer.json pour déterminer où rechercher les fichiers à analyser. Parfois, le composer.json des dépendances n'est pas correctement configuré ou les fichiers sont chargés d'une autre manière. Grâce à cela, vous pouvez définir des fichiers supplémentaires par dépendance.

$config->setAdditionalFilesFor('dependency/name', [<list-of-file-paths>]);

Journal des modifications

Veuillez jeter un œil à CHANGELOG.md .

Contribuer

Veuillez jeter un oeil à CONTRIBUTING.md .

Code de conduite

Veuillez jeter un oeil à CODE_OF_CONDUCT.md .

Licence

Ce package est sous licence MIT.