Unduh githooks - Unduh Kode Sumber githooks

githooks

Kategori lainnya

2.6.0

Unduh

1. Wtyd/Githooks

Adalah banyak alat lain dan plugin komposer untuk mengelola kait git. Tapi Githooks menawarkan:

Aplikasi mandiri. Githooks adalah biner (.phar) sehingga ketergantungannya tidak mengganggu dependensi aplikasi Anda.
Dikelola dengan komposer. Anda tidak memerlukan alat lain seperti pulma atau orang lain.
Crentralizes semua konfigurasi alat QA (setidaknya semua alat yang didukung).
Ini mengabstraksi pengembang dari bagaimana alat QA harus dieksekusi dengan hanya menggunakan perintah githooks tool name-of-the-tool .
Anda juga dapat membuat skrip Anda sendiri dan mengkonfigurasi kait git apa pun.

Lebih lanjut, dapat digunakan bersama dengan alat validasi JavaScript seperti Typicode/Husky jika Anda memiliki proyek hibrida.

2. Persyaratan

PHP> = 7.1
Alat yang Anda butuhkan untuk memeriksa kode.
Atau skrip Anda sendiri untuk kait.

3. Instal

1. Githooks harus diinstal seperti persyaratan dev dengan komposer:

composer require --dev wtyd/githooks

CATATAN: Untuk PHP <8.1 Anda harus menambahkan acara post-update-cmd berikutnya ke bagian scripts di composer.json Anda.json:

 "scripts" : {
    "post-update-cmd" : [
      " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions "
    ]
}

Kemudian jalankan composer update wtyd/githooks .

Sampai versi 2.3.0 Metode yang digunakan adalah Php72orminorupdate tetapi telah sudah usang dan akan dihapus dari versi 3.0.0

Juga nyaman untuk menambahkannya ke acara post-install-cm sehingga pengembang proyek lainnya tidak memiliki masalah dengan build

 "scripts" : {
    "post-update-cmd" : " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions " ,
    "post-install-cmd" : " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions "
}

2. Pasang semua alat yang didukung yang diperlukan. Bagaimana Anda menginstal alat tidak masalah.

3. Inisialisasi Githooks dengan `githooks conf:init` . Perintah ini membuat file konfigurasi di jalur root ( `githooks.yml` ).

4. Jalankan `githooks hook` . Ini menyalin skrip untuk meluncurkan githooks pada acara pra-komit di direktori `.git/hooks` . Anda dapat, juga menjalankan `githooks hook otherHook MyScriptFile.php` untuk mengatur kait apa pun dengan skrip khusus. Lihat wiki untuk informasi lebih lanjut.

Untuk memastikan bahwa itu dikonfigurasi secara otomatis, kami dapat mengonfigurasi perintah di acara post-update-cmd dan post-install-cmd dari file composer.json (bagian scripts ):

 "scripts" : {
    "post-update-cmd" : [
    " vendor/bin/githooks hook " // or "vendor/bin/githooks hook pre-commit MyScriptFile.php"
    ],
    "post-install-cmd" : [
    " vendor/bin/githooks hook "
    ]
}

5. Atur file konfigurasi.

4. Penggunaan

Saat Anda berkomitmen, semua alat pemeriksaan kode yang dikonfigurasi secara otomatis diluncurkan. Jika kode Anda melewati semua cek, Githooks memungkinkan Anda untuk berkomitmen. Jika tidak, Anda harus memperbaiki kode dan mencoba lagi:

Anda juga dapat menjalankan Githooks kapan pun Anda mau. Semua alat pada waktu yang sama atau satu per satu:

githooks tool all # Run all tools
githooks tool phpcs # Run only phpcs

5. Alat yang Didukung

Pada saat ini, alat yang didukung adalah:

PHP CodeSniffer (PHPCS dan PHPCBF)
Detektor Paste Copy PHP
Detektor PHP Mess
Paralel-lint
PHP Stan
Pemeriksa Keamanan PHP lokal

Tetapi Anda dapat mengatur skrip Anda sendiri pada kait git apa pun.

6. Atur file konfigurasi

File githooks.yml terpisah pada tiga bagian:

6.1. Opsi

6.1.1. Eksekusi

Bendera execution menandai bagaimana Githooks akan berjalan:

full (Opsi Default): mengeksekusi selalu semua alat diselesaikan dengan semua jalur diselesaikan untuk setiap alat. Misalnya, Anda menetapkan PHPC untuk dijalankan di direktori src dan app . Commit hanya berisi file yang dimodifikasi dari database Directory. PHPC akan memeriksa direktori src dan app bahkan jika tidak ada file di direktori ini telah dimodifikasi.
fast : Opsi ini menjalankan alat hanya terhadap file yang dimodifikasi oleh Commit.
- Opsi ini hanya mempengaruhi alat-alat berikut: PHPCS, PHPMD, PHPSTAN, dan LINT paralel. Alat lainnya akan berjalan sebagai opsi penuh.
- PERINGATAN!!! Anda harus mengatur alat yang tidak termasuk dalam githooks.yml atau dalam file konfigurasi alat Eath karena opsi ini menimpa paths kunci alat sehingga mereka dieksekusi hanya dengan file yang dimodifikasi.

6.1.2. Proses

Jalankan beberapa alat dalam beberapa proses pada saat yang sama (perintah tool all ). Jumlah proses default adalah 1.

6.2. Peralatan

Ini adalah array dengan nama alat yang akan dijalankan oleh Githooks. Nama alat tersebut dapat dieksekusi. Jika Anda ingin semua alat dieksekusi, kunci Tools akan sebagai berikut:

 Tools :
    - phpstan
    - security-checker
    - parallel-lint
    - phpcs
    - phpcbf
    - phpmd
    - phpcpd

Urutan di mana alat -alat tersebut adalah urutan di mana mereka akan dieksekusi.

6.3. Pengaturan alat

Pada langkah berikutnya Anda harus mengkonfigurasi alat dengan nama yang sama seperti pada tombol Alat . Misalnya, untuk set phpcs:

 phpcs :
    executablePath : vendor/bin/phpcs
    paths : [src, tests]
    ignore : [vendor]
    standard : ' PSR12 '

Semua opsi yang tersedia ada di wiki.

7. berkontribusi

Kontribusi dari orang lain akan sangat dihargai! Kirim permintaan/masalah tarik. Periksa semua langkah untuk melakukannya di bagian wiki untuk berkontribusi. Terima kasih!