@wordpress/create-block 4.14.0 → 4.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ _It is largely inspired by [create-react-app](https://create-react-app.dev/docs/
|
|
|
8
8
|
|
|
9
9
|
> _Learn more about the [Block API at the Gutenberg HandBook](https://developer.wordpress.org/block-editor/developers/block-api/block-registration/)._
|
|
10
10
|
|
|
11
|
-
## Table of Contents
|
|
11
|
+
## Table of Contents
|
|
12
12
|
|
|
13
13
|
- [Quick start](#quick-start)
|
|
14
14
|
- [Usage](#usage)
|
|
@@ -28,7 +28,7 @@ $ cd todo-list
|
|
|
28
28
|
$ npm start
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
The `slug` provided (`todo-list` in the example) defines the folder name for the scaffolded plugin and the internal block name. The WordPress plugin generated must [be installed manually](https://wordpress.org/
|
|
31
|
+
The `slug` provided (`todo-list` in the example) defines the folder name for the scaffolded plugin and the internal block name. The WordPress plugin generated must [be installed manually](https://wordpress.org/documentation/article/manage-plugins/#manual-plugin-installation).
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
_(requires `node` version `14.0.0` or above, and `npm` version `6.14.4` or above)_
|
|
@@ -57,12 +57,12 @@ When no `slug` is provided, the script will run in interactive mode and will sta
|
|
|
57
57
|
|
|
58
58
|
### `slug`
|
|
59
59
|
|
|
60
|
-
The use of `slug` is optional.
|
|
60
|
+
The use of `slug` is optional.
|
|
61
61
|
|
|
62
62
|
When provided it triggers the _quick mode_, where this `slug` is used:
|
|
63
63
|
- as the block slug (required for its identification)
|
|
64
64
|
- as the output location (folder name) for scaffolded files
|
|
65
|
-
- as the name of the WordPress plugin.
|
|
65
|
+
- as the name of the WordPress plugin.
|
|
66
66
|
|
|
67
67
|
The rest of the configuration is set to all default values unless overridden with some options listed below.
|
|
68
68
|
|
|
@@ -123,7 +123,7 @@ $ npx @wordpress/create-block --no-plugin
|
|
|
123
123
|
```
|
|
124
124
|
#### `--wp-env`
|
|
125
125
|
|
|
126
|
-
With this argument, the `create-block` package will add to the generated plugin the configuration and the script to run [`wp-env` package](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/) within the plugin. This will allow you to easily set up a local WordPress environment (via Docker) for building and testing the generated plugin.
|
|
126
|
+
With this argument, the `create-block` package will add to the generated plugin the configuration and the script to run [`wp-env` package](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/) within the plugin. This will allow you to easily set up a local WordPress environment (via Docker) for building and testing the generated plugin.
|
|
127
127
|
|
|
128
128
|
```bash
|
|
129
129
|
$ npx @wordpress/create-block --wp-env
|
|
@@ -131,9 +131,9 @@ $ npx @wordpress/create-block --wp-env
|
|
|
131
131
|
|
|
132
132
|
## Available commands in the scaffolded project
|
|
133
133
|
|
|
134
|
-
The plugin folder created when executing this command, is a node package with a modern build setup that requires no configuration.
|
|
134
|
+
The plugin folder created when executing this command, is a node package with a modern build setup that requires no configuration.
|
|
135
135
|
|
|
136
|
-
A set of scripts is available from inside that folder (provided by the `scripts` package) to make your work easier. [Click here](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#available-scripts) for a full description of these commands.
|
|
136
|
+
A set of scripts is available from inside that folder (provided by the `scripts` package) to make your work easier. [Click here](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#available-scripts) for a full description of these commands.
|
|
137
137
|
|
|
138
138
|
_Note: You don’t need to install or configure tools like [webpack](https://webpack.js.org), [Babel](https://babeljs.io) or [ESLint](https://eslint.org) yourself. They are preconfigured and hidden so that you can focus on coding._
|
|
139
139
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wordpress/create-block",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.16.0",
|
|
4
4
|
"description": "Generates PHP, JS and CSS code for registering a block for a WordPress plugin.",
|
|
5
5
|
"author": "The WordPress Contributors",
|
|
6
6
|
"license": "GPL-2.0-or-later",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
"wp-create-block": "./index.js"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@wordpress/lazy-import": "^1.
|
|
34
|
+
"@wordpress/lazy-import": "^1.19.0",
|
|
35
35
|
"chalk": "^4.0.0",
|
|
36
36
|
"change-case": "^4.1.2",
|
|
37
37
|
"check-node-version": "^4.1.0",
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"publishConfig": {
|
|
49
49
|
"access": "public"
|
|
50
50
|
},
|
|
51
|
-
"gitHead": "
|
|
51
|
+
"gitHead": "6df0c62d43b8901414ccd22ffbe56eaa99d012a6"
|
|
52
52
|
}
|