Laravel shift pemecah masalah php cs

PHP-CS-Fixer adalah alat sumber terbuka yang dapat menegakkan, dan mendeteksi pelanggaran, gaya pengkodean PHP. Dengan aturan yang telah ditentukan sebelumnya, ini memungkinkan Anda memiliki gaya pengkodean ketat yang diberlakukan oleh alat sehingga Anda dapat meluangkan waktu untuk hal-hal yang lebih penting

Contoh aturan

Berikut adalah beberapa contoh hal-hal yang dapat dilakukan PHP-CS-Fixer ke basis kode Anda

Aturan. is_null

Mengganti ekspresi

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

// before...
if (is_null($account->closed_at)) {
  //
}
 
// after...
if ($account->closed_at === null) {
  //
}

Aturan. mb_str_functions

Ganti fungsi non-multibyte-safe dengan fungsi mb yang sesuai

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

Aturan. not_operator_with_successor_space

Operator NOT logis

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

Aturan main yang tersedia sangat lengkap dan selalu bertambah jumlahnya. Anda dapat melihat daftar lengkap aturan yang tersedia di readme proyek. Anda mungkin juga ingin memeriksa konfigurasi PHP-CS-Fixer, yang merupakan situs yang memberikan contoh tentang apa yang dilakukan setiap aturan, jika deskripsinya tidak jelas

Tip panas. Selain memperbaiki gaya, sering kali dapat digunakan sebagai alat pemutakhiran. PHPUnit 8 menambahkan tipe pengembalian

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

Bagikan aturan Anda

Saya menggunakan PHP-CS-Fixer di seluruh proyek saya dan memiliki seperangkat aturan yang menentukan gaya. Sampai sekarang, saya telah menyalin dan menempelkan aturan saya ketika saya memulai proyek baru, dan ketika aturan baru keluar, saya kemudian harus memperbarui konfigurasi saya di proyek saya yang sudah ada. Ini bukan alur kerja yang ideal karena Anda dapat dengan mudah lupa untuk memperbarui proyek tertentu, dan ini adalah sekumpulan pekerjaan manual

Ternyata adalah mungkin untuk membagikan aturan Anda di beberapa proyek dan tim sehingga

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

Scaffolding repo

Kami akan membangun repo git untuk menampung set aturan berbagi kami. Untuk memulai, kami akan menginisialisasi repo git lokal dan membuat file yang diperlukan

$ mkdir php-styles
 



$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

Menentukan aturan Anda

Seperti yang telah saya sebutkan sebelumnya, ada seperangkat aturan yang ekstensif, dan rilis baru terkadang berisi aturan baru, jadi menurut saya sangat berguna untuk melacak rilis PHP-CS-Fixer mana yang terakhir Anda tinjau aturan yang tersedia. Ini berarti ketika Anda mengupgrade ke versi yang lebih baru, Anda akan mengetahui rilis untuk mencari aturan baru yang mungkin ingin Anda masukkan ke dalam kumpulan aturan bersama Anda. Saya suka menambahkan rilis ulasan terakhir tepat di bagian atas file

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

<?php
 
// last reviewed: v2.16.3 Yellow Bird

Selanjutnya, kami ingin membuat file

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

<?php
 
// last reviewed: v2.16.3 Yellow Bird
 
return [
  '@PSR2' => true,
  'array_syntax' => ['syntax' => 'short'],
  'final_class' => false,
  'new_with_braces' => true,
  // ...
];

PHP-CS-Fixer hadir dengan beberapa set aturan yang telah ditentukan sebelumnya. Semua aturan yang terkait dengan standar PSR-2 semuanya digabungkan ke dalam kumpulan aturan

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

Beberapa aturan memiliki opsi yang terkait dengannya. Aturan

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

Aturan lain ditentukan dalam daftar dengan menggunakan namanya dan nilai boolean, seperti yang terlihat pada aturan

$ mkdir php-styles
 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

$ mkdir php-styles
 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

Metode pembantu

Untuk membuat penggunaan aturan bersama Anda tidak menyakitkan di seluruh proyek Anda, kami akan membuat fungsi pembantu. Mungkin tidak masuk akal mengapa ini ada dulu, tapi ikuti terus, dan semuanya akan menyatu

Untuk memastikan fungsi tidak bertentangan dengan fungsi global lainnya dalam proyek Anda atau dependensinya, sebaiknya letakkan fungsi tersebut di namespace. Buka file

$ mkdir php-styles



 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

<?php
 
namespace TiMacDonald;

Sekarang kita perlu mendefinisikan tanda tangan metode. Metode ini akan menerima turunan dari

$ mkdir php-styles
 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

<?php
 
namespace TiMacDonald;
 
use PhpCsFixer\Config;
use PhpCsFixer\Finder;
 
function styles(Finder $finder, array $rules = []): Config {
  //
}

Luar biasa. Itu datang bersama dengan baik. Hal terakhir sekarang adalah mengisi isi fungsi helper

<?php
 
namespace TiMacDonald;
 
use PhpCsFixer\Config;
use PhpCsFixer\Finder;
 
function styles(Finder $finder, array $rules = []): Config {
  $rules = array_merge(require __DIR__.'/rules.php', $rules);
 
  return Config::create()
    ->setFinder($finder)
    ->setRiskyAllowed(true)
    ->setRules($rules);
}

$ mkdir php-styles
 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

Aturan berisiko

Di dalam tubuh fungsi

$ mkdir php-styles
 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

$ mkdir php-styles
 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src



 
$ touch src/rules.php src/helpers.php composer.json

$ mkdir php-styles
 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

$ mkdir php-styles
 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

implode() dapat, karena alasan historis, menerima parameternya dalam urutan apa pun. Untuk konsistensi dengan meledak(), bagaimanapun, tidak digunakan lagi untuk tidak menggunakan urutan argumen yang terdokumentasi

Ini berarti bahwa kedua panggilan implode ini akan memiliki hasil yang sama

<?php
 
implode($array, ',');
 
implode(',', $array);

Aturan

$ mkdir php-styles
 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

<?php
 
// last reviewed: v2.16.3 Yellow Bird

Jadi harap baca apa yang dilakukan setiap aturan berisiko dan pahami cara kerjanya sebelum Anda menambahkannya ke kumpulan aturan Anda

komposer. json

Untuk menarik paket ke dalam proyek kami, kami perlu mengisi file

<?php
 
// last reviewed: v2.16.3 Yellow Bird

Buka file

<?php
 
// last reviewed: v2.16.3 Yellow Bird

<?php
 
// last reviewed: v2.16.3 Yellow Bird

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

Mendorong ke penyedia

Langkah terakhir dalam menyiapkan repositori kami adalah mendorongnya ke solusi git yang dihosting. Buat repositori di penyedia pilihan Anda dan tambahkan sebagai asal ke repo lokal Anda. Saya akan menggunakan GitHub

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

Kami sekarang memiliki paket aturan bersama yang tersedia di GitHub. Selamat

Mengkonsumsi aturan bersama Anda

Sekarang kami sedikit mengganti persneling untuk fokus pada bagaimana Anda dapat menggunakan aturan bersama baru Anda di proyek lain. Tutup repo aturan bersama Anda dan buka proyek tempat Anda ingin menggunakannya. Ada beberapa penyiapan awal, tetapi setelah Anda melakukannya, hanya

// before...
- if (!$user->is_active) {
  //
}
 
// after...
if (! $user->is_active) {
  //
}

Memerlukan repositori Anda

Composer memungkinkan kita untuk meminta repositori dari platform Git yang dihosting, tanpa harus mengirimkannya ke Packagist. Mengingat repo semacam ini kemungkinan besar bersifat internal, tidak banyak keuntungan yang didapat dengan menambahkannya ke Packagist

Untuk mewujudkannya, tambahkan nama paket Anda secara manual ke proyek

<?php
 
// last reviewed: v2.16.3 Yellow Bird

<?php
 
// last reviewed: v2.16.3 Yellow Bird

Karena kami tidak akan mengirimkan ke Packagist, kami harus memberi tahu Composer di mana menemukan paket tersebut. Kami melakukannya dengan menggunakan blok

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

Sekarang kami memberi tahu Komposer untuk meminta paket kami sebagai ketergantungan

<?php
 
// last reviewed: v2.16.3 Yellow Bird

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

Setup konfigurasi PHP-CS-Fixer Finder

Agar PHP-CS-Fixer mengetahui file apa yang ingin Anda targetkan, Anda perlu menentukan setiap direktori atau file dengan instance

$ mkdir php-styles
 
$ cd php-styles
 
$ git init
 
$ echo "/composer.lock
/vendor
/.php_cs.cache" >> .gitignore
 
$ mkdir src
 
$ touch src/rules.php src/helpers.php composer.json

<?php
 
// last reviewed: v2.16.3 Yellow Bird

Sebagai contoh kita, saya akan berpura-pura berada dalam aplikasi Laravel dan menyiapkan pencari saya untuk menelusuri direktori yang saya tahu ingin mematuhi konvensi gaya saya

PHP-CS-Fixer mengharapkan konfigurasi Anda berada dalam file

<?php
 
// last reviewed: v2.16.3 Yellow Bird
 
return [
  '@PSR2' => true,
  'array_syntax' => ['syntax' => 'short'],
  'final_class' => false,
  'new_with_braces' => true,
  // ...
];

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

Buka file ini dan tambahkan setup finder berikut untuk aplikasi Laravel Anda. Anda juga dapat menyertakan folder lain yang ingin Anda perbaiki, tetapi ini berfungsi sebagai default yang masuk akal

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

Kami sekarang siap untuk meneruskan pencari kami ke fungsi pembantu yang kami buat beberapa menit yang lalu. PHP-CS-Fixer mengharapkan file ini mengembalikan instance

<?php
 
// last reviewed: v2.16.3 Yellow Bird
 
return [
  '@PSR2' => true,
  'array_syntax' => ['syntax' => 'short'],
  'final_class' => false,
  'new_with_braces' => true,
  // ...
];

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

Sekarang posisikan diri Anda pada posisi penjepit sementara kami secara otomatis memperbaiki gaya pengkodean kami di semua direktori ini. Lompat ke terminal dan jalankan perintah berikut untuk menyaksikan keajaiban terjadi…

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

Berjalan di CI

Sebaiknya terapkan aturan gaya Anda selama C. I. Anda dapat melakukan ini dalam beberapa cara. Anda bisa melakukan "dry run", yang akan gagal jika mendeteksi pelanggaran gaya kode

// before...
$length = strlen($request->post('slug'));
 
// after...
$length = mb_strlen($request->post('slug'));

Atau, Anda bisa memiliki C. I. jalankan pemecah masalah dan komit otomatis perubahan ke repo Anda. Jika Anda menggunakan tindakan GitHub, lihat artikel hebat ini yang ditulis oleh Stefan Zweifel tentang bagaimana Anda mengimplementasikannya

Bungkus

Terima kasih telah datang dalam perjalanan ini. PHP-CS-Fixer adalah alat yang hebat, dan mudah-mudahan, jika Anda menjalankan beberapa proyek yang berbagi gaya pengkodean standar, pendekatan ini mungkin berguna

Diajukan

Berita

timacdonald

Mengembangkan aplikasi web yang menarik dan berkinerja dengan fokus pada TDD. Mengkhususkan diri dalam proyek PHP / Laravel. ❤️ membangun untuk web