From cddece7aa953f8e8329661e0d43fc4a618f62e77 Mon Sep 17 00:00:00 2001 From: Dave Smith Date: Tue, 28 Jun 2022 10:06:51 +0100 Subject: [PATCH] Add local dev notes to docs to aid with doing work on schemas (#41968) --- schemas/README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/schemas/README.md b/schemas/README.md index a862bbd83c702..1b2d8992cccb9 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -34,4 +34,30 @@ For a specific version of the schema, replace `trunk` with `wp/X.X`: Visual Studio Code and PhpStorm are two popular editors that work out of the box. However, some editors require a plugin installed, and not all editors recognize the `$schema` property. Check your editor's documentation for details. Additionally, [SchemaStore.org](https://www.schemastore.org/) and [JSON Schema](https://json-schema.org/implementations.html#editors) have lists of editors known to have support if your current editor is unsupported. +## Local Development + +You may wish to update one of the schemas to conform to a new change in the structure. In order to do this you'll want to be able to see how your changes impact how your IDE displays schema information. + +To allow this you will need to: + +- update your theme's `theme.json` to reference the _local_ version of the schema file: + +```json +{ + "$schema": "file://{{FULL_FILE_PATH}}/schemas/json/theme.json" +} +``` + +- update your block's `block.json` to include: + +```json +{ + "$schema": "file://{{FULL_FILE_PATH}}/schemas/json/block.json" +} +``` + +Be sure to replace `{{FULL_FILE_PATH}}` with the full local path to your Gutenberg repo. + +With this in place you should now be able to edit either `schemas/json/theme .json` or `schemas/json/block.json` in order to see changes reflected in `theme.json` or `block.json` in your IDE. +

Code is Poetry.