wp-advads 1.0.38 → 1.0.40

package/README.md

@@ -51,6 +51,14 @@ Bumps the version, changelog, translations, build, and git (explicit file list,
 npx wp-advads release
 ```
 
+#### `changelog`
+
+Prints pending `.changelog` entries to the console. Does not write `changelog.txt` or `readme.txt`.
+
+```bash
+npx wp-advads changelog
+```
+
 #### `class <classname> [options]`
 
 Writes a PHP class under `paths.php`. Combine `--heading` with a template flag (`-i` / `-g` / `-r` / `-s`).

package/package.json

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

package/src/app.js

@@ -68,6 +68,12 @@ const app = async () => {
 		.description('Create a new release for the plugin')
 		.action(commands.release);
 
+	// Command: changelog
+	program
+		.command('changelog')
+		.description('Print pending .changelog entries to the console')
+		.action(commands.changelog);
+
 	// Command: class
 	program
 		.command('class')

package/src/commands/changelog.js

@@ -0,0 +1,94 @@
+/**
+ * External Dependencies
+ */
+import fs from 'fs'
+import logSymbols from 'log-symbols'
+
+/**
+ * Internal Dependencies
+ */
+import { heading, onSameLine, write } from '../utilities/index.js'
+
+const LABELS = {
+	fix: 'Fix',
+	feature: 'Feature',
+	improvement: 'Improvement',
+}
+
+/**
+ * Collect formatted changelog lines from `.changelog` (read-only).
+ *
+ * @param {string} dir Directory with pending changelog entry files
+ * @returns {string[]|null} Formatted lines, empty array if none, null if missing
+ */
+export function collectChangelogLines( dir = './.changelog' ) {
+	if ( ! fs.existsSync( dir ) ) {
+		return null
+	}
+
+	const changes = {
+		fix: [],
+		feature: [],
+		improvement: [],
+	}
+	const allowed = Object.keys( LABELS )
+
+	for ( const fileName of fs.readdirSync( dir ).sort() ) {
+		const type = fileName.split( '-' )[ 0 ]
+
+		if ( ! allowed.includes( type ) ) {
+			continue
+		}
+
+		const content = fs.readFileSync( `${ dir }/${ fileName }`, 'utf8' ).trim()
+		if ( content ) {
+			changes[ type ].push( `- ${ LABELS[ type ] }: ${ content }` )
+		}
+	}
+
+	const entries = [
+		...changes.feature,
+		...changes.improvement,
+		...changes.fix,
+	]
+
+	if ( entries.length === 0 ) {
+		return []
+	}
+
+	const date = new Date().toLocaleDateString( 'en', {
+		year: 'numeric',
+		month: 'long',
+		day: 'numeric',
+	} )
+
+	return [
+		`= Unreleased (${ date }) =`,
+		'',
+		...entries,
+	]
+}
+
+/**
+ * Print pending changelog entries to the console. Writes no files.
+ */
+export default function changelog() {
+	heading( 'Changelog preview' )
+	write( 'Reading .changelog...' )
+
+	const lines = collectChangelogLines()
+
+	if ( null === lines ) {
+		onSameLine( `${ logSymbols.error } Unable to find .changelog directory` )
+		return
+	}
+
+	if ( 0 === lines.length ) {
+		onSameLine( `${ logSymbols.warning } No pending changelog entries` )
+		return
+	}
+
+	onSameLine( `${ logSymbols.success } Pending changelog entries` )
+	console.log( '' )
+	console.log( lines.join( '\n' ) )
+}

package/src/commands/index.js

@@ -1,4 +1,5 @@
 export { default as build } from './build.js'
+export { default as changelog } from './changelog.js'
 export { default as css } from './css.js'
 export { default as classFile } from './class.js'
 export { default as init } from './init.js'

package/src/utilities/shell.js

@@ -3,46 +3,12 @@
  */
 import { spawn } from 'node:child_process'
 
-// cmd.exe metacharacters. See https://github.com/moxystudio/node-cross-spawn/blob/v7.0.6/lib/util/escape.js
-const WIN_META = /([()\][%!^"`<>&|;, *?])/g
-
-function escapeWinCommand( arg ) {
-	return String( arg ).replace( WIN_META, '^$1' )
-}
-
-function escapeWinArgument( arg ) {
-	let value = String( arg )
-	value = value.replace( /(?=(\\+?)?)\1"/g, '$1$1\\"' )
-	value = value.replace( /(?=(\\+?)?)\1$/, '$1$1' )
-	value = `"${value}"`
-	return value.replace( WIN_META, '^$1' )
-}
-
-/**
- * Windows argv spawn must go through cmd.exe so PATHEXT (.cmd/.bat) resolves.
- * Direct spawn('wp') looks for wp.exe only and throws ENOENT.
- *
- * @param {string} file Command name
- * @param {string[]} args Arguments
- * @param {string} [comspec] cmd.exe path
- * @returns {{ file: string, args: string[], options: Object }}
- */
-export function winArgvSpawnSpec( file, args, comspec = process.env.ComSpec || process.env.comspec || 'cmd.exe' ) {
-	const shellCommand = [ escapeWinCommand( file ), ...args.map( escapeWinArgument ) ].join( ' ' )
-	return {
-		file: comspec,
-		args: [ '/d', '/s', '/c', `"${shellCommand}"` ],
-		options: { shell: false, windowsVerbatimArguments: true },
-	}
-}
-
 function spawnArgv( file, args, spawnOpts ) {
 	if ( process.platform !== 'win32' ) {
 		return spawn( file, args, { ...spawnOpts, shell: false } )
 	}
 
-	const spec = winArgvSpawnSpec( file, args )
-	return spawn( spec.file, spec.args, { ...spawnOpts, ...spec.options } )
+	return spawn( file, args, { ...spawnOpts, shell: true } )
 }
 
 /**

package/test/changelog-preview.test.js

@@ -0,0 +1,51 @@
+/**
+ * Standalone changelog command: print pending entries to console, write nothing.
+ */
+import assert from 'node:assert/strict'
+import { existsSync } from 'node:fs'
+import { mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+import { test } from 'node:test'
+import { collectChangelogLines } from '../src/commands/changelog.js'
+
+test( 'collectChangelogLines formats .changelog entries and does not write files', async () => {
+	const dir = await mkdtemp( join( tmpdir(), 'wp-advads-changelog-preview-' ) )
+	const cwd = process.cwd()
+	process.chdir( dir )
+
+	try {
+		await mkdir( join( dir, '.changelog' ) )
+		await writeFile( join( dir, '.changelog', 'feature-1' ), 'add widgets\n' )
+		await writeFile( join( dir, '.changelog', 'fix-2' ), 'crash on save\n' )
+		await writeFile( join( dir, '.changelog', 'improvement-3' ), 'faster load\n' )
+		await writeFile( join( dir, '.changelog', 'notes' ), 'ignored\n' )
+
+		const lines = collectChangelogLines()
+
+		assert.ok( lines.some( ( line ) => line.startsWith( '= Unreleased (' ) ) )
+		assert.ok( lines.includes( '- Feature: add widgets' ) )
+		assert.ok( lines.includes( '- Improvement: faster load' ) )
+		assert.ok( lines.includes( '- Fix: crash on save' ) )
+		assert.equal( lines.indexOf( '- Feature: add widgets' ) < lines.indexOf( '- Improvement: faster load' ), true )
+		assert.equal( lines.indexOf( '- Improvement: faster load' ) < lines.indexOf( '- Fix: crash on save' ), true )
+		assert.equal( existsSync( join( dir, 'changelog.txt' ) ), false )
+		assert.equal( existsSync( join( dir, 'readme.txt' ) ), false )
+	} finally {
+		process.chdir( cwd )
+		await rm( dir, { recursive: true, force: true } )
+	}
+} )
+
+test( 'collectChangelogLines returns null when .changelog is missing', async () => {
+	const dir = await mkdtemp( join( tmpdir(), 'wp-advads-changelog-missing-' ) )
+	const cwd = process.cwd()
+	process.chdir( dir )
+
+	try {
+		assert.equal( collectChangelogLines(), null )
+	} finally {
+		process.chdir( cwd )
+		await rm( dir, { recursive: true, force: true } )
+	}
+} )

package/test/shell.test.js

@@ -3,11 +3,11 @@
  * TASK-005: argv is not interpolated through a shell.
  */
 import assert from 'node:assert/strict'
-import { existsSync, rmSync } from 'node:fs'
+import { existsSync, readFileSync, rmSync } from 'node:fs'
 import { tmpdir } from 'node:os'
 import { join } from 'node:path'
 import { test } from 'node:test'
-import { execCommand, runCommand, winArgvSpawnSpec } from '../src/utilities/shell.js'
+import { execCommand, runCommand } from '../src/utilities/shell.js'
 
 function execOnce( command ) {
 	return new Promise( ( resolve ) => {
@@ -131,23 +131,10 @@ test( 'execCommand does not ENOBUFS on stdout larger than 1MB', async () => {
 	}
 } )
 
-test( 'Windows argv spawn uses cmd.exe so PATHEXT commands like wp.cmd resolve', () => {
-	const spec = winArgvSpawnSpec( 'wp', [ 'i18n', 'make-pot' ], 'C:\\Windows\\system32\\cmd.exe' )
-	assert.equal( spec.file, 'C:\\Windows\\system32\\cmd.exe' )
-	assert.deepEqual( spec.args.slice( 0, 3 ), [ '/d', '/s', '/c' ] )
-	assert.match( spec.args[3], /wp/ )
-	assert.equal( spec.options.windowsVerbatimArguments, true )
-	assert.equal( spec.options.shell, false )
-} )
-
-test( 'Windows argv spawn escapes cmd metacharacters so headers and injection stay literal', () => {
-	const spec = winArgvSpawnSpec(
-		'wp',
-		[ '--headers={"Last-Translator":"A <b@c.com>"}', '& echo pwned' ],
-		'cmd.exe'
-	)
-	const line = spec.args[3]
-	assert.match( line, /\^</ )
-	assert.match( line, /\^>/ )
-	assert.match( line, /\^&/ )
+test( 'Windows argv spawn uses a shell so PATHEXT commands like wp.cmd resolve', () => {
+	const src = readFileSync( new URL( '../src/utilities/shell.js', import.meta.url ), 'utf8' )
+	const spawnArgv = src.split( 'function spawnArgv' )[1].split( 'export function' )[0]
+	assert.match( spawnArgv, /process\.platform !== 'win32'/ )
+	assert.match( spawnArgv, /shell:\s*false/ )
+	assert.match( spawnArgv, /shell:\s*true/ )
 } )