PHP CS Fixer 2でファイルの先頭に自動的にコメントを挿入する。
知らない内に、PHP CS Fixerの2系が出ていました。.php_cs
の中身が結構変わっていて前に書いたファイル先頭にコメントを挿入するのもかなり変わっていたので2系用の記事を作成。
1系のはこっち。
コメントを準備する
頭の方でコメントを入れておく。
<?php // 先頭に入れるコメント。 $header = <<<'EOS' This file is part of MyApp. (c) Hiroto Kitazawa <hiro.yo.yo1610@gmail.com> For the full copyright and license information, please view the LICENSE file that was distributed with this source code. EOS;
ConfigクラスのsetRulesにheader_commentを追加。
1.xではHeaderCommentFixer::setHeader
を使ってコメントを設定していましたが、2.xではConfigクラスのsetRulesメソッドで設定します。
これは1.xの時。
HeaderCommentFixer::setHeader($header);
$fixers = [
// 省略
"header_comment",
];
return Config::create()->fixers($fixers);
2.xではこうする。
$rules = [ // 省略 "header_comment" => ["header" => $header], ]; return Config::create()->setRules($rules);
fixコマンドを実行
通常通り実行する。
./vendor/bin/php-cs-fixer fix