Create Block: Add optional support for wp-env #28234
Merged
Conversation
This file contains 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
gziolo
added
[Tool] Create Block
gziolo
force-pushed
the
update/create-block-wp-env
branch
from
eb50796 to
369c177
Compare
|
Size Change: 0 B Total Size: 1.28 MB ℹ️ View Unchanged
|
fabiankaegy
approved these changes
Jan 15, 2021
gziolo
commented
Jan 15, 2021
| info( '' ); | ||
| code( ` $ cd ${ slug }` ); | ||
| code( ` $ npm start` ); | ||
| code( ' $ npx wp-env start' ); |
There was a problem hiding this comment.
@noahtallen or @noisysocks, I chose to install @wordpress/env as a local package:
https://github.com/WordPress/gutenberg/blob/master/packages/env/README.md#installation-as-a-local-package
The documentation recommends putting it inside the scripts section. I skipped that in favor of:
npx wp-env start
I'm not sure what would be the best way here. I proposed we make wp-env integration with Create Block optional. How would you approach it? Global or local installation? Can you install it globally from the Node process in the first place?
There was a problem hiding this comment.
Global install works via npm i -g @wordpress/env, which is then accessible on the CLI as wp-env
That said, for local projects which you know will support wp-env for the environment, I do like installing it locally. Then, you know exactly what version is available for everyone, and no one has to do yet another extra set up command, since wp-env is included already.
There was a problem hiding this comment.
@noahtallen, thank you very much for the clarification. Everything is configured properly in that case 😄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR adds a new CLI option
--wp-envthat lets users override the setting that the template defines for integration with@wordpress/envpackage. This makes it possible to test the scaffolded block in the WordPress instance created by@wordpress/env.How has this been tested?
To create a block
Then:
cd my-block npx wp-env startGo to the browser and visit:
https://localhost:8888/wp-admin/
Insert a new post and enjoy the possibility to enter newly scaffolded block 🎉
Types of changes
New feature (non-breaking change which adds functionality).
Checklist: