最近はCodeIgniter4を使って開発しているのですが、公式のコード整形ツールがありました。 試しに使ってみたら、かなりコードが整形されたのでメモがてら記します。
インストール
- composerを使ってインストールします。
- とりあえず開発環境で使いたいだけなので、--devしました。
$ composer require --dev codeigniter/coding-standard
または、wgetで持ってきたcomposer.pharを使ってインストールも可能です。
$ php composer.phar require --dev codeigniter/coding-standard
何が使われているか
- php-cs-fixerでコード整形が実行されます。
- composer.jsonを確認したところ、
"friendsofphp/php-cs-fixer"
が書いてありました。
実行方法
README.mdに書いてあります。
$ vendor/bin/php-cs-fixer fix --verbose
本実行の前に、dry-runとdiffで、どのような変換が行われるのか差分を確認できます。
$ vendor/bin/php-cs-fixer fix --verbose --dry-run --diff
特徴的だと思ったこと
- 上下のイコールが揃えられます。
// before $a = 1; $bb = 2; // after $a = 1; $bb = 2;
- 他にも、array_map上に記述した無名関数が、functionがfnに変換されたりしました。
- 新しいPHPの書き方に自動で矯正されたりもするので、PHP学習の機会としても良さそうです。
あとがき
現在の私は、CodeIgniter4を使ったとあるプロジェクトで開発しているのですが、まだまだCodeIgniter4の書き方に慣れておりません。
CodeIgniter/coding-standard
を通せば、勝手にCodeIgniter風の書き方に矯正してくれるので、変換の過程を確認しつつ勉強していきたいと思います。