こんにちは!日々の開発、本当にお疲れ様です。
チームでPHPの開発をしていると、こんなことで悩んだ経験はありませんか?
「人によってインデントのスペース数が違う」「使っていないのに残されたままのuse宣言がある」「PSR-12に準拠しているつもりが、レビューでフォーマットの指摘ばかり受けてしまう……」
コードレビューの本質は、アルゴリズムの妥当性や設計の美しさを議論することでああって、インデントやセミコロンの付け方を指摘し合うことではありませんよね。
今回は、世界最高峰のPHP向けIDEである PhpStorm の機能を使って、「コードを保存する(Ctrl + S / Cmd + S)だけで、コードの品質とフォーマットを完全に自動化・強制する」 方法を解説します。
これをマスターすれば、コードスタイルのいざこざから完全に解放され、毎日のコーディングが劇的に楽になりますよ。さっそく、その扉を開いていきましょう。
—
なぜ「Save Actions」による自動化が必要なのか?
開発現場でよくある失敗が、「コード整形をコミット時やプッシュ時のフック(Git Hooks)だけに頼る」というアプローチです。もちろんHuskyやLinterを使うのも素晴らしいですが、それでは「開発している最中」のストレスが消えません。
PhpStormのネイティブ機能である「Save Actions(保存時のアクション)」を正しく設定すると、以下のメリットが生まれます。
1. 認知的負荷のゼロ化: 「ちゃんと言い回しやフォーマットを整えたっけ?」と気にする必要がなくなります。
2. レビュー時間の劇的短縮: チーム全員が同じフォーマット規則でコードを書くため、PR(プルリクエスト)の差分が「純粋なロジックの変更のみ」になります。
3. 心理的安全性の向上: 「自分のコードスタイルは汚いかもしれない」という無駄な心配が消え、開発に集中できます。
それでは、実際に設定を行っていきましょう。プラグインの追加は不要です。最近のPhpStormには、この強力な機能が標準で備わっています。
—
基礎セットアップ:保存時アクションの有効化
まずは、PhpStormに「ファイルを保存した瞬間、何をするべきか」を教えてあげましょう。
ステップ1:設定画面を開く
- Windows / Linux: メニューバーの `File` > `Settings`
- macOS: メニューバーの `PhpStorm` > `Settings` (または `Preferences`)
設定ウィンドウが開いたら、左側のツリーから以下のパスを探してクリックします。
`Tools` > `Actions on Save`(日本語環境の場合は `ツール` > `保存時のアクション`)
ステップ2:プロジェクト全体に適用する基本設定
ここが最も重要な心臓部です。以下の項目にチェックを入れていきます。
[✓] Reformat code (コードの自動整形)
[✓] Optimize imports (インポート文の最適化・不要なuseの削除)
[✓] Rearrange code (プロパティやメソッドの並び順の整理)
[✓] Run phpcbf (必要に応じて外部Linterの実行など)
それぞれの項目がどのような役割を持つのか、エンジニアの視点で少し掘り下げて解説しておきます。
- Reformat code: PSR-12などの規約に基づき、スペース、改行、インデントを完璧に一瞬で整えます。「タイポでカッコの位置がずれた」なんて悩みは一瞬で消え去ります。
- Optimize imports: PHPでありがちな「書いたけれど結局使わなかった `use App\Models\User;`」といった無駄なインポート文を、保存した瞬間に綺麗に消去し、アルファベット順に綺麗にソートしてくれます。
—
現場で即効性のあるPHPコードスタイルの設定
「保存時にフォーマットする」といっても、基準となるルール(PHP Coding Standard)がPhpStormに伝わっていなければ意味がありません。プロジェクトがPSR-12に準拠している場合のセットアップを見ていきましょう。
ステップ3:PHPのコードスタイルをPSR-12に固定する
同じ設定画面内で、今度は以下のパスを開きます。
`Editor` > `Code Style` > `PHP` (`エディター` > `コードスタイル` > `PHP`)
ここで、プロジェクトのコーディング規約を定義します。
; スキーム(Scheme)の選択
; チーム全員が同じルールを使えるよう、プロジェクト共有(Project)に設定するのがベストです
Scheme: Project
さらに、`Set from…`(設定元)というボタンをクリックし、`PSR-12` を選択してください。これだけで、PHPの波括弧の位置(Braces)、インデントのスペース数(4スペース)、キーワードの小文字化などが、業界標準のPSR-12に自動でアラインされます。
—
動作確認:あなたのコードが魔法のように整う瞬間を体験する
設定が完了したら、正しく機能するか「Hello World」的な実験をしてみましょう。
1. わざと「汚いコード」を書く
プロジェクト内に適当なPHPファイル(例: `TestService.php`)を作り、以下のようにあえてインデントを崩し、使わないuse宣言を含めた状態でコードを書いてみます。
2. 「保存」を実行する
この状態で、キーボードの `Ctrl + S` (Macの場合は `Cmd + S`)を押してファイルを保存します。
3. 自動クリーンアップされた結果を確認する
保存した瞬間に、画面が一瞬で以下のように書き換わります。
無意識のレベルで行ってくれるのです。
—
チーム開発を成功させるためのプロの知見(共有のコツ)
個人の環境でこの設定をするだけでも素晴らしいのですが、真のプロフェッショナルを目指すなら、「チーム全員のPhpStormでこの設定を強制・共有する」 ことが重要です。
PhpStormは、設定内容をプロジェクトルート配下の `.idea` ディレクトリ(または専用の設定ファイル)に保存します。これをGitに含めてリポジトリで共有することで、チームメンバー全員が「同じ保存時アクション」の恩恵を受けることができます。
1. 設定画面の「Scheme」を `Project` にしていることを確認する。
2. `.idea/codeStyles/` などの設定ファイルをGitの管理下に置く(※ `.idea` 全体を共有するか、コードスタイル関連のXMLだけを共有するかはチームの運用ポリシーによります)。
これを行えば、「あの人のコードはインデントがタブで、俺のはスペースだ!」といった、生産性のない不毛な議論とは永遠におさらばできます。
—
おわりに
開発ツールを使いこなすことは、エンジニアにとって最高のレバレッジ(てこ)です。
「コードを綺麗に書くこと」に脳のメモリを使うのではなく、「どういうロジックでビジネス課題を解決するか」に全リソースを注ぎ込むために、PhpStormのSave Actionsを今日からあなたの相棒にしてください。
これをマスターすれば、毎日のコーディングが本当に、本当に楽になりますよ。
あなたの開発ライフが、より快適で創造的なものになりますように!