composer unused

作曲家未使用

一個 Composer 工具，透過掃描程式碼來顯示未使用的 Composer 相依性。

由 Andreas Frömer 和貢獻者創建，標誌由 Caneco 提供。

如果您想將此工具用作composer-plugin，請前往composer-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-unused之前，必須透過composer install或composer update安裝軟體套件。

PHAR

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中的名稱完全相同

配置

您可以透過在專案composer.json旁邊放置composer-unused.php來配置composer-unused此配置可能如下所示：composer-unused.php

按名稱忽略依賴項

若要按名稱忽略依賴項，請將以下行新增至您的配置：

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

按模式忽略依賴關係

若要按模式忽略依賴項，請將以下行新增至您的配置中

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

您可以使用PatternFilter忽略單一組織的多個依賴關係，例如/symfony/.*/

要解析的其他文件

預設情況下， composer-unused使用composer.json autoload 指令來決定在哪裡尋找要解析的檔案。有時，依賴項的composer.json 未正確設置，或檔案以其他方式載入。使用它，您可以根據每個依賴項定義其他檔案。

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

變更日誌

請查看CHANGELOG.md 。

貢獻

請查看CONTRIBUTING.md 。

行為守則

請查看CODE_OF_CONDUCT.md 。

執照

該軟體包根據 MIT 許可證獲得許可。