WIP: Create WP Plugin #10628

ajitbohra · 2018-10-15T18:30:28Z

This PR is the result of casual discussion with @gziolo on wp-cli block scaffolding :)

Adds initial MVP for scaffolding WP plugin with a simple block using starter created by @youknowriad

Demo GIF

Immediate Items on list

Validation and error handling
Improve CLI experience for the user
Mustachejs for templates
Option to chose bundler parcel, webpack

Rough Roadmap/wishlist posted here #10629

docs/reference/scripts.md

Soean

Really cool PR, this has big potential 🔥
Found just a few small typos

packages/create-plugin/cli/commands.js

packages/create-plugin/package.json

packages/create-plugin/README.md

packages/create-plugin/cli/commands.js

packages/create-plugin/cli/main.js

packages/create-plugin/templates/plugin/README.md

Soean · 2018-10-15T19:04:21Z

packages/create-plugin/templates/plugin/wp-js-plugin-starter.php

+ * @package {{pluginSlug}}
+ */
+
+ /**


Delete blank before slash

ajitbohra · 2018-10-15T20:50:33Z

@Soean thank you will sync some of the changes to wp-js-plugin-starter https://github.com/youknowriad/wp-js-plugin-starter

gziolo

Can we start by exposing as much as possible from @wordpress/scripts before we get to templating? It feels like we can limit this PR to adding the code which handles scaffolding. That would be awesome :)

gziolo · 2018-12-20T07:30:00Z

packages/create-plugin/index.js

+/**
+ * Check node version
+ */
+if ( major < 8 ) {


Not sure if that would fit here, but we exposed new script which allows to verify the minimum version of node an npm which WordPress enforces for development:
https://github.com/WordPress/gutenberg/tree/master/packages/scripts#check-engines

have been following the scripts would be good to reuse check-engines here

gziolo · 2018-12-20T07:32:09Z

packages/create-plugin/templates/plugin/docker-compose.yml

@@ -0,0 +1,16 @@
+version: "3.1"


I would see it inside wp-scripts with the corresponding scripts which helps to spin up a WordPress instance whit your plugin enabled.

scripts/configs/templates all would go to wp-scripts

gziolo · 2018-12-20T07:33:13Z

packages/create-plugin/templates/plugin/package.json

+  "devDependencies": {
+    "@babel/core": "^7.1.0",
+    "@wordpress/babel-preset-default": "^2.1.0",
+    "parcel-bundler": "^1.10.1"


Let's bring Parcel to wp-scripts, too :)
See my PR opened a few days ago: #12837.

seems liked missed the PR seems good fit here

gziolo · 2018-12-20T07:34:28Z

packages/create-plugin/templates/plugin/src/index.js

@@ -0,0 +1,16 @@
+const { registerBlockType } = wp.blocks;


How about using this template:
https://github.com/wp-cli/scaffold-command/blob/master/templates/block-index-js.mustache from WP-CLI?

Yes we can use this it contains inline documentations also

gziolo · 2018-12-20T07:35:25Z

packages/create-plugin/templates/plugin/wp-js-plugin-starter.php

@@ -0,0 +1,45 @@
+<?php


I also authored this template:
https://github.com/wp-cli/scaffold-command/blob/master/templates/block-php.mustache

There are also 2 CSS templates available.

gziolo · 2018-12-20T07:36:33Z

packages/create-plugin/templates/plugin/src/index.js

@@ -0,0 +1,16 @@
+const { registerBlockType } = wp.blocks;


By the way, WP-CLI adds .mustache extension to the template files.

gziolo · 2018-12-20T10:34:06Z

packages/create-plugin/templates/plugin/bin/build-plugin-zip.sh

+# Generate the plugin zip file
+status "Creating archive..."
+zip -r {{pluginSlug}}.zip \
+	{{pluginSlug}}.php \


I'm wondering how CSS and other assets are handled by Parcel to ensure they are included in the dist folder.

ajitbohra · 2018-12-20T18:53:52Z

@gziolo

will soon resume work on this and get initial scaffolding ready utilizing wp-scripts

oandregal · 2019-03-15T12:15:20Z

The @wordpress/scripts package has received some love lately (including support for ESNext/JSX transpilation). We also have better docs such (JavaScript tutorial FTW!). Considering that, I wonder whether this could be rethought as scripts scaffold command instead of a separate package.

I like the idea of having a scafolding command, this would be a great addition for onboarding new people to Gutenberg. What do you think @ajitbohra ?

youknowriad · 2019-03-15T12:42:41Z

I think npm might have a special packages that start with create-*. I like the separation of concerns between @wordpress/scripts and a create package. A create package might need dependencies not really needed aside for generating the initial app.

I feel scaffolding is something you do once, and the scripts commands are something you use daily in your package, making it a clear separation of concerns.

@nosolosw What are the reasons that makes you prefer a command instead of a separate package?

oandregal · 2019-03-15T13:20:49Z

@youknowriad those are good thoughts I hadn't considered deeply 👍

gziolo · 2019-03-15T14:30:27Z

I think npm might have a special packages that start with create-*. I like the separation of concerns between @wordpress/scripts and a create package. A create package might need dependencies not really needed aside for generating the initial app.

Yes, those are great reasons to put it in its own package. For reference, this is how it looks with create-react-app:

$ npm init react-app ./my-react-ap

https://docs.npmjs.com/cli/init#examples

By the way, it might be very convenient to have this offering once block.json format is shipped (#13693).

gziolo · 2019-04-24T11:56:41Z

@ajitbohra this PR is now a bit out of date. Do you plan to revisit it and help us land a very first iteration of the scaffolding tool based on the feedback provided? An alternative approach would be to close this PR and let other contributors work on it based on your initial exploration.

ajitbohra · 2019-05-14T08:26:13Z

@youknowriad @noisysocks +1 for keeping it as separate package

@gziolo resuming work on this PR to address the feedback and suggestions

gziolo · 2019-05-14T08:58:53Z

resuming work on this PR to address the feedback and suggestions

It's great to see you back. Feel free to remove Stale label when it gets updated :)

gziolo · 2019-05-24T12:00:54Z

There is this great work from @youknowriad which uses some related tooling to automate Gutenberg releases in #15699. It would be great to align as much as possible.

paaljoachim · 2019-08-30T23:19:18Z

Hey @ajitbohra
Can we get a status update on this PR? What is needed to move the PR onward?

gziolo · 2019-12-17T14:29:40Z

I have this npm package up and running which sort of duplicates the functionality proposed in this PR:

https://www.npmjs.com/package/create-wordpress-block
https://github.com/gziolo/create-wordpress-block

I plan to open PR against Gutenberg after some testing with the community.

Should we close this PR?

mcsf · 2019-12-17T15:11:08Z

This has been labeled Stale since April. Thanks for the efforts, but I'll close this for now.

ajitbohra added 5 commits October 15, 2018 16:41

Docs: scripts.md fix typo

5bfcfc6

Add create-wp-plugin CLI base

c348fa7

Cleanup and fixes

c5ddc04

Console beautification

40eaff2

Fix entry path

c13eec5

ajitbohra requested review from youknowriad, gziolo and aduth October 15, 2018 18:30

ajitbohra mentioned this pull request Oct 15, 2018

Tooling: scaffolding WordPress plugins and blocks #10629

Closed

Soean reviewed Oct 15, 2018

View reviewed changes

docs/reference/scripts.md Show resolved Hide resolved

Soean reviewed Oct 15, 2018

View reviewed changes

Fix typos

9c4d8ff

ajitbohra mentioned this pull request Oct 16, 2018

Fix typos in README.md youknowriad/wp-js-plugin-starter#8

Merged

ajitbohra changed the title ~~Draft: Create WP Plugin~~ WIP: Create WP Plugin Oct 19, 2018

ajitbohra added the [Status] In Progress Tracking issues with work in progress label Oct 19, 2018

gziolo reviewed Dec 20, 2018

View reviewed changes

gziolo added [Package] Scripts /packages/scripts [Type] Build Tooling Issues or PRs related to build tooling labels Dec 20, 2018

gziolo added this to the Future: 5.x milestone Dec 20, 2018

gziolo added the [Type] Technical Prototype Offers a technical exploration into an idea as an example of what's possible label Jan 25, 2019

gziolo removed this from the WordPress 5.x milestone Jan 25, 2019

oandregal self-requested a review February 12, 2019 10:33

gziolo added [Status] Stale Gives the original author opportunity to update before closing. Can be reopened as needed. and removed [Status] In Progress Tracking issues with work in progress labels Apr 24, 2019

gziolo mentioned this pull request Nov 21, 2019

Scripts: Add create-block script for bootstrapping a minimal block development plugin. #18650

Closed

6 tasks

mcsf closed this Dec 17, 2019

youknowriad deleted the try/create-wp-plugin branch May 27, 2020 17:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Create WP Plugin #10628

WIP: Create WP Plugin #10628

ajitbohra commented Oct 15, 2018 •

edited

Loading

Soean left a comment

Soean Oct 15, 2018

ajitbohra commented Oct 15, 2018

gziolo left a comment

gziolo Dec 20, 2018

ajitbohra Dec 20, 2018

gziolo Dec 20, 2018

ajitbohra Dec 20, 2018

gziolo Dec 20, 2018

ajitbohra Dec 20, 2018

gziolo Dec 20, 2018

ajitbohra Dec 20, 2018

gziolo Dec 20, 2018

gziolo Dec 20, 2018

gziolo Dec 20, 2018

ajitbohra commented Dec 20, 2018

oandregal commented Mar 15, 2019

youknowriad commented Mar 15, 2019 •

edited

Loading

oandregal commented Mar 15, 2019

gziolo commented Mar 15, 2019 •

edited

Loading

gziolo commented Apr 24, 2019

ajitbohra commented May 14, 2019

gziolo commented May 14, 2019

gziolo commented May 24, 2019

paaljoachim commented Aug 30, 2019

gziolo commented Dec 17, 2019

mcsf commented Dec 17, 2019

WIP: Create WP Plugin #10628

WIP: Create WP Plugin #10628

Conversation

ajitbohra commented Oct 15, 2018 • edited Loading

Soean left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajitbohra commented Oct 15, 2018

gziolo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajitbohra commented Dec 20, 2018

oandregal commented Mar 15, 2019

youknowriad commented Mar 15, 2019 • edited Loading

oandregal commented Mar 15, 2019

gziolo commented Mar 15, 2019 • edited Loading

gziolo commented Apr 24, 2019

ajitbohra commented May 14, 2019

gziolo commented May 14, 2019

gziolo commented May 24, 2019

paaljoachim commented Aug 30, 2019

gziolo commented Dec 17, 2019

mcsf commented Dec 17, 2019

ajitbohra commented Oct 15, 2018 •

edited

Loading

youknowriad commented Mar 15, 2019 •

edited

Loading

gziolo commented Mar 15, 2019 •

edited

Loading