Bosan dan lelah mempertahankan kualitas kode berulang kali? GrumPHP akan melakukannya untuk Anda! Plugin komposer ini akan mendaftarkan beberapa git hooks di repositori paket Anda. Ketika seseorang melakukan perubahan, GrumPHP akan menjalankan beberapa tes pada kode yang dikomit. Jika pengujian gagal, Anda tidak akan dapat melakukan perubahan. Alat praktis ini tidak hanya akan meningkatkan basis kode Anda, tetapi juga akan mengajarkan rekan kerja Anda untuk menulis kode yang lebih baik dengan mengikuti praktik terbaik yang telah Anda tentukan sebagai sebuah tim.
GrumPHP memiliki serangkaian tugas umum bawaan. Anda akan dapat menggunakan GrumPHP dengan konfigurasi minimum.
Kami tidak ingin membuat Anda bosan dengan semua detailnya, cepat saja: instal sendiri dan gunakan kekuatan GrumPHP!
Agar paket ini berfungsi, Anda harus memastikan alat berikut dapat ditemukan di baris perintah:
php
komposer
git
Paket ini adalah plugin composer dan harus diinstal ke ketergantungan dev proyek Anda menggunakan composer:
Instal GrumPHP sebagai phar tanpa ketergantungan:
komposer membutuhkan --dev phpro/grumphp-shim
Instal GrumPHP dengan dependensi:
composer require --dev phpro/grumphp
Instal GrumPHP tanpa ketergantungan dan git hook otomatis melalui phive
phive install grumphp
Ketika paket diinstal, GrumPHP akan melampirkan dirinya ke git hooks proyek Anda. Anda akan melihat pesan berikut di log komposer:
Hati-Hati! GrumPHP sedang mengendus komitmen Anda!
GrumPHP tidak akan pernah memaksa Anda untuk menggunakan tugas tertentu. Anda dapat memilih tugas yang sesuai dengan kebutuhan Anda, dan mengaktifkan atau menonaktifkan tugas apa pun dalam waktu singkat! Lihat bagian suggest
di composer.json.
Catatan: GrumPHP akan menimpa hook yang ada kecuali Anda menjalankan composer install
dengan --no-plugins
atau --no-scripts
. Kami memang membuat cadangan git hook Anda, tetapi sebaiknya pastikan Anda juga memiliki cadangan hook khusus Anda sebelum mencoba menginstal GrumPHP.
Mengalami masalah saat menginstal GrumPHP? Cari tahu caranya:
Instal secara global
Instal dengan struktur proyek yang eksotis
Beberapa hal di GrumPHP dapat dikonfigurasi dalam file grumphp.yml
atau grumphp.yml.dist
atau grumphp.dist.yml
di root proyek Anda (direktori tempat Anda menjalankan perintah grumphp). Anda dapat menentukan nama file dan lokasi konfigurasi khusus di composer.json
atau di opsi --config
pada perintah konsol.
# grumphp.ymlgrumphp:hooks_dir: ~hooks_preset: localgit_hook_variables:VAGRANT_HOST_DIR: .VAGRANT_PROJECT_DIR: /var/wwwEXEC_GRUMPHP_COMMAND: execENV: {}stop_on_failure: falseignore_unstaged_changes: falsehide_circumvention_tip: falseprocess_timeout: 60ascii:gagal: grumphp-grumpy.txtberhasil: grumphp-happy.txtparallel:enabled: truemax_workers: 32fixer:enabled: truefix_by_default: falseenvironment:files: []variabel: {}jalur: []tugas: {}testsuites: []ekstensi: []
Detail konfigurasi dipecah menjadi beberapa bagian berikut.
Parameter – Pengaturan konfigurasi untuk GrumPHP itu sendiri.
Tugas – Tugas eksternal yang melakukan validasi kode dan konfigurasinya masing-masing.
TesSuite
Ekstensi
Memperluas TaskRunner
Pemeriksa konvensi
Karena GrumPHP hanyalah alat CLI, perintah berikut dapat dijalankan:
konfigurasikan
git: init
git:deinit
git:pra-komit
git:komit-pesan
berlari
GrumPHP bekerja dengan PHP 5.6 atau lebih tinggi.
Paket ini telah diuji dengan klien git berikut:
CLI Unix
CLI Mac
CLI Windows
PhpStorm Git
Pohon Sumber Atlassian
Syntevo SmartGit
Banyak tugas telah tersedia untuk memastikan tim Anda menulis kode yang bagus. Kami selalu mencari untuk mendukung tugas-tugas baru. Jangan ragu untuk mencatat masalah atau membuat permintaan tarik untuk tugas yang kita lupa.
Apakah Anda melewatkan suatu fitur atau menemukan bug? Catatlah di pelacak masalah! Ingin membantu? Jangan ragu untuk menghubungi kami!
Pertanyaan Umum
Bug dan permintaan fitur dilacak di GitHub. Silakan lihat aturan kami sebelum menyumbangkan kode Anda.
GrumPHP dilisensikan di bawah Lisensi MIT.