PHP CodeSniffer でコーディング規約チェックする

PHP CodeSniffer で定義したコーディング規約をチェックし違反を検出します。
今回は、コマンドで実行する場合と atom エディタを使って設定する場合を行ってみます。

PHP CodeSniffer

コーディング規約のチェックを行うツールです。

インストール

  • github からダウンロードする場合

  • Composer でインストールする場合

設定

Atom の「linter-phpcs」で下記の項目を設定します。

  • Executable Path
    実行する phpcs のパス
    「/path/to/PHP_CodeSniffer/bin/phpcs」

  • Code Standard Or Config File
    指定する規約のファイルパス
    「/path/to/PHP_CodeSniffer/phpcs.xml」

操作

コマンド

  • ファイル指定

  • standard オプション
    ルールを指定した場合に指定します。

  • extensions オプション
    拡張子を指定した場合に指定します。

  • ディレクトリ指定
    拡張子を指定した場合に指定します。

  • 自動整形

Atom プラグイン

インストール

  • 検索からインストールする場合
    File - Settings - Install
    「Install Package」から 「linter-phpcs」で検索してインストール

  • コマンドからインストールする場合

設定

Atom の「linter-phpcs」で下記の項目を設定します。

  • Executable Path
    実行する phpcs のパス
    「/path/to/PHP_CodeSniffer/bin/phpcs」

  • Code Standard Or Config File
    指定する規約のファイルパス
    「/path/to/PHP_CodeSniffer/phpcs.xml」

備考

v2.x から phpcbf が追加され自動整形が可能となりました。

関連リンク

https://github.com/squizlabs/PHP_CodeSniffer

返信を残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA