composer unused

compositor-sin usar

Una herramienta de Composer para mostrar las dependencias de Composer no utilizadas escaneando su código.

Creado por Andreas Frömer y colaboradores, logotipo de Caneco.

Si desea utilizar esta herramienta como complemento de compositor, diríjase a complemento-compositor-no utilizado.

Motivación

Cuando trabajas en un repositorio grande, a veces pierdes la pista de los paquetes de Composer necesarios. Es posible que haya tantos paquetes que no pueda estar seguro de si realmente se utilizan o no.

Desafortunadamente, el comando composer why solo le brinda información sobre por qué un paquete está instalado en dependencia de otro paquete.

¿Cómo comprobamos si los símbolos proporcionados de un paquete se utilizan en nuestro código?

composer unused al rescate!

Instalación

Esta herramienta depende en gran medida de ciertas versiones de sus dependencias. No se recomienda la instalación local de esta herramienta, ya que podría no funcionar según lo previsto o no poder instalarse correctamente. Le recomendamos que descargue el archivo .phar o use PHIVE para instalarlo localmente.

PHAR (Archivo PHP) (recomendado)

Instálelo a través de phive o obtenga el último composer-unused.phar de la última versión:

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

Local

También puedes instalar composer-unused como una dependencia de desarrollo local:

composer require --dev icanhazstring/composer-unused

Uso

Dependiendo del tipo de instalación, el comando puede diferir.

Nota: Los paquetes deben instalarse mediante composer install o composer update antes de ejecutar composer-unused .

FAR

El archivo phar se puede ejecutar directamente en su proyecto:

php composer-unused.phar

Local

Al tener composer-unused como dependencia local, puedes ejecutarlo usando el binario enviado:

vendor/bin/composer-unused

Excluir carpetas y paquetes

A veces no desea escanear un directorio determinado o ignorar un paquete de Composer mientras escanea. En estos casos, puede proporcionar la opción --excludeDir o --excludePackage . Estas opciones aceptan múltiples valores como se muestra a continuación:

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

Asegúrese de que el paquete tenga el nombre exactamente como en su composer.json

Configuración

Puede configurar el compositor no utilizado colocando un composer-unused.php al lado de los proyectos composer.json Esta configuración puede verse así: compositor-unusado.php

Ignorar dependencias por nombre

Para ignorar las dependencias por su nombre, agregue la siguiente línea a su configuración:

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

Ignorar dependencias por patrón

Para ignorar las dependencias por patrón, agregue la siguiente línea a su configuración

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

Puedes ignorar múltiples dependencias de una sola organización usando PatternFilter por ejemplo, /symfony/.*/

Archivos adicionales para analizar

De forma predeterminada, composer-unused utiliza la directiva de carga automática composer.json para determinar dónde buscar archivos para analizar. A veces, las dependencias no tienen su archivo compositor.json configurado correctamente o los archivos se cargan de otra manera. Con esto, puede definir archivos adicionales por dependencia.

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

Registro de cambios

Eche un vistazo a CHANGELOG.md .

Contribuyendo

Por favor, eche un vistazo a CONTRIBUTING.md .

Código de conducta

Eche un vistazo a CODE_OF_CONDUCT.md .

Licencia

Este paquete tiene la licencia MIT.