PhpStormでコーディング規約の設定をする

もとやん
2020-01-31
もとやん
2020-01-31

環境

  • MacBookPro (Catalina)
  • PhpStorm (2019.1)
  • Homebrew (2.2.4)

PHP CS

PHP CSとは、PHPのコーディング規約を適用しやすくするためのものです。まずはMacにPHP CSをインストールします。今回はHomebrewでインストールしましたが、composerなどでもインストールできます。
```
brew install php-code-sniffer
```
インストールが終わったら、インストールパスを取得してみましょう。
```
which phpcs
```
このインストールパスは後で使うのでメモしておきます。

PhpStorm

メニューのPhpStorm > Preferencesの画面を開き、Languages & Frameworks > PHP > Quality Toolsに`Code Sniffer`と`Mess Detector`と`PHP CS Fixer`が表示されます。今回は`Code Sniffer`なので、`...`をクリックしてPHP CSのインストールパスを入力します。

同じく、Preferences の画面で、Editor > InspectionsのPHP > Quality tools > PHP Code Sniffer validationを有効にして、Coding Standardに適応するコーディング規約を選択します。以上で設定は終わりです。

結果

warningとしてコーディング規約違反を教えてくれるので、指摘内容を修正しながらコーディングしていきましょう。

`Mess Detector`や`PHP CS Fixer`も同じような手順で設定することができます。

ではでは