Php cs fixer v2 phar

Selain bantuan pengkodean bawaan, PhpStorm menyediakan pemeriksaan kode sumber melalui integrasi dengan alat PHP CS Fixer, yang mendeteksi masalah standar pengkodean dalam kode Anda

Untuk menggunakan PHP CS Fixer dari PhpStorm alih-alih baris perintah, Anda harus mendaftarkannya di PhpStorm dan mengonfigurasinya sebagai inspeksi kode PhpStorm. Setelah diinstal dan diaktifkan di PhpStorm, alat ini tersedia di semua file PHP yang dibuka, dan tidak diperlukan langkah tambahan untuk meluncurkannya. Pemeriksaan kode on-the-fly diaktifkan pada setiap pembaruan dalam file sehingga memudahkan untuk menyingkirkan masalah yang ditemukan

Kesalahan dan peringatan yang dilaporkan oleh PHP CS Fixer on-the-fly ditampilkan sebagai pesan popup. Saat alat dijalankan dalam mode batch, kesalahan dan peringatan ditampilkan di jendela alat Masalah. Setiap pesan memiliki awalan PHP CS Fixer untuk membedakannya dari inspeksi internal PhpStorm

Anda dapat menerapkan aturan yang telah ditentukan sebelumnya atau menentukan kumpulan aturan kustom Anda sendiri

Prasyarat

Sebelum mengintegrasikan PHP CS Fixer di PhpStorm, pastikan prasyarat berikut terpenuhi

  • Anda bekerja dengan PHP CS Fixer versi 2. 8. 0 dan selanjutnya

  • Direktori yang berisi eksekusi mesin PHP harus ditambahkan ke sistem path. Ini memungkinkan skrip alat kualitas kode mengeksekusi panggilan ke mesin PHP di seluruh sistem

  • Untuk penerjemah jarak jauh berbasis Docker Compose, pastikan untuk menggunakan mode exec untuk menghindari pemijahan kontainer tambahan

    1. Dalam dialog Pengaturan (Ctrl+Alt+S), buka PHP.

    2. Pada halaman PHP yang terbuka, klik di samping CLI Interpreter list.

    3. Dalam dialog CLI Interpreters yang terbuka, setel Siklus Hidup mode for the selected interpreter to Connect to existing container ('docker-compose exec') .

      Php cs fixer v2 phar

Instal dan konfigurasikan PHP CS Fixer

Skrip PHP CS Fixer dapat digunakan sebagai skrip lokal, skrip yang terkait dengan juru bahasa PHP, atau skrip yang dinyatakan sebagai dependensi proyek dan diinstal melalui Komposer, yang merupakan cara yang lebih disukai dan disarankan

Instal PHP CS Fixer dengan Composer

Sebelum memulai, pastikan Komposer diinstal pada mesin Anda dan diinisialisasi dalam proyek saat ini seperti yang dijelaskan dalam manajer ketergantungan Komposer

Saat Anda menginstal PHP CS Fixer dengan Komposer, PhpStorm secara otomatis mengunduh skrip yang diperlukan, mendaftarkannya di IDE, dan, secara opsional, mengaktifkan dan mengonfigurasi skrip yang sesuai

  1. Di dalam komposer. json , tambahkan friendsofphp/php-cs-fixer catatan dependensi ke bagian require atau require-dev. Tekan Ctrl+Spasi untuk mendapatkan penyelesaian kode untuk nama dan versi paket.

  2. Lakukan salah satu dari berikut ini

    • Klik tautan pintasan Install di bagian atas panel editor.

    • Jika Paket Komposer yang tidak diinstal pemeriksaan diaktifkan, PhpStorm akan menyorot dependensi yang dideklarasikan yang saat ini tidak diinstal. Tekan Alt+Enter dan pilih apakah Anda ingin menginstal dependensi tertentu atau semua dependensi sekaligus.

Klik di samping catatan paket di composer. talang editor json untuk melompat ke halaman Pengaturan yang sesuai dan.

Php cs fixer v2 phar

Setel ulang konfigurasi PHP CS Fixer

Setelah PHP CS Fixer awalnya dikonfigurasi, modifikasi lebih lanjut dalam komposer. json tidak akan memengaruhi konfigurasi pemeriksaan. Untuk menerapkan perubahan yang lebih baru, reset konfigurasi PHP CS Fixer.

  1. Dalam dialog Pengaturan (Ctrl+Alt+S), arahkan ke PHP. Alat Kualitas .

  2. Pada laman Alat Kualitas yang terbuka, luaskan area PHP CS Fixer dan klik di sebelah . Configuration list.

  3. Dalam dialog PHP CS Fixer yang terbuka, kosongkan path PHP CS Fixer field.

    Php cs fixer v2 phar
  4. Perbarui dependensi Komposer proyek dengan mengeklik Perbarui di atas komposer. json panel editor. Lihat detailnya.

PhpStorm akan melakukan konfigurasi PHP CS Fixer lagi dan dengan demikian menerapkan perubahan di composer. json .

Konfigurasi PHP CS Fixer secara manual

Anda dapat menggunakan skrip alat kualitas kode PHP lokal yang diunduh secara manual atau skrip yang terkait dengan juru bahasa PHP. Mungkin ada beberapa interpreter PHP lokal dan jarak jauh, yang ditentukan pada halaman PHP dari dialog Pengaturan dianggap sebagai Project Default. Learn more about configuring PHP interpreters in Configure remote PHP interpreters or in Configure local PHP interpreters.

Pilih skrip PHP CS Fixer untuk digunakan

  1. Dalam dialog Pengaturan (Ctrl+Alt+S), arahkan ke PHP. Alat Kualitas .

  2. Pada halaman Alat Kualitas yang terbuka, luaskan area PHP CS Fixer . Dari daftar Konfigurasi , pilih skrip PHP CS Fixer.

    • Untuk menggunakan skrip yang terkait dengan juru bahasa PHP jarak jauh tertentu, pilih nama juru bahasa ini

    • Untuk menggunakan skrip lokal, pilih Lokal . Dalam hal ini PHP CS Fixer lokal akan dijalankan tidak peduli penerjemah PHP mana - lokal atau jarak jauh - yang digunakan dalam proyek. Perhatikan bahwa hanya ada satu konfigurasi Lokal untuk PHP CS Fixer karena PhpStorm menjalankan skrip ( php-cs- . bat untuk Windows atau php-cs-fixer untuk Linux dan macOS) yang berisi jalur ke mesin PHP.

    • Untuk menggunakan skrip yang terkait dengan juru bahasa proyek default, yaitu, yang dipilih pada halaman PHP dari Settings dialog, choose By default project interpreter.

Konfigurasikan skrip PHP CS Fixer lokal

  1. Unduh dan instal skrip PHP CS Fixer

    Untuk memeriksa instalasi PHP CS Fixer, pindah ke direktori instalasi dan jalankan perintah berikut

    php-cs-fixer --versi

    Jika alat tersedia, Anda akan mendapatkan pesan dalam format berikut

    Pemecah Masalah PHP CS 2. 13. 0 Yogi's BBQ oleh Fabien Potencier dan Dariusz Ruminski

    Agar kode diperiksa terhadap standar pengkodean kustom Anda sendiri, buatlah. Simpan aturan dan . php_cs atau php_cs. dist file yang menunjuk ke mereka di ruleset direktori root.

  2. Daftarkan skrip PHP CS Fixer lokal di PhpStorm

    1. Dalam dialog Pengaturan (Ctrl+Alt+S), arahkan ke PHP. Alat Kualitas .

    2. Pada laman Alat Kualitas yang terbuka, luaskan area PHP CS Fixer dan klik di sebelah . Configuration list.

    3. Dalam dialog PHP CS Fixer yang terbuka, tentukan lokasi php-cs- . bat atau php-cs-fixer PHP CS Fixer dapat dieksekusi di PHP . Ketik jalur secara manual atau klik field. Type the path manually or click dan pilih folder yang relevan di dialog yang terbuka.

      Untuk memeriksa apakah jalur yang ditentukan ke php-cs-fixer. bat atau php-cs-fixer memastikan interaksi antara PhpStorm dan PHP CS Fixer, yaitu, alat tersebut dapat . Validasi ini sama dengan menjalankan perintah php-cs-fixer --version. Jika validasi berhasil, PhpStorm menampilkan informasi versi PHP CS Fixer yang terdeteksi. Validate button. This validation is equal to running the php-cs-fixer --version command. If validation passes successfully, PhpStorm displays the information on the detected PHP CS Fixer version.

  3. Jika perlu, di kolom Tool process timeout , tentukan berapa lama Anda ingin PhpStorm menunggu hasil dari PHP CS Fixer, kemudian .

Konfigurasikan skrip PHP CS Fixer yang terkait dengan juru bahasa PHP

  1. Dalam dialog Pengaturan (Ctrl+Alt+S), arahkan ke PHP. Alat Kualitas .

  2. Pada laman Alat Kualitas yang terbuka, luaskan area PHP CS Fixer dan klik di sebelah . Dialog Configuration list. The PHP CS Fixer akan terbuka menampilkan daftar semua skrip PHP CS Fixer yang dikonfigurasi di panel sebelah kiri, salah satunya bertipe < . Local and others are named after the PHP interpreters with which the scripts are associated.

  3. Klik pada toolbar. Dalam dialog PHP CS Fixer by Remote Interpreter yang terbuka, pilih interpreter PHP jarak jauh untuk menggunakan skrip terkait dari. Jika daftar tidak berisi juru bahasa yang relevan, klik dan konfigurasikan juru bahasa jarak jauh di dialog CLI Interpreters seperti yang dijelaskan .

    Ketika Anda mengklik OK , PhpStorm membawa Anda kembali ke PHP CS Fixer dialog where the new PHP CS Fixer configuration is added to the list and the right-hand pane shows the chosen remote PHP interpreter, the path to the PHP CS Fixer associated with it, and the advanced PHP CS Fixer options.

  4. Jika perlu, di kolom Tool process timeout , tentukan berapa lama Anda ingin PhpStorm menunggu hasil dari PHP CS Fixer, kemudian .

Konfigurasikan PHP CS Fixer sebagai inspeksi PhpStorm

Konfigurasikan inspeksi PHP CS Fixer dengan Composer

Anda dapat menyertakan informasi tentang kumpulan aturan PHP CS Fixer default dan kustom di dalam bagian skrip composer. json . Saat Anda atau memproyeksikan dependensi, kumpulan aturan yang ditentukan akan terdeteksi dan pemeriksaan validasi PHP CS Fixer akan diaktifkan secara otomatis.

Jika tidak ada kumpulan aturan yang ditentukan di bagian scripts dari komposer. json , PhpStorm juga akan memeriksa root proyek untuk menemukan kumpulan aturan dengan . php_cs atau . php_cs. dist nama default. Jika file ada, maka akan dipilih secara otomatis sebagai kumpulan aturan Khusus pemeriksaan.

  • Di bagian scripts dari komposer. json , tambahkan perintah peluncuran php-cs-fixer PHP CS Fixer ke salah satu elemen daun.

    Berikan argumen --rules untuk menunjukkan standar pengkodean yang digunakan. Misalnya, menambahkan record berikut akan menetapkan standar pengkodean ke PSR1 .

    "skrip". { "php-cs-fixer". "php-cs-fixer --rules=@PSR1" }

    Atau, berikan argumen path0 dan jalur ke file kumpulan aturan, yang akan menyetel standar pengkodean ke Kustom .

    "skrip". { "php-cs-fixer". "php-cs-fixer --config=. /. php_cs" }

Setelah PHP CS Fixer awalnya dikonfigurasi, modifikasi lebih lanjut dalam komposer. json tidak akan memengaruhi konfigurasi pemeriksaan. Untuk menerapkan perubahan yang lebih baru, pada PHP. Halaman Alat Kualitas dari dialog Pengaturan (Ctrl+Alt+S) dan dependensi proyek.

Konfigurasikan inspeksi PHP CS Fixer secara manual

  1. Dalam dialog Pengaturan (Ctrl+Alt+S), klik Inspeksi under Editor.

  2. Pada halaman Inspeksi yang terbuka, perluas PHP. Alat Kualitas node dan pilih kotak centang di sebelah validasi PHP CS Fixer .

    Jika Anda memiliki tetapi pemeriksaan terkait saat ini dinonaktifkan, PhpStorm menyorot catatannya di komposer. json . Tekan Alt+Enter dan gunakan perbaikan cepat Aktifkan pemeriksaan yang disediakan untuk mengaktifkan pemeriksaan dan membuka halaman Pemeriksaan.

    Php cs fixer v2 phar
  3. Di panel sebelah kanan halaman, konfigurasikan alat PHP CS Fixer menggunakan kontrol di area Opsi .

    1. Dari daftar Keparahan , pilih tingkat keparahan untuk pemeriksaan PHP CS Fixer. Nilai yang dipilih menentukan seberapa serius perbedaan yang terdeteksi akan ditangani oleh PhpStorm dan disajikan dalam hasil pemeriksaan.

    2. Dari daftar Cakupan , pilih cakupan untuk membatasi aplikasi pemeriksaan.

    3. Untuk mengizinkan , yaitu aturan yang dapat mengubah perilaku kode, pilih kotak centang Izinkan aturan berisiko untuk kumpulan aturan bawaan . Secara default, aturan berisiko tidak diizinkan.

    4. Tunjuk standar pengkodean untuk diterapkan

      • Untuk menggunakan salah satu dari yang telah ditentukan sebelumnya, pilih daftar Pengkodean standar , tentukan gaya pengkodean untuk memeriksa kode Anda. Daftar ini berisi semua standar pengkodean yang dideklarasikan di dalam struktur direktori utama php-cs-fixer .

      • Agar kode Anda diperiksa terhadap standar pengkodean yang Anda tentukan sebelumnya, pilih Khusus . Klik Browse dan di dialog Custom Coding Standard yang terbuka, tentukan . php_cs .php_cs atau . php_cs. dist file untuk standar pengkodean Anda sendiri di bidang Path to ruleset . Ketik jalur secara manual atau klik Jelajahi dan pilih folder yang relevan di dialog yang terbuka.

Bagikan gaya pengkodean khusus dengan tim

  1. Letakkan direktori root dari standar pengkodean Anda di bawah

  2. .

  3. .

  4. Pastikan profil proyek dipilih di bagian atas halaman Inspeksi. Profil tersebut disimpan dalam proyek tertentu. ide direktori (misalnya, $PROJECT_DIR$/. idea/inspectionProfiles ). Lihat Mengonfigurasi profil untuk detailnya.

  5. Pada halaman Kontrol Versi pada dialog Pengaturan , pastikan bahwa . ide direktori diletakkan.

Jalankan PHP CS Fixer dalam mode batch

  1. Dari menu utama, pilih Kode. Periksa kode .

  2. Pilih profil pemeriksaan dari daftar, atau klik untuk mengonfigurasi profil baru di dialog Pemeriksaan yang terbuka. Anda juga dapat mengklik untuk memeriksa, perbaikan mana yang akan diterapkan dan memastikan bahwa pemeriksaan validasi PHP CS Fixer telah .

  3. Lihat hasil pemeriksaan di jendela alat Masalah. Kesalahan dan peringatan yang dilaporkan oleh PHP CS Fixer diawali dengan PHP CS Fixer untuk membedakannya dari inspeksi internal PhpStorm

    Apa yang dilakukan pemecah masalah PHP CS?

    Pemecah Standar Pengkodean PHP (PHP CS Fixer) adalah alat yang dirancang untuk memperbaiki masalah standar pengkodean PHP secara otomatis .

    Bagaimana cara mengkonfigurasi PHP CS Fixer?

    Alat Kualitas .
    Arahkan ke Preferensi -> Bahasa & Kerangka Kerja -> PHP -> Alat Kualitas -> PHP CS Fixer
    Pilih konfigurasi "Lokal".
    Buka dialog jalur dengan mengklik [. ]
    Cari kerabat biner php-cs-fixer dari root proyek di bawah vendor/bin/php-cs-fixer
    Simpan perubahan

    Bagaimana cara menginstal PHP CS Fixer di vscode?

    Buka command palette F1 dan pilih Extensions. Install Extension , lalu cari PHP CS Fixer .