パス(PATH)の設定なし!VSCodeでPHPファイルを整形(フォーマット)する拡張機能「Format HTML in PHP」

WordPress
この記事は約5分で読めます。

WordPressでしかPHPしか触らないという方におすすめ

こちらのプラグインはガッツリphp構文のみで出来上がったphpファイルではなく、WordPressサイトで見かけるような、とんどがHTMLで構成されたphpファイルを整形するのに向いている拡張機能です。

PHPの拡張機能で挫折しがちな「パス(PATH)」の設定は一切なし!

VSCodeでphpファイルを開いたとき、右下に変な警告が出ますよね。

あれを解消するにはパソコンにPHPを入れてゴニョゴニョする必要があるのですが、
このプラグインではそのような面倒なことはしなくてOKです!インストールしてチョロっと設定するだけ。

Format HTML in PHP導入方法

前提として、私の場合はVSCodeのフォーマッターに「Beautify」を設定しています。

Prittierなどを使っている場合はもしかするとどこかで上手くいかないかもしれませんのでご了承くださいm(_ _)m

①「Format HTML in PHP」をインストールする

②setting.jsonで設定をする(必要に応じて)

基本的にインストールして再起動すれば「ctrl + alt + F」で動作するそうです。

私の場合は保存時に自動整形されるように設定しています。

自動整形について拡張機能のドキュメントには以下のように書かれています。

Turn on format on save either globally or scoped to PHP.
自動整形するなら全体の保存時フォーマットをオンにするか、PHPファイルだけ自動整形させるかしてね)
ということで、VSCodeの設定で「保存時にフォーマットする」をONにしていない人は以下からの設定が必要になります。

フォーマットの設定①保存時のフォーマット

「ファイル > ユーザー設定 > 設定」を開いて、右上のファイルアイコンをクリックしてsetting.jsonを開きます。

「Ctrl」+「,」でも設定が開けます!(最近知りました(;^ω^))

「HTMLやCSSなどで自動整形したくない!」という方は、下記のコードをsetting.jsonに書き加えましょう。

"editor.formatOnSave": false,
"[php]": {
  "editor.formatOnSave": true
}

phpも含めて全ファイルフォーマットしたいという方は上記コードの”editor.formatOnSave”をtrueにしてください。

ちなみに私は全ファイル保存時フォーマットにしています。

フォーマット設定②HTMLに則った細かい設定

HTMLの整形ルールも併せて紹介されていました。基本的に何も書かなくてよいかと。
改めて見直してみて、自分に必要そうであれば書いておきましょう。

"editor.insertSpaces": true,
//インデントに使う文字をスペースにする(falseだとタブ)
"editor.tabSize": 4, //タブのサイズ
"html.format.contentUnformatted": "pre,code,textarea",
//このタグ内ではフォーマットしない
"html.format.endWithNewline": false, //末尾に改行を入れる
"html.format.extraLiners": "head, body, /html", //このタグの直前に改行を入れる
"html.format.indentHandlebars": false, //Handlebarsの式({{expression}})の内側がHandlebarsの式を基準にインデントされる(HandlebarsはJavaScriptのテンプレートエンジン
"html.format.indentInnerHtml": false, //<head>セクションと<body>セクションをインデントする
"html.format.maxPreserveNewLines": null, //1つのチャンク内に保持できる改行の最大数
"html.format.preserveNewLines": true, //要素の前にある既存の改行を保持するかどうか
"html.format.wrapLineLength": 120, //1行あたりの最大文字数(0で無効)
"html.format.wrapAttributes": "auto",
//属性を折り返します。

詳しく知りたい方は下記ページを参照ください。

フォーマット後にスペース(タブ)が赤くエラーっぽくなる場合の対処

phpファイルをフォーマットするとスペースが赤くなる場合があります。

そういう場合はVSCodeのファイルごとの設定をいじります。

右下にあるスペース(タブ)のサイズをフォーマットのサイズと合わせます。
(フォーマットサイズは先ほどのHTMLの設定でできます)

これでスペース(タブ)の色がいつも通りになったかと思います。

setting.jsonのフォーマット

beatifyではjsonファイルのフォーマットができません。

jsonファイルのフォーマッターもあると思いますが、そもそもそんなにjsonファイルを使わないので拡張機能は入れていません。

jsonファイルを開いている時に右クリックして「ドキュメントのフォーマット」(ショートカットキーが書いてない方)をクリックすればフォーマットされます。

 

 

コメント

タイトルとURLをコピーしました