sdc-build-wp 4.7.0 → 4.8.0

package/README.md

@@ -16,4 +16,10 @@ Develop locally with the following command from within the test project director
 node ~/sites/sdc/sdc-build-wp/index.js --watch
 ```
 
-While watch is running, pressing `r` restarts the process. Pressing `q` quits the process.
+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

@@ -1,116 +1,11 @@
 #!/usr/bin/env node
-import parseArgs from 'minimist';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { promises as fs } from 'fs';
-import project from './lib/project.js';
-import log from './lib/logging.js';
-import * as LibComponents from './lib/components/index.js';
-
-project.components = Object.fromEntries(Object.entries(LibComponents).map(([name, Class]) => [name, new Class()]));
-
-const argv = parseArgs(process.argv.slice(2));
-
-if (argv.help || argv.h) {
-	console.log(`
-Usage: sdc-build-wp [options] [arguments]
-
-Options:
-  -h, --help           Show help message and exit
-  -v, --version        Version
-  -w, --watch          Build and watch
-  -b, --builds BUILDS  Build with specific components
-
-Components:
-
-${Object.entries(project.components).map(([key, component]) => {
-	return `${key}\t\t${component.description}\r\n`;
-}).join('')}
-Examples:
-
-sdc-build-wp
-sdc-build-wp --watch
-sdc-build-wp --watch --builds=style,scripts
-`);
-
-	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);
-}
-
-project.builds = argv.builds ? (Array.isArray(argv.builds) ? argv.builds : argv.builds.split(',')) : Object.keys(project.components);
+import { default as project, init, keypressListen } from './lib/project.js';
+import build from './lib/build.js';
 
 (async () => {
-	keypressListen();
-	await runBuild();
-})();
-
-process.on('SIGINT', function () {
-	console.log(`\r`);
-	if (process.stdin.isTTY) {
-		process.stdin.setRawMode(false);
-		process.stdin.pause();
+	await init();
+	if (project.argv.watch) {
+		keypressListen();
 	}
-	stopActiveComponents()
-	log('info', `Exiting sdc-build-wp`);
-	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 'r':
-				log('info', 'Restart requested...');
-				stopActiveComponents()
-				setTimeout(() => {
-					process.stdout.write('\x1B[2J\x1B[0f'); // Clear screen
-					runBuild();
-				}, 100);
-				break;
-		}
-	});
-}
-
-async function runBuild() {
-	if (argv.watch && project.builds.includes('server')) {
-		project.builds.splice(project.builds.indexOf('server'), 1);
-		project.builds.unshift('server');
-		project.components.server.serve(false);
-	}
-
-	let initialBuildTimerStart = performance.now();
-	log('info', `Started initial build [${project.builds.join(', ')}]`);
-	let promisesBuilds = [];
-	for (let build of project.builds) {
-		promisesBuilds.push(project.components[build].init());
-	}
-	await Promise.all(promisesBuilds);
-	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, [q] to quit`);
-		for (let build of project.builds) {
-			await project.components[build].watch();
-		}
-	}
-}
-
-function stopActiveComponents() {
-	if (project.components.server?.server) {
-		project.components.server.server.exit();
-	}
-}
+	await build(project.argv.watch);
+})();

package/lib/build.js

@@ -0,0 +1,34 @@
+import { default as project } from './project.js';
+import * as utils from './utils.js';
+import log from './logging.js';
+
+export default async function(watch = false) {
+	if (watch && project.builds.includes('server')) {
+		project.builds.splice(project.builds.indexOf('server'), 1);
+		project.builds.unshift('server');
+		project.components.server.serve(false);
+	}
+
+	let initialBuildTimerStart = performance.now();
+	log('info', `Started initial build [${project.builds.join(', ')}]`);
+	let promisesBuilds = [];
+	for (let build of project.builds) {
+		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 (watch && project.builds.includes('server')) {
+		project.isRunning = true;
+		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();
+		}
+	} else {
+		process.emit('SIGINT');
+	}
+}

package/lib/components/blocks.js

@@ -88,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/help.js

@@ -0,0 +1,30 @@
+import project from './project.js';
+
+export default function() {
+	console.log(`
+Usage: sdc-build-wp [options] [arguments]
+
+Options:
+	-h, --help           Show help message and exit
+	-v, --version        Version
+	-w, --watch          Build and watch
+	-b, --builds BUILDS  Build with specific components
+
+Components:
+
+${Object.entries(project.components).map(([key, component]) => {
+	return `${key}\t\t${component.description}\r\n`;
+}).join('')}
+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
+`);
+}

package/lib/project.js

@@ -1,6 +1,17 @@
+import parseArgs from 'minimist';
+import path from 'path';
+import { fileURLToPath } from 'url';
 import { readFile } from 'fs/promises';
+import { promises as fs } from 'fs';
+import build from './build.js';
+import * as utils from './utils.js';
+import log from './logging.js';
+import * as LibComponents from './components/index.js';
+import help from './help.js';
 
 let project = {
+	argv: null,
+	isRunning: false,
 	path: process.cwd(),
 	package: JSON.parse(await readFile(new URL(process.cwd() + '/package.json', import.meta.url))),
 	components: {},
@@ -54,3 +65,68 @@ project.chokidarOpts = {
 };
 
 export default project;
+
+export async function init() {
+	project.argv = parseArgs(process.argv.slice(2));
+	project.components = Object.fromEntries(Object.entries(LibComponents).map(([name, Class]) => [name, new Class()]));
+
+	if (project.argv.help || project.argv.h) {
+		help();
+		process.exit(0);
+	} else if (project.argv.version || project.argv.v) {
+		console.log(JSON.parse(await fs.readFile(path.join(path.dirname(fileURLToPath(import.meta.url)), '../package.json'))).version);
+		process.exit(0);
+	}
+
+	project.builds = project.argv.builds ? (Array.isArray(project.argv.builds) ? project.argv.builds : project.argv.builds.split(',')) : Object.keys(project.components);
+
+	process.on('SIGINT', function () {
+		console.log(`\r`);
+		if (project.isRunning) {
+			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);
+	});
+
+}
+
+export 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();
+					build(true);
+				}, 100);
+				break;
+		}
+	});
+}

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.7.0",
+	"version": "4.8.0",
 	"description": "Custom WordPress build process.",
 	"engines": {
 		"node": ">=22"