
PHP コーディング標準フィクサー (PHP CS Fixer) ツールは、標準に準拠するようにコードを修正します。 PSR-1、PSR-2 などで定義されている PHP コーディング標準に従うか、または Symfony のような他のコミュニティ主導のものに従うか。設定を通じて (チームの) スタイルを定義することもできます。
コードを最新化し (PHP 5.6 のpow関数を**演算子に変換するなど)、(マイクロ) 最適化できます。
すでにリンターを使用してコード内のコーディング標準の問題を特定している場合は、手作業で問題を修正するのは、特に大規模なプロジェクトでは面倒であることをご存知でしょう。このツールはそれらを検出するだけでなく、修正も行います。
注新しい PHP バージョンごとに、新しい構文をサポートするには多大な労力が必要です。そのため、最新の PHP バージョンはまだサポートされていない可能性があります。必要な場合は、コードの提供や既存の PR のレビューなど、便利な方法でプロジェクトをサポートすることを検討してください。まだサポートされていないバージョンで PHP CS Fixer を「自己責任で」実行するには、PHP_CS_FIXER_IGNORE_ENV を利用します。
PHP CS Fixer をインストールする推奨方法は、プロジェクト内の専用のcomposer.jsonファイル (たとえばtools/php-cs-fixerディレクトリ) で Composer を使用することです。
mkdir -p tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixerまたは、メインのcomposer.jsonを使用します。
composer require --dev friendsofphp/php-cs-fixer詳細およびその他のインストール方法については、インストール手順を参照してください。
事前に構築された Docker イメージを使用してphp-cs-fixer実行できます。
docker run -it --rm -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix src上記の例で使用されている$FIXER_VERSION 、使用するリリースの識別子であり、Fixer と PHP のバージョンの組み合わせに基づいています。各 Fixer の SemVer レベルと PHP バージョンには、構文<php-cs-fixer-version>-php<php-version>を持つ異なるタグがあります。例えば:
3.57.0-php7.43.57-php8.03-php8.3上記の指示に従って PHP CS Fixer をインストールした場合、次のコマンドを実行してsrcディレクトリ内の PHP ファイルを修正できます。
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src詳細については、使用法、組み込みルールのリスト、ルール セットのリスト、および構成ファイルのドキュメントを参照してください。
ツールでサポートされていないコード スタイルを適用する必要がある場合は、カスタム ルールを作成できます。
以下の専用プラグインが存在します。
PHP CS Fixer は、GitHub (https://github.com/PHP-CS-Fixer/PHP-CS-Fixer) で保守されています。バグレポートや新機能に関するアイデアは歓迎されます。
プロジェクト、構成、改善の可能性、アイデア、質問については、GitHub ディスカッションでご連絡ください。ぜひお越しください!
このツールにはかなりの数の修正ツールが組み込まれていますが、皆さんがさらに多くの修正ツールを提供することは大歓迎です。