wp-advads 1.0.34 → 1.0.35

package/README.md

@@ -1,139 +1,158 @@
-# wp-advads Scaffolding Tool
-
-
-
+# wp-advads
 
 [![npm version](https://img.shields.io/npm/v/wp-advads.svg)](https://www.npmjs.com/package/wp-advads)
 [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](LICENSE)
 
-<p align="center">
-	<img src="https://img.icons8.com/nolan/256/wordpress.png"/>
-</p>
+CLI scaffolding for an **existing** Advanced Ads WordPress plugin. It writes `wp.advads` and file stubs (`class`, `view`, `updates`, `js`, `css`). It does not generate a plugin from scratch.
 
-## 📃 Introduction
+Requires **Node.js 18+**. Created by [Shakeeb Ahmed](https://github.com/meshakeeb).
 
-CLI tools to streamline development tasks for the Advanced Ads WordPress plugin.
-Created by [Shakeeb Ahmed](https://github.com/meshakeeb)
+## Installation
 
-## 📦 Installation
-Use via npx:
 ```bash
 npx wp-advads
 ```
 
-## 🚀  Usage
-Run the CLI using:
 ```bash
 npx wp-advads <command> [options]
 ```
 
-## 🔧 Commands
+## Config
+
+Commands (except `init`) need a `wp.advads` file. The CLI uses the nearest ancestor that already has one. `init` writes `wp.advads` in the current directory.
+
+If the file is missing, the CLI exits and tells you to run `wp-advads init`. It does not prompt.
+
+## Commands
 
 #### `init`
-Initializes a new project configuration file.
+
+Creates `wp.advads` in the current directory.
+
 ```bash
 npx wp-advads init
 ```
 
-`wp.advads` lives in the nearest ancestor directory that already has that file. `init` creates it in the current directory.
+#### `build`
+
+Installs PHP dependencies into `packages/` (`COMPOSER_VENDOR_DIR=packages`), dumps the autoloader, runs `npm run build` when `package.json` has a `scripts.build`, then generates a `.pot`.
+
+```bash
+npx wp-advads build
+```
+
+Standalone `build` does not touch release git messages. During `release`, commit bullets are passed in explicitly.
 
 #### `release`
-Creates a new release for the plugin.
+
+Bumps the version, changelog, translations, build, and git (explicit file list, hooks run). Stops on the first failed step.
+
 ```bash
 npx wp-advads release
 ```
 
-
 #### `class <classname> [options]`
-Creates a new PHP class file with optional templates.
+
+Writes a PHP class under `paths.php`. Combine `--heading` with a template flag (`-i` / `-g` / `-r` / `-s`).
+
 ```bash
 npx wp-advads class MyClass --heading "Class Heading" --description "Description" -s
 ```
 
-##### Required Argument:
-- `<classname>` – The name of the class.
-
-##### Optional Argument:
+- `<classname>` – Class name (namespaces with `\`, e.g. `Foo\Bar`)
 - `--heading <heading>` – File heading
 - `--description <description>` – File description
-- `-i` – Initializer interface
-- `-g` – Integration interface
-- `-r` – REST interface
-- `-s` – Singleton class
-
+- `-i` – Initializer
+- `-g` – Integration
+- `-r` – REST
+- `-s` – Singleton (`__construct` is private)
+- `--force` – Overwrite if the file exists
 
 #### `view <viewname> [heading]`
-Creates a new view file (e.g. template partial).
+
+Writes a PHP view under `paths.views`. Nested names accept `/` or `\`.
+
 ```bash
 npx wp-advads view sidebar "Sidebar View"
+npx wp-advads view admin/settings
 ```
 
-##### Required Argument:
-- `<viewname>` – Name of the view file.
+- `<viewname>` – View file name
+- `[heading]` – Heading comment
+- `--force` – Overwrite if the file exists
 
-##### Optional Argument:
-- `[heading]` – A heading comment added to the view file.
+#### `updates <version>`
 
+Writes an upgrade file under `paths.updates`. `misc.prefix` from `wp.advads` is required (empty prefix is an error).
 
-#### `updates <version>`
-Creates update logic for the given plugin version.
 ```bash
 npx wp-advads updates 1.2.3
 ```
 
-##### Required Argument:
-- `<version>` – Target version number (e.g. `1.2.0`)
+- `<version>` – Target version (e.g. `1.2.3`)
+- `--force` – Overwrite if the file exists
 
 #### `js <filename> [options]`
-Creates a new JavaScript file.
+
+Writes a JavaScript file under `paths.javascript`. Nested names accept `/` or `\`.
+
 ```bash
 npx wp-advads js script -h "Main JS" -d "Handles the frontend logic"
 ```
 
-##### Required Argument:
-- `<filename>` – Name of the JavaScript file (without extension).
+- `<filename>` – Name without extension
+- `-h <heading>` – Heading comment
+- `-d <description>` – Description comment
+- `--force` – Overwrite if the file exists
 
-##### Optional Argument:
-- `-h <heading>` – Heading comment for the file.
-- `-d <description>` – Description comment for the file.
+#### `css <filename> [options]`
 
+Writes a CSS file under `paths.css`. Nested names accept `/` or `\`.
 
-#### `css <filename> [options]`
-Creates a new CSS file.
 ```bash
 npx wp-advads css styles -h "Main CSS" -d "Plugin styles"
 ```
 
-##### Required Argument:
-- `<filename>` – Name of the CSS file (without extension).
-
-##### Optional Argument:
-- `-h <heading>` – Heading comment for the file.
-- `-d <description>` – Description comment for the file.
+- `<filename>` – Name without extension
+- `-h <heading>` – Heading comment
+- `-d <description>` – Description comment
+- `--force` – Overwrite if the file exists
 
 #### `pot`
-Generates a `.pot` translation template.
+
+Creates a `.pot` translation template (`wp i18n make-pot`).
+
 ```bash
 npx wp-advads pot
 ```
 
+POT headers (`Last-Translator`, `Language-Team`) use `author.name` and `author.email` from `wp.advads`.
+
 #### `translations`
-Downloads translation files from GlotPress.
+
+Downloads `.po` / `.mo` files from GlotPress into `glotpress.destination` (default `./languages/`). Locale ids must be `[a-zA-Z0-9_]+`; non-OK HTTP responses are skipped.
+
 ```bash
 npx wp-advads translations
 ```
 
-### ⚠️ Notes
-A config file is required for all commands **except** init.
+## Notes
+
+`class`, `view`, `updates`, `js`, and `css` will not overwrite an existing file unless you pass `--force`. Writes cannot escape the project root.
+
+## Tests
+
+```bash
+npm test
+```
 
-If one is missing, you'll be prompted to create it with `wp-advads init`.
+That runs `node --experimental-test-module-mocks --test`. Node 18+ is required (`engines.node`).
 
-`class`, `view`, `updates`, `js`, and `css` will not overwrite an existing file unless you pass `--force`.
+## Author
 
-### 👤 Author
-Shakeeb Ahmed
-GitHub: [@meshakeeb](http://github.com/meshakeeb)
+Shakeeb Ahmed  
+GitHub: [@meshakeeb](https://github.com/meshakeeb)
 
-### 📖 Changelog
+## Changelog
 
-[See the changelog file](./CHANGELOG.md)
+[CHANGELOG.md](./CHANGELOG.md)

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "wp-advads",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "description": "Create an Advanced Ads WordPress plugin ecosystem.",
   "author": {
     "name": "Shakeeb Ahmed",