sdc-build-wp 5.0.0 → 5.0.2

package/README.md

@@ -23,6 +23,7 @@ While watch is enabled, use the following keyboard commands to control the build
 
 ```sh
 [r]     Restart
+[c]     Clear cache
 [p]     Pause/Resume
 [q]     Quit
 ````

package/lib/build.js

@@ -3,7 +3,7 @@ import * as utils from './utils.js';
 import log from './logging.js';
 
 export async function build(watch = false) {
-	if (project.components.cache && project.builds.includes('cache')) {
+	if (project.builds.includes('cache')) {
 		try {
 			await project.components.cache.init();
 		} catch (error) {
@@ -48,7 +48,7 @@ export async function build(watch = false) {
 		project.builds.splice(project.builds.indexOf('server'), 1);
 		project.builds.push('server');
 		log('info', `Started watching [${project.builds.join(', ')}]`);
-		log('info', `[r] to restart, [p] to pause/resume, [q] to quit`);
+		log('info', `[r] to restart, [c] to clear cache, [p] to pause/resume, [q] to quit`);
 
 		for (let build of project.builds) {
 			try {
@@ -63,10 +63,8 @@ export async function build(watch = false) {
 	}
 }
 
-export function restartBuild() {
-	utils.stopActiveComponents();
-	setTimeout(() => {
-		utils.clearScreen();
-		build(true);
-	}, 100);
+export async function restartBuild() {
+	await utils.stopActiveComponents();
+	utils.clearScreen();
+	build(true);
 }

package/lib/components/scripts.js

@@ -54,7 +54,10 @@ export default class ScriptsComponent extends BaseComponent {
 
 		try {
 			const result = await esbuild.build({
-				platform: 'node',
+				platform: 'browser',
+				format: 'iife',
+				globalName: 'sdcBuild',
+				treeShaking: true,
 				entryPoints: [entry],
 				bundle: true,
 				minify: true,
@@ -97,7 +100,8 @@ export default class ScriptsComponent extends BaseComponent {
 			try {
 				await this.process();
 			} catch (error) {
-				this.log('error', `Failed to process scripts: ${error.message}`);
+				console.error(error);
+				this.log('error', `Failed to process scripts`);
 			}
 		});
 	}

package/lib/components/server.js

@@ -11,14 +11,7 @@ export default class ServerComponent extends BaseComponent {
 		this.description = `Run a dev proxy server for live reloading`;
 		this.sessions = {};
 		this.server = create('SDC WP Build Server');
-		this.watchedFiles = [
-			`${this.project.paths.dist}/**/*`,
-			`**/*.html`,
-			`**/*.json`
-		];
-		if (!this.project.shouldPHPLint) {
-			this.watchedFiles.push(`**/*.php`);
-		}
+		this.watchedFiles = [];
 		this.ignoredFiles = [
 			`.sdc-build-wp/cache/**`,
 			`node_modules/**`,
@@ -28,6 +21,14 @@ export default class ServerComponent extends BaseComponent {
 	}
 
 	async init() {
+		this.watchedFiles = [
+			`${this.project.paths.dist}/**/*`,
+			`**/*.html`,
+			`**/*.json`
+		];
+		if (!this.project.config.php.enabled) {
+			this.watchedFiles.push(`**/*.php`);
+		}
 		this.project.pageScript = await readFile(path.join(path.dirname(fileURLToPath(import.meta.url)), '../page-script.js'), 'utf8');
 	}
 

package/lib/config-validator.js

@@ -0,0 +1,104 @@
+import log from './logging.js';
+
+const configSchema = {
+	imagesPath: { type: 'string', optional: true },
+	errorLogPath: { type: 'string', optional: true },
+	entries: { type: 'object', optional: true },
+	php: {
+		type: 'object',
+		optional: true,
+		properties: {
+			enabled: { type: 'boolean', optional: true }
+		}
+	}
+};
+
+function validateType(value, expectedType, path = '') {
+	const actualType = Array.isArray(value) ? 'array' : typeof value;
+	if (actualType !== expectedType) {
+		throw new Error(`Configuration error at '${path}': expected ${expectedType}, got ${actualType}`);
+	}
+}
+
+function validateObject(obj, schema, path = '') {
+	if (!obj || typeof obj !== 'object') {
+		if (!schema.optional) {
+			throw new Error(`Configuration error at '${path}': expected object, got ${typeof obj}`);
+		}
+		return;
+	}
+
+	const allowedKeys = Object.keys(schema.properties || {});
+	const objKeys = Object.keys(obj);
+	const unknownKeys = objKeys.filter(key => !allowedKeys.includes(key));
+
+	if (unknownKeys.length > 0) {
+		log('warn', `Unknown configuration properties: ${unknownKeys.map(key => `${path}.${key}`).join(', ')}`);
+	}
+
+	for (const [key, subSchema] of Object.entries(schema.properties || {})) {
+		const currentPath = path ? `${path}.${key}` : key;
+		const value = obj[key];
+
+		if (value === undefined || value === null) {
+			if (!subSchema.optional) {
+				throw new Error(`Configuration error: required property '${currentPath}' is missing`);
+			}
+			continue;
+		}
+
+		if (subSchema.type === 'object' && subSchema.properties) {
+			validateObject(value, subSchema, currentPath);
+		} else {
+			validateType(value, subSchema.type, currentPath);
+		}
+	}
+}
+
+function validateConfig(config) {
+	try {
+		for (const [key, schema] of Object.entries(configSchema)) {
+			const value = config[key];
+			const currentPath = key;
+
+			if (value === undefined || value === null) {
+				if (!schema.optional) {
+					throw new Error(`Configuration error: required property '${currentPath}' is missing`);
+				}
+				continue;
+			}
+
+			if (schema.type === 'object' && schema.properties) {
+				validateObject(value, schema, currentPath);
+			} else {
+				validateType(value, schema.type, currentPath);
+			}
+		}
+		return true;
+	} catch (error) {``
+		console.error(error);
+		log('error', `Configuration validation failed`);
+		return false;
+	}
+}
+
+function getDefaultConfig() {
+	return {
+		errorLogPath: '../../../../../logs/php/error.log', // default Local by Flywheel error log path
+		php: {
+			enabled: true
+		}
+	};
+}
+
+function mergeWithDefaults(userConfig) {
+	const defaults = getDefaultConfig();
+
+	return {
+		...defaults,
+		...userConfig,
+		php: { ...defaults.php, ...userConfig.php }
+	};
+}
+
+export { validateConfig, getDefaultConfig, mergeWithDefaults };

package/lib/help.js

@@ -1,34 +1,48 @@
 import project from './project.js';
+import chalk from 'chalk';
 
 export default function() {
 	console.log(`
-Usage: sdc-build-wp [options] [arguments]
+${chalk.bold.blue('SDC Build WP')} - Custom WordPress build process
 
-Options:
-	-h, --help           Show help message and exit
-	-v, --version        Version
-	-w, --watch          Build and watch
-	-b, --builds BUILDS  Build with specific components
-	--no-cache           Disable build caching
-	--clear-cache        Clear build cache and exit
+${chalk.yellow('Usage:')} sdc-build-wp [options] [arguments]
 
-Components:
+${chalk.yellow('Options:')}
+  ${chalk.green('-h, --help')}           Show this help message and exit
+  ${chalk.green('-v, --version')}        Show version number and exit
+  ${chalk.green('-w, --watch')}          Build and watch for changes
+  ${chalk.green('-b, --builds BUILDS')}  Build with specific components (comma-separated)
+  ${chalk.green('--no-cache')}           Disable build caching for this run
+  ${chalk.green('--clear-cache')}        Clear all cached data and exit
 
+${chalk.yellow('Available Components:')}
 ${Object.entries(project.components).map(([key, component]) => {
-	return `${key}\t\t${component.description}\r\n`;
-}).join('')}
-Examples:
+		return `  ${chalk.cyan(key.padEnd(12))} ${component.description}`;
+	}).join('\n')}
 
-sdc-build-wp
-sdc-build-wp --watch
-sdc-build-wp --watch --builds=style,scripts
-sdc-build-wp --no-cache
-sdc-build-wp --clear-cache
+${chalk.yellow('Examples:')}
+  ${chalk.dim('# Basic build')}
+  sdc-build-wp
 
-While watch is enabled, use the following keyboard commands to control the build process:
+  ${chalk.dim('# Build and watch for changes')}
+  sdc-build-wp --watch
 
-	[r]     Restart
-	[p]     Pause/Resume
-	[q]     Quit
+  ${chalk.dim('# Build only specific components')}
+  sdc-build-wp --watch --builds=style,scripts
+
+  ${chalk.dim('# Build without cache')}
+  sdc-build-wp --no-cache
+
+  ${chalk.dim('# Clear cache and exit')}
+  sdc-build-wp --clear-cache
+
+${chalk.yellow('Watch Mode Controls:')}
+  ${chalk.green('[r]')} Restart build process
+  ${chalk.green('[p]')} Pause/Resume watching
+  ${chalk.green('[q]')} Quit and exit
+
+${chalk.yellow('Configuration:')}
+  Place your configuration in ${chalk.cyan('.sdc-build-wp/config.json')}
+  See documentation for available options.
 `);
 }

package/lib/project.js

@@ -9,6 +9,7 @@ import * as utils from './utils.js';
 import log from './logging.js';
 import * as LibComponents from './components/index.js';
 import help from './help.js';
+import { validateConfig, mergeWithDefaults } from './config-validator.js';
 
 let project = {
 	config: {},
@@ -69,7 +70,16 @@ project.chokidarOpts = {
 
 export async function init() {
 
-	project.argv = yargs(hideBin(process.argv)).parse();
+	project.components = Object.fromEntries(Object.entries(LibComponents).map(([name, Class]) => [name, new Class()]));
+
+	project.argv = yargs(hideBin(process.argv))
+		.help(false)
+		.argv;
+
+	if (project.argv.help || project.argv.h) {
+		help();
+		process.exit(0);
+	}
 
 	if (project.package.sdc) {
 		await convertPackageToConfig();
@@ -77,24 +87,18 @@ export async function init() {
 
 	await loadConfig();
 
-	project.components = Object.fromEntries(Object.entries(LibComponents).map(([name, Class]) => [name, new Class()]));
 	const styleDir = `${project.path}/${project.paths.src.src}/${project.paths.src.style}`;
 
-	if (project.argv.help || project.argv.h) {
-		help();
-		process.exit(0);
-	} else if (project.argv.version || project.argv.v) {
+	if (project.argv.version || project.argv.v) {
 		console.log(await utils.getThisPackageVersion());
 		process.exit(0);
 	} else if (project.argv['clear-cache']) {
-		if (project.components.cache) {
-			try {
-				await project.components.cache.init();
-				await project.components.cache.clearCache();
-			} catch (error) {
-				console.error(error);
-				log('error', `Failed to clear cache`);
-			}
+		try {
+			await project.components.cache.init();
+			await project.components.cache.clearCache();
+		} catch (error) {
+			console.error(error);
+			log('error', `Failed to clear cache`);
 		}
 		process.exit(0);
 	}
@@ -139,17 +143,17 @@ export async function init() {
 		log('warn', 'Continuing build process despite error');
 	});
 
-	process.on('uncaughtException', (error) => {
+	process.on('uncaughtException', async (error) => {
 		log('error', `Uncaught Exception: ${error.message}`);
 		log('warn', 'Attempting graceful shutdown');
-		utils.stopActiveComponents();
+		await utils.stopActiveComponents();
 		process.exit(1);
 	});
 
 	process.on('SIGINT', async function() {
 		console.log(`\r`);
 		if (project.isRunning) {
-			utils.stopActiveComponents();
+			await utils.stopActiveComponents();
 			project.isRunning = false;
 			utils.clearScreen();
 		}
@@ -174,7 +178,7 @@ export function keypressListen() {
 	process.stdin.resume();
 	process.stdin.setEncoding('utf8');
 
-	process.stdin.on('data', (key) => {
+	process.stdin.on('data', async (key) => {
 		switch (key) {
 			case '\r': // [Enter]/[Return]
 				console.log('\r');
@@ -192,9 +196,12 @@ export function keypressListen() {
 					log('warn', 'Paused build process');
 				}
 				break;
+			case 'c':
+				await project.components.cache.clearCache();
+				break;
 			case 'r':
 				log('info', 'Restarted build process');
-				restartBuild();
+				await restartBuild();
 				break;
 		}
 	});
@@ -217,16 +224,27 @@ export async function convertPackageToConfig() {
 export async function loadConfig() {
 	try {
 		const configFile = await fs.readFile(configPath, 'utf-8');
-		project.config = JSON.parse(configFile);
-		project.paths.images = project.config.imagesPath || `${project.path}/${project.paths.src.src}/${project.paths.src.images}`
-		project.paths.errorLog = process.env.ERROR_LOG_PATH || project.config.error_log_path || '../../../../../logs/php/error.log'
+		const rawConfig = JSON.parse(configFile);
+		if (!validateConfig(rawConfig)) {
+			log('error', 'Configuration validation failed');
+			process.exit(1);
+		}
+		project.config = mergeWithDefaults(rawConfig);
+		project.paths.images = project.config.imagesPath || `${project.path}/${project.paths.src.src}/${project.paths.src.images}`;
+		project.paths.errorLog = project.config.errorLogPath;
 		project.entries = project.config.entries || {};
-		project.shouldPHPLint = typeof project.config.php === 'undefined' || typeof project.config.php.enabled === 'undefined' || project.config.php.enabled == true;
 		setupConfigWatcher();
 	} catch (error) {
-		console.error(error);
-		log('error', `Failed to load config`);
-		process.exit(1);
+		if (error.code === 'ENOENT') {
+			log('warn', 'No config file found, using defaults');
+			project.config = mergeWithDefaults({});
+			project.paths.images = `${project.path}/${project.paths.src.src}/${project.paths.src.images}`;
+			project.entries = {};
+		} else {
+			console.error(error);
+			log('error', `Failed to load config: ${error.message}`);
+			process.exit(1);
+		}
 	}
 }
 
@@ -239,7 +257,7 @@ export function setupConfigWatcher() {
 	configWatcher.on('change', async () => {
 		if (!project.isRunning) { return; }
 		await loadConfig();
-		restartBuild();
+		await restartBuild();
 	});
 	configWatcher.on('error', (error) => {
 		console.error(error);

package/lib/utils.js

@@ -13,10 +13,10 @@ export function clearScreen() {
 	process.stdout.write('\x1B[2J\x1B[0f');
 }
 
-export function stopActiveComponents() {
+export async function stopActiveComponents() {
 	if (project.configWatcher) {
 		try {
-			project.configWatcher.close();
+			await project.configWatcher.close();
 		} catch (error) {
 			console.error(error);
 			log('error', 'Failed to stop config file watcher');
@@ -36,7 +36,7 @@ export function stopActiveComponents() {
 		}
 		if (component.watcher) {
 			try {
-				component.watcher.close();
+				await component.watcher.close();
 			} catch (error) {
 				console.warn(`Failed to stop watcher for ${component.constructor.name}:`, error.message);
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sdc-build-wp",
-	"version": "5.0.0",
+	"version": "5.0.2",
 	"description": "Custom WordPress build process.",
 	"engines": {
 		"node": ">=22"
@@ -32,14 +32,14 @@
 		"chalk": "^5.4.1",
 		"chokidar": "^4.0.3",
 		"esbuild": "^0.25.8",
-		"eslint": "^9.31.0",
+		"eslint": "^9.32.0",
 		"fs-extra": "^11.3.0",
 		"postcss": "^8.5.6",
 		"postcss-scss": "^4.0.9",
 		"postcss-sort-media-queries": "^5.2.0",
 		"sass": "^1.89.2",
 		"sharp": "^0.34.3",
-		"stylelint": "^16.22.0",
+		"stylelint": "^16.23.0",
 		"svgo": "^4.0.0",
 		"tail": "^2.2.6",
 		"yargs": "^18.0.0"