composer unused

композитор-не используется

Инструмент Composer для отображения неиспользуемых зависимостей Composer путем сканирования вашего кода.

Создано Андреасом Фрёмером и его участниками, логотип Caneco.

Если вы хотите использовать этот инструмент в качестве плагина композитора, перейдите к композитору-unused-plugin.

Мотивация

При работе с большим репозиторием вы иногда теряете необходимые пакеты Composer. Пакетов может быть так много, что вы не сможете быть уверены, действительно ли они используются или нет.

К сожалению, команда composer why дает вам только информацию о том, почему пакет установлен в зависимости от другого пакета.

Как проверить, используются ли в нашем коде предоставленные символы пакета?

composer unused к спасению!

Установка

Этот инструмент сильно зависит от определенных версий его зависимостей. Локальная установка этого инструмента не рекомендуется, так как он может работать не так, как задумано, или его невозможно будет установить правильно. Мы рекомендуем вам загрузить архив .phar или использовать PHIVE для его локальной установки.

PHAR (архив PHP) (рекомендуется)

Установите через phive или скачайте последнюю версию composer-unused.phar из последней версии:

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

Местный

Вы также можете установить composer-unused в качестве зависимости локальной разработки :

composer require --dev icanhazstring/composer-unused

Использование

В зависимости от типа вашей установки команда может отличаться.

Примечание. Пакеты необходимо установить с помощью composer install или composer update перед запуском composer-unused .

ФАР

Архив phar можно запустить непосредственно в вашем проекте:

php composer-unused.phar

Местный

Имея composer-unused в качестве локальной зависимости, вы можете запустить его, используя поставляемый двоичный файл:

vendor/bin/composer-unused

Исключить папки и пакеты

Иногда вы не хотите сканировать определенный каталог или игнорировать пакет Composer при сканировании. В этих случаях вы можете указать опцию --excludeDir или --excludePackage . Эти параметры принимают несколько значений, как показано ниже:

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

Убедитесь, что пакет назван точно так же, как в вашем composer.json

Конфигурация

Вы можете настроить композитор-unused, поместив composer-unused.php рядом с проектом composer.json Эта конфигурация может выглядеть примерно так: композитор-unused.php

Игнорировать зависимости по имени

Чтобы игнорировать зависимости по их имени, добавьте в свою конфигурацию следующую строку:

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

Игнорировать зависимости по шаблону

Чтобы игнорировать зависимости по шаблону, добавьте в свою конфигурацию следующую строку:

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

Вы можете игнорировать несколько зависимостей одной организации, используя PatternFilter , например /symfony/.*/

Дополнительные файлы для анализа

По умолчанию composer-unused использует директиву автозагрузки composer.json , чтобы определить, где искать файлы для анализа. Иногда у зависимостей неправильно настроен композитор.json или файлы загружаются другим способом. Используя это, вы можете определить дополнительные файлы для каждой зависимости.

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

Журнал изменений

Пожалуйста, посмотрите CHANGELOG.md .

Содействие

Пожалуйста, посмотрите CONTRIBUTING.md .

Нормы поведения

Пожалуйста, посмотрите CODE_OF_CONDUCT.md .

Лицензия

Этот пакет лицензируется по лицензии MIT.