やっと公式コーディングルールができた!PHPのコーディングルール

概要

PHPの標準コーディングルール(コーディング規約)は、http://www.php-fig.org/によって、PSR-0からPSR-3までのドキュメントによって細かく決められています。

そのコーディングルールに準拠するように自動的にソースコードを修正してくれるスクリプトが以下です。
https://github.com/fabpot/PHP-CS-Fixer

使い方

composerの場合、composer.jsonへ以下を追記する。

+        "fabpot/php-cs-fixer": "0.3.*@dev"
+        "sebastian/diff": "1.0.*@dev"
% php composer.phar update

して、

% vendor/bin/php-cs-fixer fix <target dirctory> --dry-run </target>

すると、どのように変更されるかが表示される。–dry-runを外すとソースコードが書き換えられる。

デフォルトオプションだと16個ぐらいのルールを適用しています。一部のルールを適用したい場合は個別オプションを指定して実行します。マイナスを付けることにより、ブラックリスト指定も個可能です。

% vendor/bin/php-cs-fixer fix <target directory> --dry-run --fixers=short_tag,-indentation </target>

サンプル

https://github.com/matsubo/redis-ranking/commit/b736d39754f576f86b6eb6a42f7cb2b27dc32b8d

vimプラグイン

vimからphp-cs-fixerを実行するプラグイン。
https://github.com/stephpy/vim-php-cs-fixer


matsubokkuri

マインディアにてCTOをしています。

あわせて読みたい

コメントを残す