Mac版PhpStormにPHP CodeSnifferを統合する方法

本稿ではMacのPhpStormにPHP CodeSnifferを統合し、エディタ上でコードの問題点を確認できるようにする設定方法を紹介する。

phpcsコマンドをインストールする

composerでphpcsをインストールする。

composer global require "squizlabs/php_codesniffer=3.2.3"

バージョンを確認する

$ ~/.composer/vendor/bin/phpcs --version
PHP_CodeSniffer version 3.2.3 (stable) by Squiz (http://www.squiz.net)

PhpStormの設定手順

phpcsの設定をする

「Code Sniffer」の設定画面で「･･･」ボタンを押す:

phpcsのフルパスを調べる

ls ~/.composer/vendor/bin/phpcs
/Users/suin/.composer/vendor/bin/phpcs

「PHP Code Sniffer (phpcs) path」に上で調べたフルパス「/Users/suin/.composer/vendor/bin/phpcs」等を入力し「Validate」を押す。問題なければ「OK」ボタンを押す。

Inspectionsの設定でPHP Code Snifferを有効化する

ここでは下記の2とおりの設定方法を紹介する。

1. PSR2のコーディング標準を使う場合
2. 独自のコーディング基準設定ファイルphpcs.xmlを使う場合

必要に応じて設定方法を選択してほしい。

1. PSR2のコーディング標準を使う場合

設定の検索窓で「Code Sniffer」を入れ、「Editor」→「Inspections」の「PHP Code Sniffer validation」を探し、それにチェックを入れる。「Severity」(警告度)は「Warning」に変える。「Coding Standard」は「PSR2」にする。

2. 独自のコーディング基準設定ファイルphpcs.xmlを使う場合

設定の検索窓で「Code Sniffer」を入れ、「Editor」→「Inspections」の「PHP Code Sniffer validation」を探し、それにチェックを入れる。「Severity」(警告度)は「Warning」に変える。

「Coding Standard」は「Custom」にし、「Custom Coding Standard」ウィンドウを開いたら、「Path to ruleset」にXMLのパスを指定する。