deptrac

Departemen

Deptrac adalah alat analisis kode statis untuk PHP yang membantu Anda berkomunikasi, memvisualisasikan, dan menerapkan keputusan arsitektur dalam proyek Anda. Anda dapat dengan bebas menentukan lapisan arsitektur berdasarkan kelas dan aturan mana yang harus diterapkan pada lapisan tersebut.

Misalnya, Anda dapat menggunakan Deptrac untuk memastikan bahwa bundel/modul/ekstensi dalam proyek Anda benar-benar independen satu sama lain agar lebih mudah digunakan kembali.

Deptrac dapat digunakan dalam pipeline CI untuk memastikan permintaan penarikan tidak melanggar aturan arsitektur apa pun yang Anda tetapkan. Dengan formatter Graphviz atau Mermaidjs opsional, Anda dapat memvisualisasikan lapisan, aturan, dan pelanggaran Anda.

Dokumentasi

Anda dapat menemukan dokumentasinya di direktori /docs atau kunjungi halaman dokumen: https://qossmic.github.io/deptrac

Memulai

Anda dapat menginstal Deptrac melalui Komposer. Kami merekomendasikan menggunakan paket deptrac untuk ini:

 composer require --dev qossmic/deptrac

Setelah Anda mengunduh/menginstal deptrac, Anda perlu membuat file konfigurasi, tempat Anda menentukan lapisan dan aturan komunikasi. File konfigurasi ini ditulis dalam YAML atau php dan, secara default, disimpan dengan nama deptrac.yaml di direktori root proyek Anda.

Deptrac dapat membuat template untuk Anda, menggunakan perintah init .

 vendor/bin/deptrac init

Ketika Anda memiliki file ini, Anda dapat menganalisis kode Anda dengan menjalankan perintah analyse :

 vendor/bin/deptrac

# which is equivalent to
vendor/bin/deptrac analyse --config-file=deptrac.yaml

Untuk menjalankan Deptrac Anda memerlukan setidaknya PHP 8.1.

Anda dapat menganalisis proyek yang memerlukan versi PHP lama selama nikic/php-parser dapat menguraikannya.

Bagaimana Berkontribusi

Lihat panduan kontribusi atau buka repositori pengembangan qossmic/deptrac-src.

Dokumentasi Lebih Lanjut

• Kompatibilitas Mundur - Informasi umum tentang cara kami melakukan pendekatan kompatibilitas mundur
• Panduan Peningkatan - Daftar perubahan yang dapat mengganggu yang perlu diatasi saat meningkatkan Deptrac ke versi baru dan cara melakukannya.
• Konsep Inti - Menjelaskan lapisan, aturan, dan pelanggaran secara lebih rinci.
• Konfigurasi - Referensi untuk semua pengaturan yang tersedia di depfile
• Kolektor - Referensi kolektor mana yang tersedia di Deptrac untuk menentukan lapisan Anda.
• Formatters - Mencantumkan format output berbeda yang didukung oleh Deptrac
• Debugging - Ikhtisar perintah debug
• Kode Etik - Standar komunitas kami
• Berkontribusi - Saran untuk berkontribusi pada perubahan kode, misalnya cara menjalankan pengujian atau cara membuat file phar dengan perubahan yang dapat Anda gunakan untuk menganalisis proyek Anda
• Panduan Keamanan - Cara melaporkan kerentanan keamanan