PhpCodeArcheology

PHPCODEOLOLOGI

PHPCodearcheology menganalisis proyek PHP Anda, memberikan metrik terperinci tentang file, kelas, metode, dan fungsi. Laporan HTML yang komprehensif melengkapi Anda dengan wawasan mendalam yang diperlukan untuk mengevaluasi proyek Anda.

Mengapa PHPCodeology?

PHPCodearcheology diciptakan untuk membantu pengembang mendapatkan pemahaman yang lebih dalam tentang basis kode PHP mereka dengan memberikan metrik dan wawasan terperinci. Apakah Anda memelihara sistem warisan atau mengerjakan proyek baru, alat ini bertujuan untuk memfasilitasi kualitas dan pemeliharaan kode yang lebih baik.

Prasyarat

Pastikan lingkungan Anda memenuhi persyaratan berikut:

• PHP Versi 8.2 atau lebih tinggi
• Komposer terpasang

Instalasi

Instal PHPCODECHEOLOGY Menggunakan Composer dengan menjalankan perintah berikut di terminal Anda:

 composer require --dev php-code-archeology/php-code-archeology

Awal yang cepat

Untuk memulai PHPCODECHEOLOGY, jalankan perintah berikut di Root Proyek Anda:

 ./vendor/bin/phpcodearcheology

Di luar kotak, PHPCodearcheology memindai SRC dir Anda dan membuat laporan di TMP/Report .

Untuk menyesuaikan pemindaian, seperti memasukkan atau mengecualikan folder, mendefinisikan ekstensi file PHP khusus, atau pengaturan lainnya, buat file konfigurasi php-codearch-config.yaml di root proyek Anda. Lihat file konfigurasi sampel ini untuk panduan.

Laporan

Laporan khas yang dihasilkan oleh PHPCodearcheology mencakup metrik seperti:

• File : Jumlah total file dalam proyek.
• Kesalahan File : Hitungan kesalahan yang ditemukan dalam file.
• Jumlah fungsi : Jumlah total fungsi.
• Hitungan kelas : Jumlah total kelas.
• Kelas Abstrak : Hitungan kelas abstrak.
• Jumlah antarmuka : Jumlah total antarmuka.
• Hitungan metode : Jumlah total metode, termasuk metode publik, pribadi, dan statis.
• Metode Publik : Hitungan Metode Publik.
• Metode Pribadi : Hitungan Metode Pribadi.
• Metode statis : Hitungan metode statis.
• Pernyataan Output : Hitungan panggilan gema dan printf.
• Baris Kode (LOC) : Total baris kode, termasuk komentar dan baris kosong.
• Baris logis kode (LLOC) : Total baris kode tidak termasuk komentar dan baris kosong.
• Baris Komentar Kode (CLOC) : Baris kode yang berisi komentar.
• HTML Baris Kode : Baris kode yang berisi HTML.
• Kompleksitas Cyclomatic (CC) : Ukuran kompleksitas kode.
• Indeks pemeliharaan (MI) : Indeks yang menunjukkan pemeliharaan kode.
• LCOM : Kurangnya kohesi metode di kelas.
• Ketidakstabilan : Ukuran stabilitas kelas berdasarkan ketergantungannya.
• Efferent Coupling (CE) : Jumlah kelas yang bergantung pada kelas.
• Afferent Coupling (CA) : Jumlah kelas yang bergantung pada kelas.
• Kesulitan : Ukur betapa sulitnya kode untuk dipahami.
• Upaya : Perkiraan upaya yang diperlukan untuk memahami kode.
• Kosakata : Jumlah operator dan operan unik dalam kode.
• Panjang : Jumlah total operator dan operan dalam kode.
• Volume : Ukuran kosa kata dan panjang kode.
• Berat komentar : Berat komentar dalam kode.
• Jarak dari garis utama : Ukuran seberapa abstrak dan stabil kelas.

Berikut adalah tangkapan layar sampel dari laporan HTML:

Dokumentasi

Saat ini saya sedang mengerjakan dokumentasi. Karena saya terutama menggunakan alat ini untuk proyek saya sendiri dan saya fokus pada pengembangannya yang berkelanjutan, mungkin perlu waktu untuk menyelesaikan dokumentasi yang komprehensif.

Pengarang

Marcus Kober, @mrcskbr, GitHub