composer unused

komposer-tidak digunakan

Alat Komposer untuk menampilkan dependensi Komposer yang tidak digunakan dengan memindai kode Anda.

Dibuat oleh Andreas Frömer dan kontributor, logo oleh Caneco.

Jika Anda ingin menggunakan alat ini sebagai plugin komposer, buka plugin komposer yang tidak digunakan.

Motivasi

Saat bekerja di repositori besar, terkadang Anda kehilangan jejak paket Komposer yang diperlukan. Mungkin ada begitu banyak paket sehingga Anda tidak dapat memastikan apakah paket tersebut benar-benar digunakan atau tidak.

Sayangnya, perintah composer why hanya memberi Anda informasi tentang mengapa suatu paket diinstal dalam ketergantungan pada paket lain.

Bagaimana cara kami memeriksa apakah simbol paket yang disediakan digunakan dalam kode kami?

composer unused untuk menyelamatkan!

Instalasi

Alat ini sangat bergantung pada versi dependensi tertentu. Instalasi lokal alat ini tidak disarankan karena mungkin tidak berfungsi sebagaimana mestinya atau tidak dapat diinstal dengan benar. Kami menyarankan Anda mengunduh arsip .phar atau menggunakan PHIVE untuk menginstalnya secara lokal.

PHAR (Arsip PHP) (disarankan)

Instal melalui phive atau ambil composer-unused.phar terbaru dari rilis terbaru:

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

Lokal

Anda juga dapat menginstal composer-unused sebagai ketergantungan pengembangan lokal:

composer require --dev icanhazstring/composer-unused

Penggunaan

Tergantung pada jenis instalasi Anda, perintahnya mungkin berbeda.

Catatan: Paket harus diinstal melalui composer install atau composer update sebelum menjalankan composer-unused .

PHAR

Arsip phar dapat dijalankan langsung di proyek Anda:

php composer-unused.phar

Lokal

Memiliki composer-unused sebagai ketergantungan lokal, Anda dapat menjalankannya menggunakan biner yang dikirimkan:

vendor/bin/composer-unused

Kecualikan folder dan paket

Terkadang Anda tidak ingin memindai direktori tertentu atau mengabaikan paket Komposer saat memindai. Dalam kasus ini, Anda dapat memberikan opsi --excludeDir atau --excludePackage . Opsi ini menerima beberapa nilai seperti yang ditunjukkan berikutnya:

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

Pastikan paket tersebut diberi nama persis seperti di composer.json Anda

Konfigurasi

Anda dapat mengkonfigurasi composer-unused dengan menempatkan composer-unused.php di samping proyek composer.json Konfigurasi ini akan terlihat seperti ini: composer-unused.php

Abaikan dependensi berdasarkan nama

Untuk mengabaikan dependensi berdasarkan namanya, tambahkan baris berikut ke konfigurasi Anda:

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

Abaikan ketergantungan berdasarkan pola

Untuk mengabaikan ketergantungan berdasarkan pola, tambahkan baris berikut ke konfigurasi Anda

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

Anda dapat mengabaikan beberapa dependensi oleh satu organisasi menggunakan PatternFilter misalnya /symfony/.*/

File tambahan untuk diuraikan

Secara default, composer-unused menggunakan arahan autoload composer.json untuk menentukan di mana mencari file yang akan diurai. Terkadang composer.json dependensi tidak diatur dengan benar, atau file dimuat dengan cara lain. Dengan menggunakan ini, Anda dapat menentukan file tambahan berdasarkan per ketergantungan.

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

log perubahan

Silakan lihat di CHANGELOG.md .

Berkontribusi

Silakan lihat di CONTRIBUTING.md .

Kode Etik

Silakan lihat CODE_OF_CONDUCT.md .

Lisensi

Paket ini dilisensikan di bawah Lisensi MIT.