composer unused

ผู้แต่งไม่ได้ใช้

เครื่องมือ Composer เพื่อแสดงการพึ่งพา Composer ที่ไม่ได้ใช้โดยการสแกนโค้ดของคุณ

สร้างโดย Andreas Frömer และผู้มีส่วนร่วม โลโก้โดย Caneco

หากคุณต้องการใช้เครื่องมือนี้เป็นปลั๊กอินผู้แต่ง ให้ไปที่ 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 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 ของคุณทุกประการ

การกำหนดค่า

คุณสามารถกำหนดค่า composer-unused ได้โดยวาง composer-unused.php ไว้ข้างๆ โปรเจ็กต์ composer.json การกำหนดค่านี้อาจมีลักษณะดังนี้: composer-unused.php

ละเว้นการขึ้นต่อกันตามชื่อ

หากต้องการละเว้นการขึ้นต่อกันตามชื่อ ให้เพิ่มบรรทัดต่อไปนี้ในการกำหนดค่าของคุณ:

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

ละเว้นการขึ้นต่อกันตามรูปแบบ

หากต้องการละเว้นการขึ้นต่อกันตามรูปแบบ ให้เพิ่มบรรทัดต่อไปนี้ในการกำหนดค่าของคุณ

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

คุณสามารถละเว้นการขึ้นต่อกันหลายรายการโดยองค์กรเดียวได้โดยใช้ PatternFilter เช่น /symfony/.*/

ไฟล์เพิ่มเติมที่จะแยกวิเคราะห์

ตามค่าเริ่มต้น composer-unused จะใช้คำสั่ง autoload composer.json เพื่อกำหนดตำแหน่งที่จะค้นหาไฟล์ที่จะแยกวิเคราะห์ บางครั้งการขึ้นต่อกันไม่ได้ตั้งค่า composer.json อย่างถูกต้อง หรือไฟล์ถูกโหลดด้วยวิธีอื่น เมื่อใช้สิ่งนี้ คุณสามารถกำหนดไฟล์เพิ่มเติมตามการขึ้นต่อกัน

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

บันทึกการเปลี่ยนแปลง

โปรดดูที่ CHANGELOG.md

มีส่วนร่วม

โปรดดูที่ CONTRIBUTING.md

หลักจรรยาบรรณ

โปรดดูที่ CODE_OF_CONDUCT.md

ใบอนุญาต

แพคเกจนี้ได้รับอนุญาตภายใต้ใบอนุญาต MIT