Add JSON Schema for WordPress `block.json` files by fabiankaegy · Pull Request #1879 · SchemaStore/schemastore

fabiankaegy · 2021-10-13T20:11:18Z

This PR adds a JSON Schema for the block.json file used in WordPress development to define metadata for blocks for the editor.
The reference this schema is based on can be found here: https://developer.wordpress.org/block-editor/reference-guides/block-api/block-metadata/

Closes #1878

fabiankaegy · 2021-10-13T22:37:06Z

@ajlende since you did the work on #1874 I'd love to get your thoughts on the addition of the block.json schema I added here. I think it is now ready for review but I would love your feedback before actually marking this as "Ready for review" and therefore subject to get merged.

ajlende

This is great! I'm very happy that other folks are taking this schema thing and running with it for WordPress. 🙂

I noted a few of my personal opinions about styling for schemas. A lot of my inspiration for theme-v1.json came from the tsconfig.json schema since that was a popular project that I was familiar with. If we have a better way to do thing, we should do it the better way—I'm not very strongly opinionated on the things that I mentioned.

The one thing that I do think needs to be changed before merging is removing __experimentalDuotone. More notes about that in the inline comment.

src/schemas/json/block.json

…t` `items` / `properties`

fabiankaegy · 2021-10-15T07:31:22Z

@ajlende Thank you so much for your thorough review. I have taken your feedback and fixed the different suggestions. I wasn't able to cut down all the descriptions to the 2 sentence limit since I think in the cases where they go past that it is because it shares valuable information.

ajlende · 2021-10-15T13:52:54Z

I love it! Thanks for your work on this! ❤️

madskristensen · 2021-10-15T15:39:37Z

Let me know when ready to merge

fabiankaegy · 2021-10-15T15:42:27Z

@madskristensen We are :)

ajlende · 2021-10-15T16:16:03Z

################ Error message
>> compile    | schemas/json/block.json (draft-04)
>> Error: strict mode: unknown keyword: "deprecated"
##############################

For this error, we may want to either note that it's deprecated in the description or remove the property altogether. I'd rather stick to draft-04 than updating to 2019-09 which adds deprecated keyword because draft-04 is more widely supported in general and because the WordPress JSON Schema validator (currently only used for REST APIs AFAIK) only supports draft-04 as well.

That being said, the markdownDescription property that is used in the tsconfig isn't part of draft-04 either, and it looks like we can add exceptions in https://github.com/SchemaStore/schemastore/blob/4608f1f42725b22ad4c82462a09b16c6ad8eb60f/src/schema-validation.json if we want to go that route.

fabiankaegy · 2021-10-15T17:42:28Z

I just removed the deprecated property since the description already has it written in it.

@madskristensen So it is ready to be merged :)

madskristensen · 2021-10-18T16:29:36Z

Thanks

Updates documentation recommending to use schema validation. A block.json JSON schema was added to the SchemaStore that allows for editors to provide additional tooltip, autocomplete, and some validation when working with a block.json file. Added in: SchemaStore/schemastore#1879

oandregal · 2021-10-25T15:58:30Z

src/schemas/json/block.json

+                  "items": {
+                    "type": "string",
+                    "enum": [
+                      "vertical"


Hey, according to the PR that introduced support for this in Gutenberg, there are a couple of options to declare support for padding at https://github.com/WordPress/gutenberg/pull/33859/files#diff-cb2052b95e3c5b5fa711f6519d1e3c376597cd1747e6a0a781dc51447255ef16R588

boolean

individual properties: an array that can contain any of top, left, bottom, right

axial properties: an array that can contain any of vertical, horizontal

From what I've gathered in this PR I presume that we don't need two items, one for vertical here and the other for horizontal below, but, instead, we need to declare the enum like [ 'vertical', 'horizontal' ]. Does that make sense? It seems this is creating issues, see WordPress/gutenberg#35902 (comment)

Same for the margin declaration.

cc @fabiankaegy @ajlende

Thanks for catching that. I misread the following line

A spacing property may support arbitrary individual sides or axial sides, but not a mix of both.

from the handbook to mean that it can only have either or of the axial controls but rereading it that was incorrect.

fabiankaegy added 6 commits October 13, 2021 22:10

start working on wordpress block.json schema

2222101

add all top level definitions

9032745

add deffinition of all subtypes

af6a51d

fix patterns

a45abd3

add refference links

212b4c1

update example schema

7014dd2

fix type of attribute.default

5276429

ajlende reviewed Oct 15, 2021

View reviewed changes

fabiankaegy added 7 commits October 15, 2021 08:49

remove __experimentalDuotone from the schema

9a1f3a2

fix typo in references and switch to camelCase

de6a953

reorder properties to follow the pattern type description `defaul…

838f450

…t` `items` / `properties`

fix description length

0415799

fix schema of supports.spacing

8c2a40b

update example

52c7316

cut down on length of descriptions

ec8c13b

fabiankaegy marked this pull request as ready for review October 15, 2021 07:31

fabiankaegy changed the title ~~Draft: Add WordPress block.json schema~~ Add WordPress block.json schema Oct 15, 2021

fabiankaegy changed the title ~~Add WordPress block.json schema~~ Add JSON Schema for WordPress block.json files Oct 15, 2021

remove unsupported deprecated attribute

2792c3d

madskristensen merged commit 8f71ddd into SchemaStore:master Oct 18, 2021

mkaz mentioned this pull request Oct 21, 2021

Docs: Add section about using the schema during development WordPress/gutenberg#35835

Merged

oandregal reviewed Oct 25, 2021

View reviewed changes

oandregal mentioned this pull request Oct 25, 2021

Validation issues with block.json in a few core blocks WordPress/gutenberg#35902

Closed

8 tasks

fabiankaegy mentioned this pull request Oct 25, 2021

Move fontSize and lineHeight properties to typography object #1898

Merged

fabiankaegy mentioned this pull request Nov 9, 2021

Tests: Add integration tests with core blocks schema validation WordPress/gutenberg#36351

Merged

4 tasks

Uh oh!

Conversation

fabiankaegy commented Oct 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fabiankaegy commented Oct 13, 2021

Uh oh!

ajlende left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fabiankaegy commented Oct 15, 2021

Uh oh!

ajlende commented Oct 15, 2021

Uh oh!

madskristensen commented Oct 15, 2021

Uh oh!

fabiankaegy commented Oct 15, 2021

Uh oh!

ajlende commented Oct 15, 2021

Uh oh!

fabiankaegy commented Oct 15, 2021

Uh oh!

madskristensen commented Oct 18, 2021

Uh oh!

oandregal Oct 25, 2021

Choose a reason for hiding this comment

Uh oh!

ajlende Oct 25, 2021

Choose a reason for hiding this comment

Uh oh!

fabiankaegy Oct 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fabiankaegy commented Oct 13, 2021 •

edited

Loading

fabiankaegy Oct 25, 2021 •

edited

Loading