Block Library: Move supports to block.json files for core blocks (#…

…22422) * Block Library: Move supports to block.json * Blocks: Add "features" alias for "supports" field * Block Library: Move "supports" to block.json files * Remove server-register.json generator in favor of reading block.json files * Remove temporary TODO code comments * Improve registration on the server for the Post Comments block * Move supports to block.json for Widget Area block * Fix rebase issue for Query blocks
WordPress · May 20, 2020 · d26842b · d26842b
1 parent 70f65da
commit d26842b
Show file tree

Hide file tree

Showing 113 changed files with 481 additions and 378 deletions.
diff --git a/bin/get-server-blocks.php b/bin/get-server-blocks.php
diff --git a/docs/rfc/block-registration.md b/docs/rfc/block-registration.md
@@ -77,6 +77,10 @@ To register a new block type, start by creating a `block.json` file. This file:
 			"selector": ".message"
 		}
 	},
+	"supports": {
+		"align": true,
+		"lightBlockWrapper": true
+	},
 	"styleVariations": [
 		{ "name": "default", "label": "Default", "isDefault": true },
 		{ "name": "other", "label": "Other" }
@@ -243,11 +247,22 @@ Attributes provide the structured data needs of a block. They can exist in diffe
 
 See the [the attributes documentation](/docs/designers-developers/developers/block-api/block-attributes.md) for more details.
 
+### Supports
+
+ *   Type: `object`
+ *   Optional
+ *   Localized: No
+ *   Property: `supports`
+
+ It contains as set of options to control features used in the editor.
+
+ See the [the supports documentation](/docs/designers-developers/developers/block-api/block-registration.md#supports-optional) for more details.
+
 ### Style Variations
 
 * Type: `array`
 * Optional
-* Localized: Yes (`label`)
+* Localized: Yes (`label` only)
 * Property: `styles`
 * Alias: `styleVariations`
 
@@ -323,7 +338,6 @@ The following properties are going to be supported for backward compatibility re
  - `save` - see the [Edit and Save](/docs/designers-developers/developers/block-api/block-edit-save.md) documentation for more details.
  - `transforms` - see the [Transforms](/docs/designers-developers/developers/block-api/block-registration.md#transforms-optional) documentation for more details.
  - `deprecated` - see the [Deprecated Blocks](/docs/designers-developers/developers/block-api/block-deprecation.md) documentation for more details.
- - `supports` - see the [block supports](/docs/designers-developers/developers/block-api/block-registration.md#supports-optional) documentation page for more details.
  - `merge` - undocumented as of today. Its role is to handle merging multiple blocks into one.
  - `getEditWrapperProps` - undocumented as well. Its role is to inject additional props to the block edit's component wrapper.
 
@@ -336,8 +350,8 @@ wp.blocks.registerBlockType( 'my-block/name', {
 	save: function() {
 		// Save definition goes here.
 	},
-	supports: {
-		html: false
+	getEditWrapperProps: function() {
+		// Implementation goes here.
 	}
 } );
 ```
@@ -413,7 +427,7 @@ WordPress string discovery automatically translates these strings using the `tex
 }
 ```
 
-In JavaScript, with the help of a Babel plugin, this becomes:
+In JavaScript, with the help of a new helper function `registerBlockTypeFromMetadata`, this becomes:
 
 ```js
 const metadata = {
@@ -423,7 +437,7 @@ const metadata = {
 }
 ```
 
-In PHP, it is transformed at runtime to code roughly equivalent to:
+In PHP, it is transformed at runtime with a new helper function `register_block_from_metadata` to code roughly equivalent to:
 
 ```php
 <?php

diff --git a/package.json b/package.json
@@ -203,8 +203,7 @@
 		"dev:packages": "node ./bin/packages/watch.js",
 		"docs:build": "node ./docs/tool/index.js && node ./bin/api-docs/update-api-docs.js",
 		"fixtures:clean": "rimraf \"packages/e2e-tests/fixtures/blocks/*.+(json|serialized.html)\"",
-		"fixtures:server-registered": "packages/env/bin/wp-env run wordpress ./wp-content/plugins/gutenberg/bin/get-server-blocks.php > test/integration/full-content/server-registered.json",
-		"fixtures:generate": "npm run fixtures:server-registered && cross-env GENERATE_MISSING_FIXTURES=y npm run test-unit",
+		"fixtures:generate": "cross-env GENERATE_MISSING_FIXTURES=y npm run test-unit",
 		"fixtures:regenerate": "npm run fixtures:clean && npm run fixtures:generate",
 		"format-js": "wp-scripts format-js",
 		"lint": "concurrently \"npm run lint-lockfile\" \"npm run lint-js\" \"npm run lint-pkg-json\" \"npm run lint-css\"",

diff --git a/packages/block-library/src/archives/block.json b/packages/block-library/src/archives/block.json
@@ -4,7 +4,13 @@
 	"attributes": {
 		"align": {
 			"type": "string",
-			"enum": [ "left", "center", "right", "wide", "full" ]
+			"enum": [
+				"left",
+				"center",
+				"right",
+				"wide",
+				"full"
+			]
 		},
 		"className": {
 			"type": "string"
@@ -17,5 +23,9 @@
 			"type": "boolean",
 			"default": false
 		}
+	},
+	"supports": {
+		"align": true,
+		"html": false
 	}
 }
diff --git a/packages/block-library/src/archives/index.js b/packages/block-library/src/archives/index.js
@@ -18,10 +18,6 @@ export const settings = {
 	title: __( 'Archives' ),
 	description: __( 'Display a monthly archive of your posts.' ),
 	icon,
-	supports: {
-		align: true,
-		html: false,
-	},
 	example: {},
 	edit,
 };
diff --git a/packages/block-library/src/audio/block.json b/packages/block-library/src/audio/block.json
@@ -34,5 +34,9 @@
 			"selector": "audio",
 			"attribute": "preload"
 		}
+	},
+	"supports": {
+		"align": true,
+		"lightBlockWrapper": true
 	}
 }
diff --git a/packages/block-library/src/audio/index.js b/packages/block-library/src/audio/index.js
@@ -29,10 +29,6 @@ export const settings = {
 	icon,
 	transforms,
 	deprecated,
-	supports: {
-		align: true,
-		lightBlockWrapper: true,
-	},
 	edit,
 	save,
 };
diff --git a/packages/block-library/src/block/block.json b/packages/block-library/src/block/block.json
@@ -5,5 +5,10 @@
 		"ref": {
 			"type": "number"
 		}
+	},
+	"supports": {
+		"customClassName": false,
+		"html": false,
+		"inserter": false
 	}
 }
diff --git a/packages/block-library/src/block/index.js b/packages/block-library/src/block/index.js
@@ -18,10 +18,5 @@ export const settings = {
 	description: __(
 		'Create and save content to reuse across your site. Update the block, and the changes apply everywhere it’s used.'
 	),
-	supports: {
-		customClassName: false,
-		html: false,
-		inserter: false,
-	},
 	edit,
 };
diff --git a/packages/block-library/src/button/block.json b/packages/block-library/src/button/block.json
@@ -1,6 +1,9 @@
 {
 	"name": "core/button",
 	"category": "layout",
+	"parent": [
+		"core/buttons"
+	],
 	"attributes": {
 		"url": {
 			"type": "string",
@@ -49,5 +52,11 @@
 		"gradient": {
 			"type": "string"
 		}
+	},
+	"supports": {
+		"align": true,
+		"alignWide": false,
+		"reusable": false,
+		"lightBlockWrapper": true
 	}
 }
diff --git a/packages/block-library/src/button/index.js b/packages/block-library/src/button/index.js
@@ -30,13 +30,6 @@ export const settings = {
 			text: __( 'Call to Action' ),
 		},
 	},
-	supports: {
-		align: true,
-		alignWide: false,
-		reusable: false,
-		lightBlockWrapper: true,
-	},
-	parent: [ 'core/buttons' ],
 	styles: [
 		{ name: 'fill', label: __( 'Fill' ), isDefault: true },
 		{ name: 'outline', label: __( 'Outline' ) },

diff --git a/packages/block-library/src/buttons/block.json b/packages/block-library/src/buttons/block.json
@@ -1,5 +1,9 @@
 {
 	"name": "core/buttons",
 	"category": "layout",
-	"attributes": {}
+	"supports": {
+		"align": true,
+		"alignWide": false,
+		"lightBlockWrapper": true
+	}
 }
diff --git a/packages/block-library/src/buttons/index.js b/packages/block-library/src/buttons/index.js
@@ -23,11 +23,6 @@ export const settings = {
 	),
 	icon,
 	keywords: [ __( 'link' ) ],
-	supports: {
-		align: true,
-		alignWide: false,
-		lightBlockWrapper: true,
-	},
 	transforms,
 	edit,
 	save,

diff --git a/packages/block-library/src/calendar/block.json b/packages/block-library/src/calendar/block.json
@@ -4,7 +4,13 @@
 	"attributes": {
 		"align": {
 			"type": "string",
-			"enum": [ "left", "center", "right", "wide", "full" ]
+			"enum": [
+				"left",
+				"center",
+				"right",
+				"wide",
+				"full"
+			]
 		},
 		"className": {
 			"type": "string"
@@ -15,5 +21,8 @@
 		"year": {
 			"type": "integer"
 		}
+	},
+	"supports": {
+		"align": true
 	}
 }
diff --git a/packages/block-library/src/calendar/index.js b/packages/block-library/src/calendar/index.js
@@ -19,9 +19,6 @@ export const settings = {
 	description: __( 'A calendar of your site’s posts.' ),
 	icon,
 	keywords: [ __( 'posts' ), __( 'archive' ) ],
-	supports: {
-		align: true,
-	},
 	example: {},
 	edit,
 };
diff --git a/packages/block-library/src/categories/block.json b/packages/block-library/src/categories/block.json
@@ -4,7 +4,13 @@
 	"attributes": {
 		"align": {
 			"type": "string",
-			"enum": [ "left", "center", "right", "wide", "full" ]
+			"enum": [
+				"left",
+				"center",
+				"right",
+				"wide",
+				"full"
+			]
 		},
 		"className": {
 			"type": "string"
@@ -21,5 +27,9 @@
 			"type": "boolean",
 			"default": false
 		}
+	},
+	"supports": {
+		"align": true,
+		"html": false
 	}
 }
diff --git a/packages/block-library/src/categories/index.js b/packages/block-library/src/categories/index.js
@@ -18,10 +18,6 @@ export const settings = {
 	title: __( 'Categories' ),
 	description: __( 'Display a list of all categories.' ),
 	icon,
-	supports: {
-		align: true,
-		html: false,
-	},
 	example: {},
 	edit,
 };
diff --git a/packages/block-library/src/classic/block.json b/packages/block-library/src/classic/block.json
@@ -6,5 +6,10 @@
 			"type": "string",
 			"source": "html"
 		}
+	},
+	"supports": {
+		"className": false,
+		"customClassName": false,
+		"reusable": false
 	}
 }
diff --git a/packages/block-library/src/classic/index.js b/packages/block-library/src/classic/index.js
@@ -19,13 +19,6 @@ export const settings = {
 	title: _x( 'Classic', 'block title' ),
 	description: __( 'Use the classic WordPress editor.' ),
 	icon,
-	supports: {
-		className: false,
-		customClassName: false,
-		// Hide 'Add to Reusable blocks' on Classic blocks. Showing it causes a
-		// confusing UX, because of its similarity to the 'Convert to Blocks' button.
-		reusable: false,
-	},
 	edit,
 	save,
 };
diff --git a/packages/block-library/src/code/block.json b/packages/block-library/src/code/block.json
@@ -7,5 +7,9 @@
 			"source": "text",
 			"selector": "code"
 		}
+	},
+	"supports": {
+		"html": false,
+		"lightBlockWrapper": true
 	}
 }
diff --git a/packages/block-library/src/code/index.js b/packages/block-library/src/code/index.js
@@ -32,10 +32,6 @@ export const settings = {
 			/* eslint-enable @wordpress/i18n-no-collapsible-whitespace */
 		},
 	},
-	supports: {
-		html: false,
-		lightBlockWrapper: true,
-	},
 	transforms,
 	edit,
 	save,

diff --git a/packages/block-library/src/column/block.json b/packages/block-library/src/column/block.json
@@ -1,6 +1,9 @@
 {
 	"name": "core/column",
 	"category": "common",
+	"parent": [
+		"core/columns"
+	],
 	"attributes": {
 		"verticalAlignment": {
 			"type": "string"
@@ -10,5 +13,10 @@
 			"min": 0,
 			"max": 100
 		}
+	},
+	"supports": {
+		"reusable": false,
+		"html": false,
+		"lightBlockWrapper": true
 	}
 }