PHPプログラムに関する各種メモ書き

phpcs , phpcbf で phpコードを(チェック / 整形)する

多人数が関わるプロジェクトでは phpコードの書式を統一するのが難しくなります。
そこでプログラマー個人にコーディングルールを覚えさせるよりプログラムで自動判別させます。
下記の phpcs がとても便利です。

● squizlabs/PHP_CodeSniffer ( phpcs )

https://github.com/squizlabs/PHP_CodeSniffer/wiki

1. composer コマンドからインストールします

composer global require "squizlabs/php_codesniffer=*"

2. シェルが bash の場合は次のコマンドでパスを追加しておきます

echo 'export PATH=$HOME/.composer/vendor/bin:$PATH' >> .bash_profile
source .bash_profile

● インストールの確認

phpcs --version

● php ソースコードのチェック (phpcs コマンド)

PSR2準拠のソースフォーマットチェックを行います。

phpcs  --report=source  --standard=PSR2  [phpファイル名  または ディレクトリ名 ] 

オプション --standard=PSR2 を付け忘れないようにしましょう。
(オプションをつけないとPEAR準拠のソースフォーマットチェックとなります)

--reportオプションは

--report=source
--report=summary

があります。

● チェックできるコーディングルール一覧を表示する

phpcs -i

The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz and Zend

● php ソースコードの整形 (phpcbf コマンド)

指定したコーディング規約に沿うようphpソースコードを自動で整形してくれます
例)PSR2準拠に自動整形します

phpcbf  --standard=PSR2  [phpファイル名] 

関連エントリー

No.1121
04/11 23:22

edit

エラー対処