[create-block] Adds --target-dir flag to allow the tool to target where to scaffold. #53781
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
ryanwelcher
added
[Type] Enhancement
ryanwelcher
changed the title
|
Size Change: 0 B Total Size: 1.51 MB ℹ️ View Unchanged
|
bacoords
reviewed
Dec 5, 2023
| @@ -59,6 +59,7 @@ program | |||
| .option( '--wp-env', 'enable integration with `@wordpress/env` package' ) | |||
| .option( '--no-plugin', 'scaffold only block files' ) | |||
| .option( '--variant <variant>', 'the variant of the template to use' ) | |||
| .option( '--target-dir <directory>', 'the variant of the template to use' ) | |||
There was a problem hiding this comment.
Just noting that this description still needs to be updated.
|
I just tested this and noticed that if you combine it with the Running
but instead it just puts it in the root. I'm not sure the best choice is but I'd lean towards the first one. |
gziolo
reviewed
Dec 6, 2023
| ? join( process.cwd(), slug, folderName, 'block.json' ) | ||
| : join( process.cwd(), slug, 'block.json' ); | ||
| ? join( process.cwd(), targetDir, slug, folderName, 'block.json' ) | ||
| : join( process.cwd(), folderName, slug, 'block.json' ); |
There was a problem hiding this comment.
From #53781 (comment):
I just tested this and noticed that if you combine it with the --no-plugin argument, it seems to ignore the --target-dir argument.
It looks like targetDir should be used here as well.
|
Thank you for testing @bacoords!
We could replicate
When using Aside: I'm wondering how much we could read from the plugin when scaffolding another block. It could be useful to read the |
True, although sometimes blocks are created in themes as well. I was hoping that once this was merged it would be easy to include a script like this in any project's package.json file: "create-block": "npx @wordpress/create-block --namespace=my-namespace --no-plugin --target-dir=src/blocks"so that in the future you could run something like this from your project's root directory: or and it would generate it for you. So you could put the namespace and target-dir in your package.json. |
|
@ryanwelcher @gziolo and @bacoords thanks for pushing this forward! I feel like I'm missing something here. This PR aims to address this issue: Allow explicit target for block creation. However, after utilizing the Testing Instructions I've merely created two plugins with blocks, and both versions of the plugin have the block stored in the usual |
|
@colorful-tones Correct - currently this PR just lets you initiate the entire plugin in a different directory. Imagine you're in the root of your WP install, you could pass But I think it becomes more useful if we could combine it with Happy to contribute/test here as needed. |
|
This is all great feedback. I need to look at this PR again to resolve the conflicts but now I think the target should absolutely work in either mode. |
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.
What?
This PR adds the
--target-dirflag to allow users to target where the tool should scaffold either the entire plugin or the block files. This flag is not used when the tool is in--no-pluginmodeCloses #44717
Why?
Being able to target where to scaffold the files is something that has been missing from the tool. By adding this flag extenders would be able to incorporate create-block into their scaffolds/workflow much easer.
For example, many projects use
wp-contentas the root directory and keep a package.json there. Currently, anyone wanting to use the create-block tool, would need to move thepluginsdirectory and run it there. With this change, a script could be created to run the tool in place.Script
Invoke
Another change here is now when running the tool in
--no-pluginmode, the resulting files are scaffolded into a sub-directory of thefolderNameproperty (./srcby default ) so now when adding a new block to an existing plugin the user no longer needs to move the thefolderNamedirectory.How?
I am introducing a
targetDirvariable with the default value of./and prepending all of the paths with its value.Testing Instructions
cdinto `packages/create-block'node index.js test-no-targetsrcdirectorynode index.js test-with-target --target-dir target-directorytarget-directoryfolder with the block files in asrcdirectory