@wordpress/create-block 2.5.1 → 2.7.2-next.33ec3857e2.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 ## Unreleased
 
+## 2.7.1-next.0 (2021-12-20)
+
+### Internal
+
+-   The bundled `npm-package-arg` dependency has been updated from requiring `^8.0.1` to requiring `^8.1.5` ([#37395](https://github.com/WordPress/gutenberg/pull/37395)).
+
+## 2.7.0 (2021-11-07)
+
+### New Features
+
+-   Add $schema definition to generated `block.json` file.
+
+## 2.6.0 (2021-10-22)
+
+### New Features
+
+-   Add passing local directories to --template. ([#35645](https://github.com/WordPress/gutenberg/pull/35645))
+-   Add `slugPascalCase` to the list of variables that can be used in templates ([#35462](https://github.com/WordPress/gutenberg/pull/35462))
+
 ## 2.5.0 (2021-07-21)
 
 ### Enhancements

package/README.md

@@ -40,7 +40,7 @@ Options:
 
 ```bash
 -V, --version                output the version number
--t, --template <name>        block template type name, allowed values: "es5", "esnext", or the name of an external npm package (default: "esnext")
+-t, --template <name>        block template type name, allowed values: "es5", "esnext", the name of an external npm package (default: "esnext"), or the path to a local directory.
 --namespace <value>          internal namespace for the block name
 --title <value>              display title for the block
 --short-description <value>  short description for the block
@@ -65,7 +65,13 @@ $ npx @wordpress/create-block
 $ npx @wordpress/create-block --template es5
 ```
 
-3. Help – you need to use `npx` to output usage information.
+3. Local template directory – it is also possible to pick a local directory as a template.
+
+```bash
+$ npx @wordpress/create-block --template ./path/to/template
+```
+
+4. Help – you need to use `npx` to output usage information.
 
 ```bash
 $ npx @wordpress/create-block --help
@@ -171,6 +177,7 @@ module.exports = {
 
 The following configurable variables are used with the template files. Template authors can change default values to use when users don't provide their data:
 
+-   `$schema` (default: `https://schemas.wp.org/trunk/block.json`)
 -   `apiVersion` (default: `2`) - see https://make.wordpress.org/core/2020/11/18/block-api-version-2/.
 -   `slug` (no default)
 -   `namespace` (default: `'create-block'`)
@@ -191,8 +198,4 @@ The following configurable variables are used with the template files. Template
 -   `editorStyle` (default: `'file:./build/index.css'`)
 -   `style` (default: `'file:./build/style-index.css'`)
 
-## WP-CLI
-
-Another way of making a developer’s life easier is to use [WP-CLI](https://wp-cli.org), which provides a command-line interface for many actions you might perform on the WordPress instance. One of the commands `wp scaffold block` was used as the baseline for this tool and ES5 template in particular.
-
 <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

package/lib/init-block-json.js

@@ -11,6 +11,7 @@ const { writeFile } = require( 'fs' ).promises;
 const { info } = require( './log' );
 
 module.exports = async ( {
+	$schema,
 	apiVersion,
 	slug,
 	namespace,
@@ -34,6 +35,7 @@ module.exports = async ( {
 		JSON.stringify(
 			omitBy(
 				{
+					$schema,
 					apiVersion,
 					name: namespace + '/' + slug,
 					version,

package/lib/scaffold.js

@@ -2,7 +2,7 @@
  * External dependencies
  */
 const { writeFile } = require( 'fs' ).promises;
-const { snakeCase } = require( 'lodash' );
+const { snakeCase, camelCase, upperFirst } = require( 'lodash' );
 const makeDir = require( 'make-dir' );
 const { render } = require( 'mustache' );
 const { dirname, join } = require( 'path' );
@@ -19,6 +19,7 @@ const { code, info, success } = require( './log' );
 module.exports = async (
 	blockTemplate,
 	{
+		$schema,
 		apiVersion,
 		namespace,
 		slug,
@@ -48,11 +49,13 @@ module.exports = async (
 
 	const { outputTemplates, outputAssets } = blockTemplate;
 	const view = {
+		$schema,
 		apiVersion,
 		namespace,
 		namespaceSnakeCase: snakeCase( namespace ),
 		slug,
 		slugSnakeCase: snakeCase( slug ),
+		slugPascalCase: upperFirst( camelCase( slug ) ),
 		title,
 		description,
 		dashicon,

package/lib/templates/es5/$slug.php.mustache

@@ -25,7 +25,7 @@
  * Registers all block assets so that they can be enqueued through the block editor
  * in the corresponding context.
  *
- * @see https://developer.wordpress.org/block-editor/tutorials/block-tutorial/applying-styles-with-stylesheets/
+ * @see https://developer.wordpress.org/block-editor/how-to-guides/block-tutorial/applying-styles-with-stylesheets/
  */
 function {{namespaceSnakeCase}}_{{slugSnakeCase}}_block_init() {
 	$dir = __DIR__;

package/lib/templates/esnext/$slug.php.mustache

@@ -26,7 +26,7 @@
  * Behind the scenes, it registers also all assets so they can be enqueued
  * through the block editor in the corresponding context.
  *
- * @see https://developer.wordpress.org/block-editor/tutorials/block-tutorial/writing-your-first-block-type/
+ * @see https://developer.wordpress.org/block-editor/how-to-guides/block-tutorial/writing-your-first-block-type/
  */
 function {{namespaceSnakeCase}}_{{slugSnakeCase}}_block_init() {
 	register_block_type( __DIR__ );

package/lib/templates.js

@@ -3,6 +3,8 @@
  */
 const { command } = require( 'execa' );
 const glob = require( 'fast-glob' );
+const { resolve } = require( 'path' );
+const { existsSync } = require( 'fs' );
 const { mkdtemp, readFile } = require( 'fs' ).promises;
 const { fromPairs, isObject } = require( 'lodash' );
 const npmPackageArg = require( 'npm-package-arg' );
@@ -124,6 +126,9 @@ const getBlockTemplate = async ( templateName ) => {
 	}
 
 	try {
+		if ( existsSync( resolve( templateName ) ) ) {
+			return await configToTemplate( require( resolve( templateName ) ) );
+		}
 		return await configToTemplate( require( templateName ) );
 	} catch ( error ) {
 		if ( error instanceof CLIError ) {
@@ -180,6 +185,7 @@ const getBlockTemplate = async ( templateName ) => {
 
 const getDefaultValues = ( blockTemplate ) => {
 	return {
+		$schema: 'https://schemas.wp.org/trunk/block.json',
 		apiVersion: 2,
 		namespace: 'create-block',
 		category: 'widgets',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/create-block",
-	"version": "2.5.1",
+	"version": "2.7.2-next.33ec3857e2.0",
 	"description": "Generates PHP, JS and CSS code for registering a block for a WordPress plugin.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -31,22 +31,22 @@
 		"wp-create-block": "./index.js"
 	},
 	"dependencies": {
-		"@wordpress/lazy-import": "^1.3.1",
+		"@wordpress/lazy-import": "^1.3.4-next.33ec3857e2.0",
 		"chalk": "^4.0.0",
 		"check-node-version": "^4.1.0",
 		"commander": "^4.1.0",
 		"execa": "^4.0.2",
-		"fast-glob": "^2.2.7",
+		"fast-glob": "^3.2.7",
 		"inquirer": "^7.1.0",
 		"lodash": "^4.17.21",
 		"make-dir": "^3.0.0",
 		"mustache": "^4.0.0",
-		"npm-package-arg": "^8.0.1",
+		"npm-package-arg": "^8.1.5",
 		"rimraf": "^3.0.2",
 		"write-pkg": "^4.0.0"
 	},
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "98c42a7187f788fe3e023f04df7f5dcbdae4e4e7"
+	"gitHead": "51c7917ea7fac72953702f24d6daac87d99e7617"
 }