JSON Schema Reorganization and Fixes

[ajlende]

What?

Post-update code organization for JSON schema.

JSON structure changes:

• Inline useRootPaddingAwareAlignments property.
• Inline fontFace items.
• Sort settingsProperties alphabetically.
• Ensure every subschema with properties has "type": "object".
• Ensure every subschema with propertyNames has "type": "object".
• Alphabetize stylesProperties.

Fixes:

• Remove references to WordPress versions.
• Add missing ref support for textAlign and textColumns.
• Reuse #/definitions/stylesElementsPseudoSelectorsProperties

Why?

Follow-up to #62462 to fix some things found while working on it.

How?

See the commits for details.

Testing Instructions

Check that the new docs and new schema look correct.

Do all of the properties seem like they're in an intuitive order that makes sense?

Is the JSON file readable? Would you more easily be able to figure out where to add a new property if you need to?

Testing Instructions for Keyboard

N/A

Screenshots or screencast

N/A

[github-actions]

Flaky tests detected in b313e3b.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9950837869
📝 Reported issues:

• [Flaky Test] Regression: updating a specific option will only change its value and will not corrupt others #62179 in /test/e2e/specs/editor/various/core-settings.spec.js

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: ajlende <ajlende@git.wordpress.org>
Co-authored-by: scruffian <scruffian@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[ajlende]

useRootPaddingAwareAlignments is removed in this PR, but returned in #63639. I wanted to keep the codegen changes in a separate PR, but the existing codegen didn't support the refactored structure which is why it is missing here.

[scruffian]

Do all of the properties seem like they're in an intuitive order that makes sense?

Yeah, alphabetising them makes sense to me, and is as good as any other approach I can think of!

Is the JSON file readable? Would you more easily be able to figure out where to add a new property if you need to?

Yeah, it looks clear to me.

[t-hamano]

Thanks for the cleanup!

Here are some things I noticed, but they're very minor and may not need any action.

If the description field has highest priority in sorting, would it be better to move these fields as well?

gutenberg/schemas/json/font-collection.json

Line 133 in d22658b

"description": "Array of category slugs.",

gutenberg/schemas/json/theme.json

Lines 2582 to 2600 in d22658b

	"title": {
	"type": "string",
	"description": "Title of the global styles variation. If not defined, the file name will be used."
	},
	"slug": {
	"type": "string",
	"description": "Slug of the global styles variation. If not defined, the kebab-case title will be used."
	},
	"description": {
	"type": "string",
	"description": "Description of the global styles variation."
	},
	"blockTypes": {
	"type": "array",
	"description": "List of block types that can use the block style variation this theme.json file represents.",
	"items": {
	"type": "string"
	}
	},

Do these need type:string?

gutenberg/schemas/json/wp-env.json

Line 69 in d22658b

"enum": [

gutenberg/schemas/json/theme.json

Line 814 in d22658b

"enum": [

gutenberg/schemas/json/theme.json

Line 1683 in d22658b

"enum": [

gutenberg/schemas/json/theme.json

Line 1733 in d22658b

"enum": [

Is this type:object unnecessary?

gutenberg/schemas/json/wp-env.json

Line 96 in d22658b

"type": "object",

[t-hamano]

LGTM! To ship this PR, we need to merge #63583 first, right?

[ajlende]

If the description field has highest priority in sorting, would it be better to move these fields as well?

Yeah, looks like I missed some. I did a search through the project for the regex (?<!\{\n\s*)"description" which should turn up any descriptions that are not first in their object, and fixed all of them now.

I also did a similar search for "default": [^,]+, which should be the same for the defaults at the end.

Do these need type:string?

All propertyNames are evaluated as strings according to the specification, so I didn't include it if the enum was for propertyNames. But since it doesn't matter if it's included or not, maybe the consistency of always including a type with an enum would help people remember to add it in the other places too?

Do you have an opinion on that? I can see it either way.

Is this type:object unnecessary?

No, but I should have moved it alongside propertyNames.

One of my goals with the refactoring was to make sure that all instances of "allOf" included complete schemas with types inside and nothing outside. Technically it isn't invalid to have the "type": "object" outside, but I think it'll be more clear that each subschema gets validated independently of the others this way.