Add block.json schema defintion to core blocks (#35900)

* Add block.json schema defintion to core blocks Adds the schema defintion to the top of each core block to help development, in supported editors the schema definition will show validation errors, offer tooltips and autocomplete. Schema definition: "$schema": "https://json.schemastore.org/block.json", * Update packages/block-library/CHANGELOG.md * Switch URL to wp.org with redirect Co-authored-by: Greg Ziółkowski <[email protected]>
WordPress · Nov 9, 2021 · bc78b2c · bc78b2c
1 parent db67d94
commit bc78b2c
Show file tree

Hide file tree

Showing 78 changed files with 92 additions and 33 deletions.
diff --git a/packages/block-library/CHANGELOG.md b/packages/block-library/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Code quality: Add block schema to each core block ([#35900](https://github.com/WordPress/gutenberg/pull/35900)).
+
 ## 6.0.0 (2021-09-09)
 
 ### Breaking Change

diff --git a/packages/block-library/src/archives/block.json b/packages/block-library/src/archives/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/archives",
  "title": "Archives",

diff --git a/packages/block-library/src/audio/block.json b/packages/block-library/src/audio/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/audio",
  "title": "Audio",

diff --git a/packages/block-library/src/block/block.json b/packages/block-library/src/block/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/block",
  "title": "Reusable block",

diff --git a/packages/block-library/src/button/block.json b/packages/block-library/src/button/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/button",
  "title": "Button",

diff --git a/packages/block-library/src/buttons/block.json b/packages/block-library/src/buttons/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/buttons",
  "title": "Buttons",
@@ -12,7 +13,7 @@
  "__experimentalExposeControlsToChildren": true,
  "spacing": {
  "blockGap": true,
- "margin": ["top", "bottom" ],
+ "margin": [ "top", "bottom" ],
  "__experimentalDefaultControls": {
  "blockGap": true
  }

diff --git a/packages/block-library/src/calendar/block.json b/packages/block-library/src/calendar/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/calendar",
  "title": "Calendar",

diff --git a/packages/block-library/src/categories/block.json b/packages/block-library/src/categories/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/categories",
  "title": "Categories",

diff --git a/packages/block-library/src/code/block.json b/packages/block-library/src/code/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/code",
  "title": "Code",

diff --git a/packages/block-library/src/column/block.json b/packages/block-library/src/column/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/column",
  "title": "Column",

diff --git a/packages/block-library/src/columns/block.json b/packages/block-library/src/columns/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/columns",
  "title": "Columns",

diff --git a/packages/block-library/src/comment-author-name/block.json b/packages/block-library/src/comment-author-name/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/comment-author-name",
  "title": "Comment Author Name",

diff --git a/packages/block-library/src/comment-content/block.json b/packages/block-library/src/comment-content/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/comment-content",
  "title": "Comment Content",

diff --git a/packages/block-library/src/comment-date/block.json b/packages/block-library/src/comment-date/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/comment-date",
  "title": "Comment Date",

diff --git a/packages/block-library/src/cover/block.json b/packages/block-library/src/cover/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/cover",
  "title": "Cover",

diff --git a/packages/block-library/src/embed/block.json b/packages/block-library/src/embed/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/embed",
  "title": "Embed",

diff --git a/packages/block-library/src/file/block.json b/packages/block-library/src/file/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/file",
  "title": "File",

diff --git a/packages/block-library/src/freeform/block.json b/packages/block-library/src/freeform/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/freeform",
  "title": "Classic",

diff --git a/packages/block-library/src/gallery/block.json b/packages/block-library/src/gallery/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/gallery",
  "title": "Gallery",

diff --git a/packages/block-library/src/group/block.json b/packages/block-library/src/group/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/group",
  "title": "Group",

diff --git a/packages/block-library/src/heading/block.json b/packages/block-library/src/heading/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/heading",
  "title": "Heading",

diff --git a/packages/block-library/src/home-link/block.json b/packages/block-library/src/home-link/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/home-link",
  "category": "design",

diff --git a/packages/block-library/src/html/block.json b/packages/block-library/src/html/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/html",
  "title": "Custom HTML",

diff --git a/packages/block-library/src/image/block.json b/packages/block-library/src/image/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/image",
  "title": "Image",

diff --git a/packages/block-library/src/latest-comments/block.json b/packages/block-library/src/latest-comments/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/latest-comments",
  "title": "Latest Comments",

diff --git a/packages/block-library/src/latest-posts/block.json b/packages/block-library/src/latest-posts/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/latest-posts",
  "title": "Latest Posts",

diff --git a/packages/block-library/src/list/block.json b/packages/block-library/src/list/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/list",
  "title": "List",

diff --git a/packages/block-library/src/loginout/block.json b/packages/block-library/src/loginout/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/loginout",
  "title": "Login/out",

diff --git a/packages/block-library/src/media-text/block.json b/packages/block-library/src/media-text/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/media-text",
  "title": "Media & Text",

diff --git a/packages/block-library/src/missing/block.json b/packages/block-library/src/missing/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/missing",
  "title": "Unsupported",

diff --git a/packages/block-library/src/more/block.json b/packages/block-library/src/more/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/more",
  "title": "More",

diff --git a/packages/block-library/src/navigation-link/block.json b/packages/block-library/src/navigation-link/block.json
@@ -1,11 +1,10 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/navigation-link",
  "title": "Custom Link",
  "category": "design",
- "parent": [
- "core/navigation"
- ],
+ "parent": [ "core/navigation" ],
  "description": "Add a page, link, or another item to your navigation.",
  "textdomain": "default",
  "attributes": {

diff --git a/packages/block-library/src/navigation-submenu/block.json b/packages/block-library/src/navigation-submenu/block.json
@@ -1,11 +1,10 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/navigation-submenu",
  "title": "Submenu",
  "category": "design",
- "parent": [
- "core/navigation"
- ],
+ "parent": [ "core/navigation" ],
  "description": "Add a submenu to your navigation.",
  "textdomain": "default",
  "attributes": {

diff --git a/packages/block-library/src/navigation/block.json b/packages/block-library/src/navigation/block.json
@@ -1,14 +1,11 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/navigation",
  "title": "Navigation",
  "category": "theme",
  "description": "A collection of blocks that allow visitors to get around your site.",
- "keywords": [
- "menu",
- "navigation",
- "links"
- ],
+ "keywords": [ "menu", "navigation", "links" ],
  "textdomain": "default",
  "attributes": {
  "navigationMenuId": {
@@ -78,10 +75,7 @@
  "orientation": "orientation"
  },
  "supports": {
- "align": [
- "wide",
- "full"
- ],
+ "align": [ "wide", "full" ],
  "anchor": true,
  "html": false,
  "inserter": true,
@@ -99,13 +93,7 @@
  },
  "spacing": {
  "blockGap": true,
- "units": [
- "px",
- "em",
- "rem",
- "vh",
- "vw"
- ],
+ "units": [ "px", "em", "rem", "vh", "vw" ],
  "__experimentalDefaultControls": {
  "blockGap": true
  }

diff --git a/packages/block-library/src/nextpage/block.json b/packages/block-library/src/nextpage/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/nextpage",
  "title": "Page Break",

diff --git a/packages/block-library/src/page-list/block.json b/packages/block-library/src/page-list/block.json
@@ -1,13 +1,13 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/page-list",
  "title": "Page List",
  "category": "widgets",
  "description": "Display a list of all pages.",
  "keywords": [ "menu", "navigation" ],
  "textdomain": "default",
- "attributes": {
- },
+ "attributes": {},
  "usesContext": [
  "textColor",
  "customTextColor",

diff --git a/packages/block-library/src/paragraph/block.json b/packages/block-library/src/paragraph/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/paragraph",
  "title": "Paragraph",

diff --git a/packages/block-library/src/post-author/block.json b/packages/block-library/src/post-author/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-author",
  "title": "Post Author",

diff --git a/packages/block-library/src/post-comment/block.json b/packages/block-library/src/post-comment/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-comment",
  "title": "Post Comment (deprecated)",

diff --git a/packages/block-library/src/post-comments-count/block.json b/packages/block-library/src/post-comments-count/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-comments-count",
  "title": "Post Comments Count",

diff --git a/packages/block-library/src/post-comments-form/block.json b/packages/block-library/src/post-comments-form/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-comments-form",
  "title": "Post Comments Form",
@@ -29,5 +30,9 @@
  }
  }
  },
- "style": [ "wp-block-post-comments-form", "wp-block-buttons", "wp-block-button" ]
+ "style": [
+ "wp-block-post-comments-form",
+ "wp-block-buttons",
+ "wp-block-button"
+ ]
 }
diff --git a/packages/block-library/src/post-comments-link/block.json b/packages/block-library/src/post-comments-link/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-comments-link",
  "title": "Post Comments Link",

diff --git a/packages/block-library/src/post-comments/block.json b/packages/block-library/src/post-comments/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-comments",
  "title": "Post Comments",

diff --git a/packages/block-library/src/post-content/block.json b/packages/block-library/src/post-content/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-content",
  "title": "Post Content",

diff --git a/packages/block-library/src/post-date/block.json b/packages/block-library/src/post-date/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-date",
  "title": "Post Date",

diff --git a/packages/block-library/src/post-excerpt/block.json b/packages/block-library/src/post-excerpt/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-excerpt",
  "title": "Post Excerpt",

diff --git a/packages/block-library/src/post-featured-image/block.json b/packages/block-library/src/post-featured-image/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-featured-image",
  "title": "Post Featured Image",

diff --git a/packages/block-library/src/post-navigation-link/block.json b/packages/block-library/src/post-navigation-link/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-navigation-link",
  "title": "Post Navigation Link",

diff --git a/packages/block-library/src/post-template/block.json b/packages/block-library/src/post-template/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-template",
  "title": "Post Template",

diff --git a/packages/block-library/src/post-terms/block.json b/packages/block-library/src/post-terms/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-terms",
  "title": "Post Terms",

diff --git a/packages/block-library/src/post-title/block.json b/packages/block-library/src/post-title/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/post-title",
  "title": "Post Title",

diff --git a/packages/block-library/src/preformatted/block.json b/packages/block-library/src/preformatted/block.json
@@ -1,4 +1,5 @@
 {
+ "$schema": "https://schemas.wp.org/trunk/block.json",
  "apiVersion": 2,
  "name": "core/preformatted",
  "title": "Preformatted",