はじめに
WordPress には設定ファイル (theme.json
や wp-env.json
等)が複数存在します。
これらのファイルの定義は多数あり完璧に覚えることは困難です。
設定ファイル (theme.json
や wp-env.json
等) に対して $schema JSON Schema の定義を追加することでエディタに補完してもらいスムーズに開発を進めることができます。
JSON Schema とは
JSON Schema については以下記事等を参考にしてください。
JSON Schema の定義を追加する。
今回は WordPress の開発環境ツール wp-env
の設定ファイル wp-env.json
を例に記載します。
wp-env.json
の schema 定義は以下URLで公開されています。
https://schemas.wp.org/trunk/wp-env.json
wp-env.json
内に "$schema": "https://schemas.wp.org/trunk/wp-env.json"
を定義すれば OKです。
{
"$schema": "https://schemas.wp.org/trunk/wp-env.json"
}
ただし、ドキュメントにも記載がありますがバージョンを指定して JSON Schema を読み込めない点には注意が必要です。
その他 JSON Schema 定義
今回は、 wp-env.json
を例に記載しましたが以下設定用の schema ファイルも用意されています。
- theme.json
- block.json
- font-collection.json
- wp-env.json
- blueprint.json
- WordPress REST API
ファイル毎に参照先が異なりますので詳しくは下記URLを確認して設定してください。
Ref