November 4, 2012

PHP Coding Standards Fixerのインストールや使い方のメモ

■本家
http://cs.sensiolabs.org/


■インストール
wget http://cs.sensiolabs.org/get/php-cs-fixer.phar -O xxx/php-cs-fixer.phar


■アップデート
php php-cs-fixer.phar self-update


■使い方
php php-cs-fixer.phar fix /path/to/dir
php php-cs-fixer.phar fix /path/to/file


■使い方(levelオプション指定)
php php-cs-fixer.phar fix /path/to/project --level=psr0
php php-cs-fixer.phar fix /path/to/project --level=psr1
php php-cs-fixer.phar fix /path/to/project --level=psr2
php php-cs-fixer.phar fix /path/to/project --level=all


■使い方(fixersオプション指定)
php php-cs-fixer.phar fix /path/to/dir --fixers=linefeed,short_tag,indentation


■fixersオプションの意味(一部、表現に間違いあるかも)
* indentation
インデントをスペースx4に。

* braces
クラス名とメソッド名に続く括弧は次の行にする。制御構造に続く括弧は同じ行にする。


* linefeed
PHPファイルの改行コードをLFに。

* trailing_spaces
行末のホワイトスペースを削除。

* unused_use
使用していないuseステートメントを削除。

* php_closing_tag
PHPの閉じタグ ?> を削除。

* short_tag
ショートタグは使わない。

* return
returnの前は一行空ける。

* visibility
全てのプロパティやメソッドは可視性を宣言する。

* phpdoc_params
phpdocの@paramは縦に整列する。

* eof_ending
ファイルの末尾は改行する。

* extra_empty_lines
余分な空白行を削除。

* include
includeするファイルの指定に括弧は使わない。

* PSR0
クラスは、その名前空間に一致するパスに配置する必要があり、少なくとも一つの名前空間の深さにすると、クラス名がファイル名と一致する必要があります。(自動翻訳のまま)

* controls_spaces
制御構造に続く括弧の左にはスペースを空ける。

* elseif
else ifの代わりにelseifを使う。


■個人的な感想
levelオプション指定(無指定含む)で使うことは無さそう。
fixersオプション指定で使うと便利そう。
その時、indentationとbracesは使わなそう。

なので
php php-cs-fixer.phar fix /path/to/dir --fixers=linefeed,trailing_spaces,unused_use,php_closing_tag,short_tag,return,visibility,phpdoc_params,eof_ending,extra_empty_lines,include,PSR0,controls_spaces,elseif
かなー。

No comments:

Post a Comment