PhpStormを利用する
2022年から、エディタはphpstormを利用することにしました。
もともとVSCodeを使っていたけれどtwitterのPHP猛者たちがphpstormを利用しているっぽいので利用することにした次第です。
ただ、VScodeにも愛着があるので、VScodeとPhpStormを併用することにします。
PHP_CodeSniffe とは？
さて、そもそもCodeSnifferとはなにか？
PHP CodeSniffer（PHPコードスニファー）は、記述したPHPなどがきめられたコーディング規約に則って書かれているかをチェックできるツールです。
PHP_CodeSnifferのインストール(Windows環境)
Composerでインストールします。
$ composer global require "squizlabs/php_codesniffer=*"
ちゃんとインストールされているか確認
$ which phpcs /c/Users/*******/Composer/vendor/bin/phpcs
PhpStormの設定
PhpStormから、設定 > PHP > 品質ツール > PHP_CodeSnifferの
構成の右側にある … をクリック
PHP_CodeSnifferのパスの部分にさきほどwhich phpcsで確認したPATHにあるphpcs.batを記述
その後検証を押してエラーが出なければok
次に設定 > エディター > インスペクション > PHP > 品質ツール > PHP_CodeSniffer検証 からPSR12にして、適用・okボタンを押す。
動作確認
例えば、以下のようなfor文を書いてみます。
わざとインデントを無しで書いたところ、さっそく怒られました。
怒られたので、ちゃんとインデントを入れる。
無事問題は発生しませんでした！
なお、怒られた場合の文章は慣れないとよくわからないと思います。
その際は怒られた文章をそのままググってみてください。
終わりに
PHP Snifferの導入でした。
一人でコードを書いている場合そんなに神経質にならなくてもいいかもしれませんが、
後でコードを見直したときに読みやすくなります。
また、複数人でコードを共有する場合は、きれいなコードが必須です。
ぜひPHP Snifferでgood code lifeを！
コメント