【VsCode】PHPの開発でPrettierを使用してフォーマットする方法

環境

• windows10
• PHP 8.0
• node v14.17.4
• npm 6.14.14
• VsCode

動作イメージ

設定手順

Prettierのインストール

Prettierプラグインをインストールします。私はグローバルインストールしました。

// ローカル
npm install --save-dev prettier @prettier/plugin-php
// グローバル
npm install --global prettier @prettier/plugin-php

prettier設定ファイルの作成

プロジェクトのルートディレクリに .prettierrcファイルを作成する。

.prettierrc

{ 
  "singleQuote": true, // ダブルクォーテーションは不可
  "trailingComma": "all"  // 文末のカンマ必須(ex.複数行の配列など)
}

設定項目の一覧はこちら

VsCodeの拡張機能をインストール

Run on Saveをインストールする。

https://marketplace.visualstudio.com/items?itemName=emeraldwalk.RunOnSave

インストール後、setting.jsonに以下を追記
※拡張子.phpに対してプラグインを適用するように

setting.json

"emeraldwalk.runonsave": {
  "commands": [
    {
      "match": "\\.php$",
      "cmd": "prettier ${file} --write"
    }
  ]
}

※HTMLとPHPを含んだPHPファイルは整形することができないので、注意

まとめ

いかがでしたでしょうか。本記事では、VsCodeの開発環境において、PHPファイルに対してもprettierを適用してフォーマットする方法について紹介しています。ぜひ参考にしてみてください。