Add missing block/theme json $schema property

[sirreal]

What?

Add $schema to block.json and theme.json files to leverage JSON schema support.

Why?

Schemas help ensure that these files conform to expectations. They can help provide autocomplete and documentation if editors are configured to do so.

We provide and maintain these schemas, we should be using them. This can help to ensure that our own declarations are correct and that the schemas are also correct.

Testing Instructions

If you have an editor configured to show JSON schema information, you can open up one of these files and confirm it works as expected. I believe Visual Studio Code provides this behavior by default.

This change is a developer experience improvement and should not otherwise impact the behavior of Gutenberg or its packages.

Screenshots or screencast

[github-actions]

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/theme.json
❔ phpunit/data/themedir1/block-theme-child-with-fluid-layout/theme.json
❔ phpunit/data/themedir1/block-theme-child-with-fluid-typography-config/theme.json
❔ phpunit/data/themedir1/block-theme-child-with-fluid-typography/theme.json
❔ phpunit/data/themedir1/block-theme-child/theme.json
❔ phpunit/data/themedir1/block-theme/theme.json
❔ phpunit/data/themedir1/fonts-block-theme/theme.json
❔ phpunit/fixtures/block.json
❔ phpunit/fixtures/hooked-block/block.json

[sirreal]

I've run JSON schema validation on the project and found that some of the files touched here seem to have violations:

check-jsonschema --schemafile 'https://schemas.wp.org/trunk/block.json' $(find . -name block.json -not -path './schemas/**')

Results

  ./phpunit/fixtures/block.json::$: Additional properties are not allowed ('textDomain' was unexpected)
  ./phpunit/fixtures/hooked-block/block.json::$: 'title' is a required property
  ./packages/edit-widgets/src/blocks/widget-area/block.json::$: 'title' is a required property
  ./packages/widgets/src/blocks/widget-group/block.json::$: 'title' is a required property

---

check-jsonschema --schemafile 'https://schemas.wp.org/trunk/theme.json' $(find . -name theme.json -not -path './schemas/**')

Results

Schema validation errors were encountered.
  ./lib/theme.json::$.settings.color: Additional properties are not allowed ('caption' was unexpected)
  ./lib/theme.json::$.styles.elements.button.spacing.padding: 'calc(0.667em + 2px) calc(1.333em + 2px)' is not of type 'object'

[gziolo]

Nice, that’s helpful 👍

There is an integration test that validates core blocks:

gutenberg/test/integration/blocks-schema.test.js

Line 14 in fda1efc

const blockFolders = glob.sync( 'packages/block-library/src/*', {

It looks like the glob could also cover blocks created in the widgets package.

[sirreal]

I'm glad to see we have automation to check schemas, I'll look at enabling it for more places in another PR since that will require changes to the violating schemas.

[getdave]

@sirreal Please could you confirm whether you believe this PR requires backport for WP 6.5?

[sirreal]

The package changes should be handled by other workflows.

For other files I've created https://core.trac.wordpress.org/ticket/60255, I'll handle adding schemas to these JSON files in core. I'll remove the backport label.