🔍
PHP-CS-Fixerにfix --dry-runにcheckっていうショートカットがあった
はじめに
PHP-CS-Fixerを使用してコードスタイルをチェックする時に修正が必要なのか確認したい場合にfixコマンドに--dry-runオプションをつけて実行していましたがcheckというコマンドを発見したので忘れないように書き残しておきます。
環境
- PHP 8.4.10
- friendsofphp/php-cs-fixer v3.84.0
答えはドキュメントに書いてあった
はい、ドキュメントに書いてありました。
checkコマンドはfix --dry-runの短縮形です。
なので、今までは以下のような感じでコマンドを実行し、修正の有無を確認していましたが、
./vendor/bin/php-cs-fixer fix --dry-run
いまはcheckコマンドだけで良くなっていたみたいです。
./vendor/bin/php-cs-fixer check
fixコマンドと同じオプション、引数が使えるようです。
それはソースコードを見たらすぐにわかりました。
FixCommandクラスを継承しているので同じですね。
いつ増えた
fixコマンドにオプションを付けて実行でも特に困ることがなかったので、見向きもしてなかったですが、
以下のプルリクエストで増えたようです。
この記事を書いている時点から考えると2年ほど前ですかね。（そんな前からあったんだ、、、）
CHANGELOGをみるとv3.34.0で増えたようです。
まとめ
大きな変化はないですが、fixよりcheckの方が見ただけで何をやっているのかわかりやすくなるので、わかりずらい人はぜひcheckコマンドに置き換えてみてください。
こういう変更は同じやり方を繰り返してこともだけだと気付かないものなので、やはりドキュメントは見るものですね。
Discussion