CaptainHook adalah perpustakaan git hook yang mudah digunakan dan sangat fleksibel untuk pengembang php. Ini memungkinkan Anda untuk mengonfigurasi tindakan git hook Anda dalam file json sederhana.
Anda dapat menggunakan CaptainHook untuk memvalidasi atau menyiapkan pesan penerapan Anda, memastikan kualitas kode, atau menjalankan pengujian unit sebelum Anda menerapkan atau menerapkan perubahan ke git. Anda dapat secara otomatis menghapus cache lokal atau menginstal dependensi komposer terbaru setelah melakukan perubahan terbaru.
CaptainHook memudahkan untuk berbagi hook dalam tim Anda dan bahkan dapat memastikan bahwa semua orang di tim Anda mengaktifkan hook secara lokal.
Anda dapat menjalankan perintah cli, menggunakan beberapa validator bawaan, atau menulis kelas PHP Anda sendiri yang dieksekusi oleh CaptainHook . Untuk informasi lebih lanjut lihat dokumentasi.
Metode pilihan untuk menginstal CaptainHook adalah dengan menginstal file PHAR. Anda dapat melakukannya dengan menggunakan Phive atau mengunduh PHAR dari halaman rilis GitHub.
phive instal Captainhook
Atau gunakan Komposer untuk menginstalnya.
komposer memerlukan --dev Captainhook/captainhook-phar
Jika Anda ingin mendapatkan kode sumber dengan semua dependensinya, Anda dapat menggunakan:
komposer memerlukan --dev Captainhook/captainhook
Setelah menginstal CaptainHook Anda dapat menggunakan Captainhook yang dapat dieksekusi untuk membuat konfigurasi.
konfigurasi vendor/bin/captainhook
Setelah membuat file konfigurasi Captainhook.json , Anda harus mengaktifkan hook dengan menginstalnya ke direktori .git lokal Anda. Untuk melakukannya jalankan saja perintah CaptainHook berikut.
pemasangan vendor/bin/captainhook
Silakan lihat video instalasi singkat ini.
Salah satu tujuan CaptainHook adalah memudahkan tim menggunakan git hooks yang sama. Jika Anda ingin memastikan semua orang benar-benar memasang hook, Anda dapat menggunakan plugin Composer hook-installer
kecil. Ini menjalankan perintah captainhook install
setiap kali Anda menjalankan perintah Komposer .
komposer memerlukan --dev Captainhook/hook-installer
Tentu saja rekan satu tim masih bisa berkomitmen tanpa mengeksekusi hook, itu sebabnya Anda juga harus menjalankan pemeriksaan yang sesuai di backend. Tapi setidaknya dengan cara ini tidak ada yang lupa menginstalnya "secara tidak sengaja".
Berikut ini contoh file konfigurasi Captainhook.json .
{ "commit-msg": {"enabled": true,"actions": [ {"aksi": "CaptainHookAppHookMessageActionBeams" } ] }, "pra-komit": {"enabled": true,"actions": [ {"aksi": "phpunit" }, {"aksi": "phpcs --standar=psr2 src" } ] }, "pra-push": {"enabled": false,"actions": [] } }
Jadi, Anda ingin berkontribusi pada perpustakaan CaptainHook
? Bagus sekali! Terima kasih banyak. Saya benar-benar dapat menggunakan bantuan Anda.
Lihat pedoman kontribusi.