sdc-build-wp 4.3.4 → 4.3.5

package/index.js

@@ -17,9 +17,9 @@ Usage: sdc-build-wp [options] [arguments]
 
 Options:
   -h, --help           Show help message and exit
-	-v, --version        Version
+  -v, --version        Version
   -w, --watch          Build and watch
-  -b, --build BUILDS   Build with specific components
+  -b, --builds BUILDS  Build with specific components
 
 Components:
 
@@ -39,12 +39,12 @@ console.log(JSON.parse(await fs.readFile(path.join(path.dirname(fileURLToPath(im
 process.exit(0);
 }
 
-project.builds = argv.builds ? argv.builds.split(',') : Object.keys(project.components);
+project.builds = argv.builds ? (Array.isArray(argv.builds) ? argv.builds : argv.builds.split(',')) : Object.keys(project.components);
 
 (async() => {
 
 	let initialBuildTimerStart = Date.now();
-	log('info', `Starting initial build [${project.builds.join(', ')}]`);
+	log('info', `Started initial build [${project.builds.join(', ')}]`);
 	for (let build of project.builds) {
 		await project.components[build].init();
 	}

package/lib/components/blocks.js

@@ -1,7 +1,7 @@
 import BaseComponent from './base.js';
 import { stat } from 'fs/promises';
-import { spawn } from 'child_process';
-import process from 'process';
+import { exec } from 'child_process';
+import { promisify } from 'util';
 
 export default class BlocksComponent extends BaseComponent {
 
@@ -49,14 +49,21 @@ export default class BlocksComponent extends BaseComponent {
 			this.log('error', `Failed building ${entry} blocks - no block.json found.`);
 			return false;
 		}
-		let cmds = [
-			`${this.project.path}/node_modules/@wordpress/scripts/bin/wp-scripts.js`,
-			`build`,
-			`--source-path=.${entry.replace(this.project.path, '')}/src`,
-			`--output-path=.${entry.replace(this.project.path, '')}/build`,
-			`--webpack-copy-php`
-		];
-		await cmd(cmds, { entryLabel: entryLabel });
+		try {
+			const cmds = [
+				`${this.project.path}/node_modules/@wordpress/scripts/bin/wp-scripts.js`,
+				`build`,
+				`--source-path=.${entry.replace(this.project.path, '')}/src`,
+				`--output-path=.${entry.replace(this.project.path, '')}/build`,
+				`--webpack-copy-php`
+			];
+			let execPromise = promisify(exec);
+			const { stdout, stderr } = await execPromise(cmds.join(' '));
+		} catch (error) {
+			console.log(error.stdout);
+			this.log('error', `Failed building ${entryLabel} block - See above error.`);
+			return false;
+		}
 
 		this.end({
 			itemLabel: entryLabel,
@@ -85,26 +92,3 @@ export default class BlocksComponent extends BaseComponent {
 	}
 
 }
-
-function cmd(commands) {
-  let p = spawn(commands[0], commands.slice(1), {
-		shell: true
-	});
-  return new Promise((resolveFunc) => {
-    p.stdout.on('data', (x) => {
-			if (x.toString().includes('Error:')) {
-				process.stdout.write(x.toString());
-				log('error', `Failed building ${entryLabel} block - See above error.`);
-			}
-    });
-    p.stderr.on('data', (x) => {
-			if (x.toString().includes('Error:')) {
-				process.stderr.write(x.toString());
-				log('error', `Failed building ${entryLabel} block - See above error.`);
-			}
-    });
-    p.on('exit', (code) => {
-      resolveFunc(code);
-    });
-  });
-}

package/lib/components/fonts.js

@@ -10,11 +10,15 @@ export default class FontsComponent extends BaseComponent {
 	}
 
 	async init() {
+		this.globs = await Array.fromAsync(
+			this.glob(this.project.package?.sdc?.fontsPath ||
+			`${this.project.path}/${this.project.paths.src.src}/${this.project.paths.src.fonts}`)
+		);
 		await this.process();
 	}
 
 	async build(entry) {
-		let entryLabel = `/dist/fonts`;
+		let entryLabel = `/${this.project.paths.dist}/${this.project.paths.src.fonts}`;
 
 		this.start();
 
@@ -22,6 +26,7 @@ export default class FontsComponent extends BaseComponent {
 			const fontsDir = await readdir(entry);
 			if (fontsDir.length == 0) { throw new Error('No files present'); }
 			await fs.copy(entry, `${this.project.path}${entryLabel}`);
+			entryLabel += ` (${fontsDir.filter(file => !file.startsWith('.')).length} files)`;
 		} catch(error) {
 			this.log('info', `${error} at ${entry.replace(this.project.path, '')}/. Skipping font copy`);
 			return false;
@@ -33,7 +38,15 @@ export default class FontsComponent extends BaseComponent {
 	}
 
 	async process() {
-		await this.build(`${this.project.path}/_src/fonts`);
+		await this.build(`${this.project.path}/${this.project.paths.src.src}/${this.project.paths.src.fonts}`);
+	}
+
+	watch() {
+		this.chokidar.watch(this.globs, {
+			...this.project.chokidarOpts
+		}).on('all', (event, path) => {
+			this.process();
+		});
 	}
 
 }

package/lib/components/images.js

@@ -25,7 +25,7 @@ export default class ImagesComponent extends BaseComponent {
 
 	async build(entry, options) {
 		let timerStart = Date.now();
-		let dest = entry.replace('_src/images', 'dist/images');
+		let dest = entry.replace(`${this.project.paths.src.src}/${this.project.paths.src.images}`, `${this.project.paths.dist}/${this.project.paths.src.images}`);
 		const files = await imagemin([entry + '/*'], {
 			destination: dest,
 			plugins: [

package/lib/components/php.js

@@ -8,7 +8,6 @@ export default class PHPComponent extends BaseComponent {
 	constructor() {
 		super();
 		this.description = `Lint (and fix) php files`;
-		this.execPromise = promisify(exec);
 	}
 
 	async init() {
@@ -56,8 +55,8 @@ export default class PHPComponent extends BaseComponent {
 				phpFiles,
 				additionalFlags
 			];
-
-			const { stdout, stderr } = await this.execPromise(cmds.join(' '), {
+			let execPromise = promisify(exec);
+			const { stdout, stderr } = await execPromise(cmds.join(' '), {
 				cwd: this.path.resolve(this.path.dirname(fileURLToPath(import.meta.url)), '../../')
 			}); // returns an error if any violations are found, so we can't rely on the try/catch as usual
 		} catch (error) {

package/lib/components/scripts.js

@@ -14,7 +14,7 @@ export default class ScriptsComponent extends BaseComponent {
 		this.files = this.utils.addEntriesByFiletypes(['.js']);
 		this.globs = await Array.fromAsync(
 			this.glob(this.project.package?.sdc?.jsGlobPath ||
-			`${this.project.path}/_src/scripts/**/*.js`)
+			`${this.project.path}/${this.project.paths.src.src}/${this.project.paths.src.scripts}/**/*.js`)
 		);
 		await this.process();
 	}
@@ -23,7 +23,7 @@ export default class ScriptsComponent extends BaseComponent {
 		options = Object.assign({}, {
 			entriesToLint: null
 		}, options);
-		let entryLabel = `/dist/scripts/${this.utils.entryBasename(entry).replace('.js', '.min.js')}`;
+		let entryLabel = `/${this.project.paths.dist}/${this.project.paths.src.scripts}/${this.utils.entryBasename(entry).replace('.js', '.min.js')}`;
 
 		this.start();
 
@@ -37,10 +37,10 @@ export default class ScriptsComponent extends BaseComponent {
 			await ESLint.outputFixes(lintresults);
 			const formatter = await eslint.loadFormatter('stylish');
 			const formatterOutput = formatter.format(lintresults);
-			if (formatterOutput) { console.log(formatterOutput.replace(this.project.path + '/_src/scripts/', '')); }
+			if (formatterOutput) { console.log(formatterOutput.replace(`${this.project.path}/${this.project.paths.src.src}/${this.project.paths.src.scripts}/`, '')); }
 		} catch (error) {
 			console.log(error);
-			this.log('error', `Failed linting ${entry.replace(this.project.path + '/_src/scripts/', '')} - See above error.`);
+			this.log('error', `Failed linting ${entry.replace(`${this.project.path}/${this.project.paths.src.src}/${this.project.paths.src.scripts}/`, '')} - See above error.`);
 			return false;
 		}
 
@@ -51,7 +51,7 @@ export default class ScriptsComponent extends BaseComponent {
 				bundle: true,
 				loader: { '.js': 'jsx' },
 				minify: true,
-				outdir: 'dist/scripts/',
+				outdir: `${this.project.paths.dist}/${this.project.paths.src.scripts}/`,
 				entryNames: '[dir]/[name].min',
 				plugins: [],
 				sourcemap: true
@@ -60,6 +60,7 @@ export default class ScriptsComponent extends BaseComponent {
 				log('warn', result.warnings);
 			}
 		} catch (error) {
+			console.error(error);
 			this.log('error', `Failed building ${entryLabel} - See above error.`);
 			return false;
 		}

package/lib/components/server.js

@@ -15,12 +15,12 @@ export default class ServerComponent extends BaseComponent {
 
 	start() {
 		let watchedFiles = [
-			this.project.path + '/dist/**/*',
-			this.project.path + '/**/*.html',
-			this.project.path + '/**/*.json',
+			`${this.project.path}/${this.project.paths.dist}/**/*`,
+			`${this.project.path}/**/*.html`,
+			`${this.project.path}/**/*.json`,
 		];
 		if (!this.project.shouldPHPLint) {
-			watchedFiles.push(this.project.path + '/**/*.php');
+			watchedFiles.push(`${this.project.path}/**/*.php`);
 		}
 		let bsOptions = {
 			logPrefix: '',

package/lib/components/style.js

@@ -18,14 +18,14 @@ export default class StyleComponent extends BaseComponent {
 		this.files = this.utils.addEntriesByFiletypes(['.scss']);
 		this.globs = await Array.fromAsync(
 			this.glob(this.project.package?.sdc?.sassGlobPath ||
-			`${this.project.path}{/_src/style,/blocks}/**/*.scss`)
+			`${this.project.path}{/${this.project.paths.src.src}/${this.project.paths.src.style},/blocks}/**/*.scss`)
 		);
 		await this.process();
 	}
 
 	async buildTheme() {
 		try {
-			let theme = JSON.parse(await fs.readFile(this.project.path + '/theme.json'));
+			let theme = JSON.parse(await fs.readFile(this.project.paths.theme.json));
 			let themeFileData = `// This file is automatically generated from theme.json. Do not edit.\n`;
 			if (theme.settings?.custom) {
 				for (var customAttribute in theme.settings.custom) {
@@ -74,7 +74,7 @@ export default class StyleComponent extends BaseComponent {
 				}
 			}
 			try {
-				await fs.writeFile(this.project.path + '/_src/style/partials/_theme.scss', themeFileData);
+				await fs.writeFile(this.project.paths.theme.scss, themeFileData);
 			} catch(error) {
 				console.error(error);
 				this.log('error', `Failed to write auto-generated _theme.scss - See above error.`);
@@ -91,7 +91,7 @@ export default class StyleComponent extends BaseComponent {
 			entriesToLint: []
 		}, options);
 		let thisClass = this;
-		let outFile = this.project.path + '/dist/' + options.name + '.min.css';
+		let outFile = `${this.project.path}/${this.project.paths.dist}/${options.name}.min.css`;
 		if (options.name.startsWith('blocks/')) {
 			outFile = this.project.path + '/' + options.name + '.min.css';
 		}
@@ -99,9 +99,9 @@ export default class StyleComponent extends BaseComponent {
 		this.start();
 
 		try {
-			await fs.access(`${this.project.path}/dist/style`);
+			await fs.access(`${this.project.path}/${this.project.paths.dist}/${this.project.paths.src.style}`);
 		} catch(error) {
-			await fs.mkdir(`${this.project.path}/dist/style`, { recursive: true });
+			await fs.mkdir(`${this.project.path}/${this.project.paths.dist}/${this.project.paths.src.style}`, { recursive: true });
 		}
 		try {
 			const stylelinted = await stylelint.lint({

package/lib/project.js

@@ -16,15 +16,27 @@ let project = {
 project.shouldPHPLint = typeof project.package.sdc?.php === 'undefined' || typeof project.package.sdc?.php.enabled === 'undefined' || project.package.sdc?.php.enabled == true;
 
 project.paths = {
+	src: {
+		src: '_src',
+		fonts: 'fonts',
+		images: 'images',
+		scripts: 'scripts',
+		style: 'style'
+	},
+	dist: 'dist'
+};
+
+project.paths = {
+	...project.paths,
 	theme: {
 		json: `${project.path}/theme.json`,
-		scss: `${project.path}/_src/style/partials/_theme.scss`
+		scss: `${project.path}/${project.paths.src.src}/${project.paths.src.style}/partials/_theme.scss`
 	},
 	nodeModules: `${project.path}/node_modules`,
 	composer: {
 		vendor: `${project.path}/vendor`
 	},
-	images: project.package?.sdc?.imagesPath || `${project.path}/_src/images`,
+	images: project.package?.sdc?.imagesPath || `${project.path}/${project.paths.src.src}/${project.paths.src.images}`,
 	errorLog: process.env.ERROR_LOG_PATH || project.package.sdc?.error_log_path || '../../../../../logs/php/error.log'
 };
 

package/package.json

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