Merged
Conversation
This adds the schema defintinon to the top of the generated block.json file: "$schema": "https://json.schemastore.org/block.json", This makes it easier to work with the `block.json` file in devleopment, with supported editors it offers tooltips, autocomplete, and schema validation.
|
Size Change: 0 B Total Size: 1.07 MB ℹ️ View Unchanged
|
ajlende
approved these changes
Oct 21, 2021
Contributor
ajlende
left a comment
There was a problem hiding this comment.
I'm a little hesitant to add a URL that isn't a wordpress.org URL as the default in a generator, but maybe I'm just being overly sensitive about it. The schema can be really helpful and this will help folks find it easier, so 👍 from me.
Member
Author
|
@ajlende I think it is ok since it is "purely sugar" no functionality will break if the URL disappears, and I can't imagine a security scenario if the URL came under malicious control. |
Member
Out of curiosity, how much work it would be to keep the schema in Gutenberg repository, possibly inside I love the idea of having a schema that could be used for validation and I'd be in favor in tighter integration into the existing tooling. One immediate idea for a follow-up for this PR would be to run https://github.com/WordPress/gutenberg/blob/trunk/bin/test-create-block.sh |
gziolo
approved these changes
Oct 22, 2021
8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This adds the schema defintinon to the top of the generated block.json
file:
This makes it easier to work with the
block.jsonfile in devleopment,with supported editors it offers tooltips, autocomplete, and schema
validation.
How has this been tested?
To test:
Types of changes
Updates the create-block script to add the $schema definition.
No functional change, an improvement for development.