PHPでもコード整形ツール「Prettier」を使いたい時

はじめに

PHPファイルでもPrettierを適用したい時の手順。
自動でフォーマット出来ます。

参考記事

Prettier公式 plugin-php

導入手順

1. Prettierのインストール

※プロジェクトにpackage.jsonを作りたく無い場合はglobalにしてください。

yarn

yarn add --dev prettier @prettier/plugin-php
# or globally
yarn global add prettier @prettier/plugin-php

npm

npm install --save-dev prettier @prettier/plugin-php
# or globally
npm install --global prettier @prettier/plugin-php

2.設定ファイルの用意

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

singleQuote: true
trailingComma: all

3.使い方

Atomの場合

以下のプラグインを使用
https://github.com/prettier/prettier-atom

VScodeの場合

Run on Save という拡張機能をインストールする。
workspaceの設定にて以下を追記
※拡張子.phpに対して適用するようにしている。

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

PHPStormの場合

Preferencesを開いて、EXternal Toolsにて設定。