sdc-build-wp 4.6.3 → 4.7.1

package/README.md

@@ -15,3 +15,11 @@ Develop locally with the following command from within the test project director
 ```
 node ~/sites/sdc/sdc-build-wp/index.js --watch
 ```
+
+While watch is enabled, use the following keyboard commands to control the build process:
+
+```sh
+[r]     Restart
+[p]     Pause/Resume
+[q]     Quit
+````

package/index.js

@@ -5,6 +5,7 @@ import { fileURLToPath } from 'url';
 import { promises as fs } from 'fs';
 import project from './lib/project.js';
 import log from './lib/logging.js';
+import * as utils from './lib/utils.js';
 import * as LibComponents from './lib/components/index.js';
 
 project.components = Object.fromEntries(Object.entries(LibComponents).map(([name, Class]) => [name, new Class()]));
@@ -12,7 +13,7 @@ project.components = Object.fromEntries(Object.entries(LibComponents).map(([name
 const argv = parseArgs(process.argv.slice(2));
 
 if (argv.help || argv.h) {
-console.log(`
+	console.log(`
 Usage: sdc-build-wp [options] [arguments]
 
 Options:
@@ -31,18 +32,76 @@ Examples:
 sdc-build-wp
 sdc-build-wp --watch
 sdc-build-wp --watch --builds=style,scripts
+
+While watch is enabled, use the following keyboard commands to control the build process:
+
+  [r]     Restart
+  [p]     Pause/Resume
+  [q]     Quit
 `);
 
-process.exit(0);
+	process.exit(0);
 } else if (argv.version || argv.v) {
-console.log(JSON.parse(await fs.readFile(path.join(path.dirname(fileURLToPath(import.meta.url)), 'package.json'))).version);
-process.exit(0);
+	console.log(JSON.parse(await fs.readFile(path.join(path.dirname(fileURLToPath(import.meta.url)), 'package.json'))).version);
+	process.exit(0);
 }
 
 project.builds = argv.builds ? (Array.isArray(argv.builds) ? argv.builds : argv.builds.split(',')) : Object.keys(project.components);
 
-(async() => {
+(async () => {
+	keypressListen();
+	await runBuild();
+})();
+
+process.on('SIGINT', function () {
+	console.log(`\r`);
+	utils.stopActiveComponents();
+	project.isRunning = false;
+	utils.clearScreen();
+	log('info', `Exited sdc-build-wp`);
+	if (process.stdin.isTTY) {
+		process.stdin.setRawMode(false);
+		process.stdin.pause();
+	}
+	process.exit(0);
+});
+
+function keypressListen() {
+	if (!process.stdin.isTTY) { return; }
+
+	process.stdin.setRawMode(true);
+	process.stdin.resume();
+	process.stdin.setEncoding('utf8');
 
+	process.stdin.on('data', (key) => {
+		switch (key) {
+			case '\u0003': // Ctrl+C
+			case 'q':
+				process.emit('SIGINT');
+				return;
+			case 'p':
+				project.isRunning = !project.isRunning;
+				utils.clearScreen();
+				if (project.isRunning) {
+					log('success', 'Resumed build process');
+				} else {
+					log('warn', 'Paused build process');
+				}
+				break;
+			case 'r':
+				log('info', 'Restarted build process');
+				utils.stopActiveComponents();
+				setTimeout(() => {
+					utils.clearScreen();
+					runBuild();
+				}, 100);
+				break;
+		}
+	});
+}
+
+async function runBuild() {
+	project.isRunning = true;
 	if (argv.watch && project.builds.includes('server')) {
 		project.builds.splice(project.builds.indexOf('server'), 1);
 		project.builds.unshift('server');
@@ -56,24 +115,16 @@ project.builds = argv.builds ? (Array.isArray(argv.builds) ? argv.builds : argv.
 		promisesBuilds.push(project.components[build].init());
 	}
 	await Promise.all(promisesBuilds);
+	utils.clearScreen();
 	log('info', `Finished initial build in ${Math.round((performance.now() - initialBuildTimerStart) / 1000)} seconds`);
 
 	if (argv.watch && project.builds.includes('server')) {
 		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`);
 		for (let build of project.builds) {
 			await project.components[build].watch();
 		}
 	}
-
-})();
-
-process.on('SIGINT', function() {
-	console.log(`\r`);
-	if (project.components.server?.server) {
-		project.components.server.server.exit();
-	}
-	log('info', `Exiting sdc-build-wp`);
-	process.exit(0);
-});
+}

package/lib/components/blocks.js

@@ -1,3 +1,4 @@
+import { fileURLToPath } from 'url';
 import BaseComponent from './base.js';
 import { stat } from 'fs/promises';
 import { exec } from 'child_process';
@@ -55,12 +56,13 @@ export default class BlocksComponent extends BaseComponent {
 				`build`,
 				`--source-path=.${entry.replace(this.project.path, '')}/src`,
 				`--output-path=.${entry.replace(this.project.path, '')}/build`,
-				`--webpack-copy-php`
+				`--webpack-copy-php`,
+				`--config=${this.path.resolve(this.path.dirname(fileURLToPath(import.meta.url)), '../../webpack.config.js')}`,
 			];
 			let execPromise = promisify(exec);
 			const { stdout, stderr } = await execPromise(cmds.join(' '));
 		} catch (error) {
-			console.log(error.stdout);
+			console.log(error.stdout || error);
 			this.log('error', `Failed building ${entryLabel} block - See above error.`);
 			return false;
 		}
@@ -86,6 +88,7 @@ export default class BlocksComponent extends BaseComponent {
 			this.chokidar.watch(`${block}/src`, {
 				...this.project.chokidarOpts
 			}).on('all', (event, path) => {
+				if (!this.project.isRunning) { return; }
 				if (!['unlink', 'unlinkDir'].includes(event)) {
 					if (path.endsWith('.js')) {
 						this.project.components.scripts.lint(path);

package/lib/components/errors.js

@@ -26,6 +26,7 @@ export default class ErrorsComponent extends BaseComponent {
 		try {
 			await fs.access(this.project.paths.errorLog);
 			new Tail(this.project.paths.errorLog).on('line', function(data) {
+				if (!component.project.isRunning) { return; }
 				component.log('php', data);
 			});
 		} catch (error) {

package/lib/components/fonts.js

@@ -45,6 +45,7 @@ export default class FontsComponent extends BaseComponent {
 		this.watcher = this.chokidar.watch(this.globs, {
 			...this.project.chokidarOpts
 		}).on('all', (event, path) => {
+			if (!this.project.isRunning) { return; }
 			this.process();
 		});
 	}

package/lib/components/images.js

@@ -80,6 +80,7 @@ export default class ImagesComponent extends BaseComponent {
 		this.watcher = this.chokidar.watch(this.project.paths.images, {
 			...this.project.chokidarOpts
 		}).on('all', (event, path) => {
+			if (!this.project.isRunning) { return; }
 			this.process();
 		});
 	}

package/lib/components/php.js

@@ -90,6 +90,7 @@ export default class PHPComponent extends BaseComponent {
 		this.watcher = this.chokidar.watch(this.globs, {
 			...this.project.chokidarOpts
 		}).on('all', (event, path) => {
+			if (!this.project.isRunning) { return; }
 			if (!['unlink', 'unlinkDir'].includes(event)) {
 				this.process(path);
 			}

package/lib/components/scripts.js

@@ -72,6 +72,7 @@ export default class ScriptsComponent extends BaseComponent {
 		this.watcher = this.chokidar.watch(this.globs, {
 			...this.project.chokidarOpts
 		}).on('all', (event, path) => {
+			if (!this.project.isRunning) { return; }
 			this.process();
 		});
 	}

package/lib/components/server.js

@@ -78,6 +78,7 @@ export default class ServerComponent extends BaseComponent {
 			ignored: this.ignoredFiles,
 			ignoreInitial: true
 		}, (event, file) => {
+			if (!this.project.isRunning) { return; }
 			if (['add', 'addDir', 'change'].includes(event)) {
 				this.server.reload(file);
 				if (file.split('.').pop() == 'css') {

package/lib/components/style.js

@@ -181,6 +181,7 @@ export default class StyleComponent extends BaseComponent {
 		], {
 			...this.project.chokidarOpts
 		}).on('all', (event, path) => {
+			if (!this.project.isRunning) { return; }
 			let hasRanSingle = false;
 			for (let group of this.files) {
 				if (path == group.file || this.utils.getImportedSASSFiles(group.file).includes(path)) {

package/lib/project.js

@@ -1,6 +1,7 @@
 import { readFile } from 'fs/promises';
 
 let project = {
+	isRunning: false,
 	path: process.cwd(),
 	package: JSON.parse(await readFile(new URL(process.cwd() + '/package.json', import.meta.url))),
 	components: {},

package/lib/utils.js

@@ -3,6 +3,17 @@ import { readdir } from 'node:fs/promises';
 import path from 'path';
 import project from './project.js';
 
+export function clearScreen() {
+	if (!process.stdout.isTTY) { return; }
+	process.stdout.write('\x1B[2J\x1B[0f');
+}
+
+export function stopActiveComponents() {
+	if (project.components.server?.server) {
+		project.components.server.server.exit();
+	}
+}
+
 export function camelToDash(camel) {
 	return camel.replace(/[A-Z]/g, m => '-' + m.toLowerCase());
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sdc-build-wp",
-	"version": "4.6.3",
+	"version": "4.7.1",
 	"description": "Custom WordPress build process.",
 	"engines": {
 		"node": ">=22"

package/webpack.config.js

@@ -0,0 +1,9 @@
+import defaultConfig from '@wordpress/scripts/config/webpack.config.js';
+
+export default {
+	...defaultConfig,
+	mode: 'production',
+	cache: {
+		type: 'memory'
+	}
+};