wp-advads 1.0.33 → 1.0.35

package/.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - run: npm ci
+      - run: npm test

package/CHANGELOG.md

@@ -4,9 +4,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ---
+## [1.0.34] - 2026-09-11
+
+### Changed
+- `init` only writes `wp.advads`; this CLI is commands inside an existing plugin, not a full-plugin generator.
+- `build` runs the consumer `package.json` `scripts.build` when present, and no longer mutates release commit messages.
+- Release git commit uses an explicit file list and runs hooks (`--no-verify` and `git add .` are gone).
+- Shell-outs fail closed; large builds stream via `spawn`.
+- Scaffold writes stay inside the project root and refuse to overwrite unless `--force`.
+- Nested `js` / `css` / `view` paths accept `/` and `\`.
+- POT headers come from `author` in config; `pot` docs match that it writes a `.pot`.
+- Requires Node `>=18`. Package description grammar and license (ISC) match the repo.
+
+### Fixed
+- `view` and `updates` compile with the real `init` config shape (`description`, `misc.prefix`).
+- Class `--heading` plus `-i`/`-g`/`-r`/`-s` selects the right template.
+- SemVer pre-release increment (`alpha.2` → `alpha.3`) and invalid tags.
+- `getLatestTag`, GitHub permission/fetch, and `updateFileContent` stop release on error instead of continuing.
+- Singleton stub constructor is private; GlotPress locale ids are sanitized.
+
+### Removed
+- Laravel Mix / PHPCS / plugin boilerplate templates, `fs-extra`, and the `async` package.
+
 ## [1.0.28] - 2025-04-20
 ### Added
-- `pot` command to generate `.po` and `.mo` translation files.
+- `pot` command to generate `.pot` translation files.
 - `translations` command to download translation files from GlotPress.
 
 ## [1.0.23] - 2025-04-15

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026 Shakeeb Ahmed
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,138 +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)
-[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
-![Version](https://img.shields.io/badge/version-2.0.0-yellow.svg)
+[![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
 ```
 
+#### `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 -h "Class Heading" -d "Description" -s
+npx wp-advads class MyClass --heading "Class Heading" --description "Description" -s
 ```
 
-##### Required Argument:
-- `<classname>` – The name of the class.
+- `<classname>` – Class name (namespaces with `\`, e.g. `Foo\Bar`)
+- `--heading <heading>` – File heading
+- `--description <description>` – File description
+- `-i` – Initializer
+- `-g` – Integration
+- `-r` – REST
+- `-s` – Singleton (`__construct` is private)
+- `--force` – Overwrite if the file exists
 
-##### Optional Argument:
-- `-h <heading>` – File heading
-- `-d <description>` – File description
-- `-i` – Initializer interface
-- `-g` – Integration interface
-- `-r` – REST interface
-- `-s` – Singleton class
+#### `view <viewname> [heading]`
 
+Writes a PHP view under `paths.views`. Nested names accept `/` or `\`.
 
-#### `view <viewname> [heading]`
-Creates a new view file (e.g. template partial).
 ```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 `.po` and `.mo` translation files.
+
+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
+```
+
+That runs `node --experimental-test-module-mocks --test`. Node 18+ is required (`engines.node`).
 
-If one is missing, you'll be prompted to create it with `wp-advads init`.
+## 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,8 +1,8 @@
 {
   "type": "module",
   "name": "wp-advads",
-  "version": "1.0.33",
-  "description": "Create a Advanced Ads wordPress plugin eco system.",
+  "version": "1.0.35",
+  "description": "Create an Advanced Ads WordPress plugin ecosystem.",
   "author": {
     "name": "Shakeeb Ahmed",
     "email": "me@shakeebahmed.com",
@@ -13,7 +13,8 @@
     "wp-advads": "src/app.js"
   },
   "scripts": {
-    "start": "node src/app.js"
+    "start": "node src/app.js",
+    "test": "node --experimental-test-module-mocks --test"
   },
   "repository": {
     "type": "git",
@@ -25,15 +26,16 @@
     "generator"
   ],
   "license": "ISC",
+  "engines": {
+    "node": ">=18"
+  },
   "bugs": {
-    "url": "https://github.com/advanced-ads/npm-scaffolding/issues"
+    "url": "https://github.com/advanced-ads/wp-advads/issues"
   },
-  "homepage": "https://github.com/advanced-ads/npm-scaffolding#readme",
+  "homepage": "https://github.com/advanced-ads/wp-advads#readme",
   "dependencies": {
-    "async": "^3.2.6",
     "chalk": "^5.4.1",
     "commander": "^13.1.0",
-    "fs-extra": "^11.3.0",
     "inquirer": "^12.5.2",
     "lodash": "^4.17.21",
     "log-symbols": "^7.0.0"

package/src/app.js

@@ -5,6 +5,9 @@
  */
 import chalk from 'chalk'
 import { program } from 'commander'
+import { readFileSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
 
 /**
  * Commands
@@ -12,6 +15,10 @@ import { program } from 'commander'
 import * as commands from './commands/index.js'
 import { configFileExists, onNewLine } from './utilities/index.js'
 
+const { version } = JSON.parse(
+	readFileSync( join( dirname( fileURLToPath( import.meta.url ) ), '../package.json' ), 'utf8' )
+)
+
 /**
  * App
  */
@@ -19,7 +26,7 @@ const app = async () => {
     console.log(
         [
             chalk.hex('#FADC00').inverse.bold('Advanced Ads WordPress Plugin Toolkit'),
-            chalk.white( 'v2.0.0' ),
+            chalk.white( 'v' + version ),
             chalk.dim( 'by Shakeeb Ahmed' )
         ].join(" ")
     );
@@ -31,7 +38,7 @@ const app = async () => {
 	program
 		.name('wp-advads')
 		.description('CLI to Advanced Ads scaffolding utilities')
-		.version('2.0.0')
+		.version(version)
 		.hook('preAction', (thisCommand, actionCommand) => {
 			if ( 'init' !== actionCommand.name() && ! configFileExists() ) {
 				onNewLine(chalk.bgRed.white('Config file not found. Run `wp-advads init` to create a new config file.'));
@@ -52,12 +59,6 @@ const app = async () => {
 		.description('Build the plugin/theme according to the config file')
 		.action(commands.build);
 
-	// Command: plugin
-	// program
-	// 	.command('plugin')
-	// 	.description('Create a new plugin')
-	// 	.action(commands.plugin);
-
 	// Command: release
 	program
 		.command('release')
@@ -69,12 +70,13 @@ const app = async () => {
 		.command('class')
 		.description('Create a new class file')
 		.argument('<classname>', 'Classname')
-		.option('-h <heading>', 'Heading of the file')
-		.option('-d <description>', 'Description of the file')
+		.option('--heading <heading>', 'Heading of the file')
+		.option('--description <description>', 'Description of the file')
 		.option('-i', 'Initializer interface template')
 		.option('-g', 'Integration interface template')
 		.option('-r', 'Rest interface template')
 		.option('-s', 'Singleton template')
+		.option('--force', 'Overwrite an existing file')
 		.action(commands.classFile);
 
 	// Command: view
@@ -83,6 +85,7 @@ const app = async () => {
 		.description('Create a new view')
 		.argument('<viewname>', 'name of the view')
 		.argument('[heading]', 'Heading of the file')
+		.option('--force', 'Overwrite an existing file')
 		.action(commands.views);
 
 	// Command: updates
@@ -90,6 +93,7 @@ const app = async () => {
 		.command('updates')
 		.description('Updates for the plugin')
 		.argument('<version>', 'version number')
+		.option('--force', 'Overwrite an existing file')
 		.action(commands.updates);
 
 	// Command: js
@@ -99,6 +103,7 @@ const app = async () => {
 		.argument('<filename>', 'name of the file')
 		.option('-h <heading>', 'Heading of the file')
 		.option('-d <description>', 'Description of the file')
+		.option('--force', 'Overwrite an existing file')
 		.action(commands.javascript);
 
 	// Command: css
@@ -108,12 +113,13 @@ const app = async () => {
 		.argument('<filename>', 'name of the file')
 		.option('-h <heading>', 'Heading of the file')
 		.option('-d <description>', 'Description of the file')
+		.option('--force', 'Overwrite an existing file')
 		.action(commands.css);
 
 	// Command: wp-pot
 	program
 		.command('pot')
-		.description('Create po and mo files')
+		.description('Create a .pot file')
 		.action(commands.wpPot);
 
 	// Command: wp-glotpress

package/src/commands/build.js

@@ -3,80 +3,93 @@
  */
 import fs from 'fs';
 import chalk from 'chalk'
-import { waterfall } from 'async'
 import logSymbols from 'log-symbols'
 
 /**
  * Node dependencies
  */
-import { pluginData } from './release.js';
 import wpPot from './wp-pot.js';
 import { heading, onSameLine, execCommand } from '../utilities/index.js'
 
-export default function wpBuild(nextProcess = null) {
+export default function wpBuild(nextProcess = null, commitMessages = null) {
 	heading('Building the plugin...')
 	console.log('------------------------------------------------');
 
-	waterfall(
-        [
-            (next) => {
-				process.stdout.write('Clearing packages folder...')
-				try {
-					fs.rmSync( 'packages', { recursive: true, force: true } );
-					onSameLine(`${logSymbols.success} Cleared packages folder`)
-				} catch ( _ ) {}
-				next();
-			},
-            (next) => {
-				process.stdout.write('Installing PHP dependencies...')
-
-				execCommand(
-					'composer install -o -a -n --no-dev --no-scripts',
-					function() {
-						onSameLine(`${logSymbols.success} Installed PHP dependencies`);
-						process.stderr.write('Composer dumping....')
-
-						execCommand('composer dump', function() {
-							onSameLine(`${logSymbols.success} Composer updated`)
-							pluginData.commitMessages.push('update 3rd party dependecies')
-							next();
-						})
-					},
-					{
-						env: { ...process.env, COMPOSER_VENDOR_DIR: 'packages' },
-					}
-				);
-
-			},
-            (next) => {
-				process.stdout.write('Building plugin resources...')
-				execCommand( 'npx wp-scripts build', function() {
-					onSameLine(`${logSymbols.success} Built plugin resources`);
-					pluginData.commitMessages.push('Build plugin resources')
-					next();
-				});
-			},
-            (next) => {
-				console.log('')
-				wpPot(next);
-			},
-        ],
-        ( err, results ) => {
-            if (err) {
-                console.log('');
-                console.log( `${logSymbols.error} ${chalk.bold.red(`We failed somewhere! Work hard mate...`)}` )
-				if (typeof nextProcess === 'function') {
-					nextProcess(true);
-				}
-                return
-            }
-
+	run( commitMessages )
+		.then( () => {
 			if (typeof nextProcess === 'function') {
 				nextProcess();
 			} else {
 				console.log('');
 				console.log( `${logSymbols.success} ${chalk.bold.green(`All done!`)}` )
 			}
-        }
-    );
+		} )
+		.catch( ( err ) => {
+			console.log('');
+			console.log( `${logSymbols.error} ${chalk.bold.red(`We failed somewhere! Work hard mate...`)}` )
+			if (typeof nextProcess === 'function') {
+				nextProcess(true);
+			}
+		} )
+}
+
+function run( commitMessages ) {
+	return ( async () => {
+		process.stdout.write('Clearing packages folder...')
+		try {
+			fs.rmSync( 'packages', { recursive: true, force: true } );
+			onSameLine(`${logSymbols.success} Cleared packages folder`)
+		} catch ( err ) {
+			onSameLine(`${logSymbols.error} ${err.message}`)
+			throw err
+		}
+
+		process.stdout.write('Installing PHP dependencies...')
+
+		const composerEnv = {
+			env: { ...process.env, COMPOSER_VENDOR_DIR: 'packages' },
+		}
+
+		await runExec( 'composer install -o -a -n --no-dev --no-scripts', composerEnv )
+		onSameLine(`${logSymbols.success} Installed PHP dependencies`);
+		process.stderr.write('Composer dumping....')
+
+		await runExec( 'composer dump', composerEnv )
+		onSameLine(`${logSymbols.success} Composer updated`)
+		commitMessages?.push( 'update 3rd party dependencies' )
+
+		process.stdout.write('Building plugin resources...')
+		let buildScript
+		try {
+			buildScript = JSON.parse( fs.readFileSync( 'package.json', 'utf8' ) ).scripts?.build
+		} catch {
+			buildScript = null
+		}
+
+		if ( ! buildScript ) {
+			onSameLine(`${logSymbols.warning} No package.json build script, skipping`)
+		} else {
+			await runExec( 'npm run build' )
+			onSameLine(`${logSymbols.success} Built plugin resources`);
+			commitMessages?.push( 'Build plugin resources' )
+		}
+
+		console.log('')
+		await new Promise( ( resolve, reject ) => {
+			wpPot( ( err ) => err ? reject( err ) : resolve() )
+		} )
+	} )()
+}
+
+function runExec( cmd, options ) {
+	return new Promise( ( resolve, reject ) => {
+		execCommand( cmd, ( stdout, error, stderr ) => {
+			if ( error ) {
+				onSameLine(`${logSymbols.error} ${stderr || error.message}`)
+				reject( error )
+				return
+			}
+			resolve( stdout )
+		}, options )
+	} )
 }