From 7f74893dd9d225eab5c9f83a64e77834dc53bb2e Mon Sep 17 00:00:00 2001 From: Akshat Date: Wed, 2 Sep 2026 14:36:07 +0530 Subject: [PATCH] chore: disentangle npm listing from the unrelated create-wp-plugin package - README: H1 -> create-wp-plugin-cli (matches the package name; bare create-wp-plugin is a separate, unrelated package), add npm/CI/license badges, drop the "name was already taken" blockquote - package.json: replace the stale v2 description ("Container + Service Providers", removed in v3.0.0) with the current static-bootloader wording; remove the create-wp-plugin bin alias so installing this no longer shadows the other package on PATH; add keywords (wordpress-plugin, wp-cli, gutenberg, phpunit) - BACKLOG: close NEW-56 (add create-wp-plugin bin alias) as rejected -- it contradicts the disentangling intent --- BACKLOG.md | 5 +++-- README.md | 9 +++++---- package.json | 11 +++++++---- 3 files changed, 15 insertions(+), 10 deletions(-) diff --git a/BACKLOG.md b/BACKLOG.md index 8569c0f..b8d3b74 100644 --- a/BACKLOG.md +++ b/BACKLOG.md @@ -238,9 +238,10 @@ When `WooCommerce Integration` is selected in Question 11, the CLI opens a secon - [ ] **NEW-55 [P2] Missing `tmp-test*` in Root `.gitignore`** *Location:* `.gitignore` Test temp folders created by `generator.test.js` are not ignored, cluttering git working tree when tests fail. -- [ ] **NEW-56 [P2] Missing `create-wp-plugin` Alias in `package.json` `"bin"` Field** +- [x] ~~**NEW-56 [P2] Missing `create-wp-plugin` Alias in `package.json` `"bin"` Field**~~ *Location:* `package.json:6-8` - Only defines `"create-wp-plugin-cli"`. Adding `"create-wp-plugin": "index.js"` ensures standard npm `npm create wp-plugin` alias execution works without error. + Only defines `"create-wp-plugin-cli"`. Adding `"create-wp-plugin": "index.js"` ensures standard npm `npm create wp-plugin` alias execution works without error. + *Rejected:* `create-wp-plugin` is a separate, unrelated npm package. A bin by that name shadows it on `PATH` and blurs the two projects — the opposite of the intent. The alias has been removed; `create-wp-plugin-cli` is the sole bin. ### Iteration 8 Findings - [ ] **NEW-57 [P1] `phpcs.xml` Skips Sniffing `./templates/` Directory** diff --git a/README.md b/README.md index 085fffe..74e939c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -# create-wp-plugin +# create-wp-plugin-cli + +[![npm version](https://img.shields.io/npm/v/create-wp-plugin-cli)](https://www.npmjs.com/package/create-wp-plugin-cli) +[![CI](https://github.com/akshat009/create-wp-plugin-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/akshat009/create-wp-plugin-cli/actions) +[![License: GPL-2.0-or-later](https://img.shields.io/badge/license-GPL--2.0--or--later-blue)](LICENSE) Interactive scaffold generator for modern, production-ready WordPress plugins — a modular bootloader architecture (one `Plugin` composition root wiring plain @@ -19,9 +23,6 @@ npx create-wp-plugin-cli # same thing via npx npx github:akshat009/create-wp-plugin-cli # latest main, straight from GitHub ``` -> Published on npm as [`create-wp-plugin-cli`](https://www.npmjs.com/package/create-wp-plugin-cli) -> — the shorter `create-wp-plugin` name was already taken. - ### From a clone ```bash diff --git a/package.json b/package.json index e701b2d..82e8d45 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,10 @@ { "name": "create-wp-plugin-cli", "version": "3.1.0", - "description": "Interactive scaffold generator for modern WordPress plugins — SOLID/DI architecture (Container + Service Providers), PSR-4, selectable WPCS/VIP standards, PHPUnit unit + integration tests, Jest, Playwright, WP-CLI, WooCommerce, Interactivity API, and CI out of the box", + "description": "Interactive scaffold generator for modern WordPress plugins — static bootloader with a Services locator, PSR-4, selectable WPCS/VIP standards, PHPUnit + Brain Monkey, Jest, Playwright, WP-CLI, WooCommerce, Interactivity API, and CI out of the box", "main": "index.js", "bin": { - "create-wp-plugin-cli": "index.js", - "create-wp-plugin": "index.js" + "create-wp-plugin-cli": "index.js" }, "type": "module", "engines": { @@ -29,7 +28,11 @@ "wpcs", "psr-4", "woocommerce", - "interactivity-api" + "interactivity-api", + "wordpress-plugin", + "wp-cli", + "gutenberg", + "phpunit" ], "author": { "name": "Akshat Saxena",