WordPress / wporg-repo-tools

6 stars 4 forks source link

Update "Block Name" to "Plugin Name" #23

Open StevenDufresne opened 2 years ago

StevenDufresne commented 2 years ago

When I try to include a newly made block directly into an environment, it doesn't work because it's looking for "Plugin Name".

I'm not certain this happens in all environments but it's definitely happening when I include it in the plugin section in .wp-env.json.

Is there any reason why we can't change it to Plugin Name:?

Here's an example of what I do:

{
    "plugins": [
        ...
        "../wporg-mu-plugins/mu-plugins/blocks/new-block-name"
    ],
}
ryelle commented 2 years ago

I used "Block Name" since this template isn't generating standalone plugins, but blocks that live inside wporg-mu-plugins/mu-plugins/blocks/. If you're creating a standalone plugin, I'd stick with the default template from @wordpress/create-block.

StevenDufresne commented 2 years ago

I used "Block Name" since this template isn't generating standalone plugins, but blocks that live inside wporg-mu-plugins/mu-plugins/blocks/. If you're creating a standalone plugin, I'd stick with the default template from @wordpress/create-block.

Isn't a block technically a standalone plugin, or at least should be conceived as such? If we were to submit it to the block directory, would we need to change it to "Plugin Name"? What does keeping it as "Block Name" give us?

ryelle commented 2 years ago

Isn't a block technically a standalone plugin, or at least should be conceived as such?

It could be, but this template isn't designed for that.

If we were to submit it to the block directory, would we need to change it to "Plugin Name"?

We would also need to replace the readme, since it details wporg-mu-plugin setup. So if anything, keeping "Block Name" would remind us to check the whole block. But I don't think we want the source-of-truth for a wp.org repo plugin to be in wporg-mu-plugins. I'd rather have that in its own repo so we can use specific GH actions. The default template from @wordpress/create-block is much better set up for creating a plugin we want to share on w.org.