WordPresのGutenberg Componentsでの開発時、VS CodeのPrettierで自動整形する方法

WordPressでGutenberg Componentsを使って開発をしようとすると、「@wordpress/scripts」を使ってJacaScriptで開発することになります。

WordPresにはコーディング規約があり、JavaScriptにもあります。

自分で守ってもよいのですが、Prettierを使うと保存時にWordPres規約に沿った自動修正をしてくれるので便利です。

PrettierをWordPresのコーディング規約に沿ったものにするには設定が要ります。

VS Codeで設定する方法を紹介します。

Prettierはインストール&設定済みの前提です。

インストール

「@wordpress/scripts」を使っていれば、「node_modules/@wordpress/」下に、「prettier-config」というファイルがはるはずなので特に追加でインストールする必要はない。

「@wordpress/scripts」を使っていなければ、下記コマンドでインストール。「@wordpress/scripts」を使っている状態で下記コマンドを実行すると、@wordpress下の足のファイルが消えるので注意。

$ npm install @wordpress/prettier-config --save-dev

設定

package.jsonに下記記述を追加。

"prettier": "@wordpress/prettier-config"

あるいは、.prettierrc ファイルに下記記述を追加。

extends: ['@wordpress/prettier-config']

これでPrettierがWordPresの規約に沿った自動整形を行ってくれます。便利。

おわりに

VS CodeでPHPをWordPresのコーディング規約に沿った設定にするのは躓いていますが、JavaScriptはサラッと設定できて良かったです。