PHP CS Fixer

Pemecah Standar Pengkodean PHP

Alat PHP Coding Standards Fixer (PHP CS Fixer) memperbaiki kode Anda agar mengikuti standar; apakah Anda ingin mengikuti standar pengkodean PHP seperti yang didefinisikan dalam PSR-1, PSR-2, dll., atau standar berbasis komunitas lainnya seperti Symfony. Anda juga dapat menentukan gaya (tim) Anda melalui konfigurasi.

Itu dapat memodernisasi kode Anda (seperti mengonversi fungsi pow ke operator ** di PHP 5.6) dan (mikro) mengoptimalkannya.

Jika Anda sudah menggunakan linter untuk mengidentifikasi masalah standar pengkodean dalam kode Anda, Anda tahu bahwa memperbaikinya secara manual itu membosankan, terutama pada proyek besar. Alat ini tidak hanya mendeteksinya, namun juga memperbaikinya untuk Anda.

Versi PHP yang Didukung

• PHP 7.4
• PHP 8.0
• PHP 8.1
• PHP 8.2
• PHP 8.3

Catatan Setiap versi PHP baru memerlukan upaya besar untuk mendukung sintaks baru. Itu sebabnya versi PHP terbaru mungkin belum didukung. Jika Anda membutuhkannya, mohon pertimbangkan untuk mendukung proyek dengan cara apa pun yang nyaman, misalnya dengan kontribusi kode atau meninjau PR yang ada. Untuk menjalankan PHP CS Fixer pada versi yang belum didukung "risiko Anda sendiri" - manfaatkan PHP_CS_FIXER_IGNORE_ENV.

Dokumentasi

Instalasi

Cara yang disarankan untuk menginstal PHP CS Fixer adalah dengan menggunakan Composer di file composer.json khusus di proyek Anda, misalnya di direktori tools/php-cs-fixer :

 mkdir -p tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer

Atau menggunakan composer.json utama :

 composer require --dev friendsofphp/php-cs-fixer

Untuk rincian lebih lanjut dan metode instalasi lainnya, lihat petunjuk instalasi.

Jalankan dengan Docker

Anda dapat menggunakan image Docker yang sudah dibuat sebelumnya untuk menjalankan php-cs-fixer .

 docker run -it --rm -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix src

$FIXER_VERSION yang digunakan pada contoh di atas adalah pengidentifikasi rilis yang ingin Anda gunakan, yang didasarkan pada gabungan versi Fixer dan PHP. Ada tag berbeda untuk setiap level SemVer Fixer dan versi PHP dengan sintaks <php-cs-fixer-version>-php<php-version> . Misalnya:

• 3.57.0-php7.4
• 3.57-php8.0
• 3-php8.3

Penggunaan

Dengan asumsi Anda menginstal PHP CS Fixer seperti yang diinstruksikan di atas, Anda dapat menjalankan perintah berikut untuk memperbaiki file PHP di direktori src :

 tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src

Lihat penggunaan, daftar aturan bawaan, daftar kumpulan aturan, dan dokumentasi file konfigurasi untuk detail selengkapnya.

Jika Anda perlu menerapkan gaya kode yang tidak didukung oleh alat tersebut, Anda dapat membuat aturan khusus.

Integrasi Editor

Plugin khusus ada untuk:

• NetBeans
• PhpStorm
• Teks Luhur
• Vim
• VS Kode

Masyarakat

PHP CS Fixer dikelola di GitHub di https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. Laporan bug dan ide tentang fitur baru diterima di sana.

Anda dapat menghubungi kami di Diskusi GitHub mengenai proyek, konfigurasi, kemungkinan peningkatan, ide, dan pertanyaan. Silakan kunjungi kami di sana!

Menyumbang

Alat ini dilengkapi dengan beberapa pemecah masalah bawaan, tetapi setiap orang dipersilakan untuk berkontribusi lebih banyak.