composer unused

compositor não utilizado

Uma ferramenta do Composer para mostrar dependências não utilizadas do Composer, verificando seu código.

Criado por Andreas Frömer e colaboradores, logotipo da Caneco.

Se você quiser usar esta ferramenta como plugin do compositor, vá para o plugin do compositor não utilizado.

Motivação

Ao trabalhar em um grande repositório, às vezes você perde o controle dos pacotes necessários do Composer. Pode haver tantos pacotes que você não tem certeza se eles são realmente usados ​​ou não.

Infelizmente, o comando composer why apenas fornece informações sobre por que um pacote é instalado na dependência de outro pacote.

Como verificamos se os símbolos fornecidos de um pacote são usados ​​em nosso código?

composer unused ao resgate!

Instalação

Esta ferramenta depende fortemente de certas versões de suas dependências. A instalação local desta ferramenta não é recomendada , pois ela pode não funcionar conforme o esperado ou não ser instalada corretamente. Recomendamos que você baixe o arquivo .phar ou use o PHIVE para instalá-lo localmente.

PHAR (arquivo PHP) (recomendado)

Instale via phive ou obtenha o composer-unused.phar mais recente da versão mais recente:

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

Local

Você também pode instalar composer-unused como uma dependência de desenvolvimento local:

composer require --dev icanhazstring/composer-unused

Uso

Dependendo do tipo de instalação, o comando pode ser diferente.

Nota: Os pacotes devem ser instalados por meio da composer install ou composer update antes da execução composer-unused .

PHAR

O arquivo phar pode ser executado diretamente no seu projeto:

php composer-unused.phar

Local

Tendo composer-unused como dependência local, você pode executá-lo usando o binário enviado:

vendor/bin/composer-unused

Excluir pastas e pacotes

Às vezes você não deseja verificar um determinado diretório ou ignorar um pacote do Composer durante a verificação. Nesses casos, você pode fornecer a opção --excludeDir ou --excludePackage . Essas opções aceitam vários valores, conforme mostrado a seguir:

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

Certifique-se de que o pacote tenha o nome exatamente como em seu composer.json

Configuração

Você pode configurar o compositor-não utilizado colocando um composer-unused.php ao lado dos projetos composer.json Esta configuração pode ser semelhante a esta: compositor-unused.php

Ignorar dependências por nome

Para ignorar as dependências pelo nome, adicione a seguinte linha à sua configuração:

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

Ignorar dependências por padrão

Para ignorar dependências por padrão, adicione a seguinte linha à sua configuração

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

Você pode ignorar múltiplas dependências de uma única organização usando PatternFilter por exemplo, /symfony/.*/

Arquivos adicionais a serem analisados

Por padrão, composer-unused está usando a diretiva autoload composer.json para determinar onde procurar arquivos para analisar. Às vezes, as dependências não têm seu compositor.json configurado corretamente ou os arquivos são carregados de outra maneira. Usando isso, você pode definir arquivos adicionais por dependência.

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

Registro de alterações

Por favor, dê uma olhada em CHANGELOG.md .

Contribuindo

Por favor, dê uma olhada em CONTRIBUTING.md .

Código de Conduta

Por favor, dê uma olhada em CODE_OF_CONDUCT.md .

Licença

Este pacote está licenciado sob a licença MIT.