sdc-build-wp 4.3.0 → 4.3.2

package/README.md

@@ -5,6 +5,7 @@ npm install sdc-build-wp
 sdc-build-wp # build
 sdc-build-wp --watch # build and watch
 sdc-build-wp --watch --builds=style,scripts # comma-seperated list of components to include
+sdc-build-wp --help
 ```
 
 ## Develop

package/index.js

@@ -1,35 +1,57 @@
 #!/usr/bin/env node
 import parseArgs from 'minimist';
 const argv = parseArgs(process.argv.slice(2));
+import path from 'path';
+import { fileURLToPath } from 'url';
 import { promises as fs } from 'fs';
 import { Tail } from 'tail';
 import project from './lib/project.js';
 import log from './lib/logging.js';
 import * as LibComponents from './lib/components/index.js';
 
-project.components = {
-	style: new LibComponents.style(),
-	scripts: new LibComponents.scripts(),
-	blocks: new LibComponents.blocks(),
-	images: new LibComponents.images(),
-	fonts: new LibComponents.fonts(),
-	php: new LibComponents.php(),
-	server: new LibComponents.server()
-};
+project.components = Object.fromEntries(Object.entries(LibComponents).map(([name, Class]) => [name, new Class()]));
 
-let builds = argv.builds ? argv.builds.split(',') : Object.keys(project.components).map(key => project.components[key].slug);
+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, --build 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 ? argv.builds.split(',') : Object.keys(project.components);
 
 (async() => {
 
 	let initialBuildTimerStart = Date.now();
 	log('info', `Starting initial build`);
-	for (let build of builds) {
+	for (let build of project.builds) {
 		await project.components[build].init();
 	}
 	log('info', `Finished initial build in ${Math.round((Date.now() - initialBuildTimerStart) / 1000)} seconds`);
 
 	if (argv.watch) {
-		for (let build of builds) {
+		for (let build of project.builds) {
 			await project.components[build].watch();
 		}
 		try {

package/lib/components/base.js

@@ -8,6 +8,7 @@ import { glob } from 'node:fs/promises';
 class BaseComponent {
 
 	constructor() {
+		this.description = '';
 		this.timer = null;
 		this.path = path;
 		this.utils = utils;
@@ -17,7 +18,6 @@ class BaseComponent {
 		this.glob = glob;
 		this.files = [];
 		this.globs = [];
-		this.slug = 'base';
 	}
 
 	async init() {

package/lib/components/blocks.js

@@ -3,11 +3,11 @@ import { stat } from 'fs/promises';
 import { spawn } from 'child_process';
 import process from 'process';
 
-class BlocksComponent extends BaseComponent {
+export default class BlocksComponent extends BaseComponent {
 
 	constructor() {
 		super();
-		this.slug = 'blocks';
+		this.description = `Process the theme's WordPress blocks`;
 	}
 
 	async init() {
@@ -108,5 +108,3 @@ function cmd(commands) {
     });
   });
 }
-
-export { BlocksComponent as default }

package/lib/components/fonts.js

@@ -2,11 +2,11 @@ import BaseComponent from './base.js';
 import { readdir } from 'fs/promises';
 import fs from 'fs-extra';
 
-class FontsComponent extends BaseComponent {
+export default class FontsComponent extends BaseComponent {
 
 	constructor() {
 		super();
-		this.slug = 'fonts';
+		this.description = `Copy font files`;
 	}
 
 	async init() {
@@ -37,5 +37,3 @@ class FontsComponent extends BaseComponent {
 	}
 
 }
-
-export { FontsComponent as default }

package/lib/components/images.js

@@ -4,11 +4,11 @@ import imageminJpegtran from 'imagemin-jpegtran';
 import imageminPngquant from 'imagemin-pngquant';
 import imageminSvgo from 'imagemin-svgo';
 
-class ImagesComponent extends BaseComponent {
+export default class ImagesComponent extends BaseComponent {
 
 	constructor() {
 		super();
-		this.slug = 'images';
+		this.description = `Compress image files`;
 	}
 
 	async init() {
@@ -56,5 +56,3 @@ class ImagesComponent extends BaseComponent {
 	}
 
 }
-
-export { ImagesComponent as default }

package/lib/components/php.js

@@ -3,11 +3,11 @@ import { fileURLToPath } from 'url';
 import { exec } from 'child_process';
 import { promisify } from 'util';
 
-class PHPComponent extends BaseComponent {
+export default class PHPComponent extends BaseComponent {
 
 	constructor() {
 		super();
-		this.slug = 'php';
+		this.description = `Lint (and fix) php files`;
 		this.execPromise = promisify(exec);
 	}
 
@@ -103,5 +103,3 @@ class PHPComponent extends BaseComponent {
 	}
 
 }
-
-export { PHPComponent as default }

package/lib/components/scripts.js

@@ -3,11 +3,11 @@ import * as esbuild from 'esbuild';
 import { ESLint } from 'eslint';
 import * as eslintConfig from '../../eslint.config.js';
 
-class ScriptsComponent extends BaseComponent {
+export default class ScriptsComponent extends BaseComponent {
 
 	constructor() {
 		super();
-		this.slug = 'scripts';
+		this.description = `Process javascript files`;
 	}
 
 	async init() {
@@ -83,5 +83,3 @@ class ScriptsComponent extends BaseComponent {
 	}
 
 }
-
-export { ScriptsComponent as default }

package/lib/components/server.js

@@ -1,11 +1,11 @@
 import BaseComponent from './base.js';
 import { create as bsCreate } from 'browser-sync';
 
-class ServerComponent extends BaseComponent {
+export default class ServerComponent extends BaseComponent {
 
 	constructor() {
 		super();
-		this.slug = 'server';
+		this.description = `Run a dev proxy server for live reloading`;
 		this.server = bsCreate();
 	}
 
@@ -66,5 +66,3 @@ class ServerComponent extends BaseComponent {
 	}
 
 }
-
-export { ServerComponent as default }

package/lib/components/style.js

@@ -8,11 +8,11 @@ import autoprefixer from 'autoprefixer';
 import sortMQ from 'postcss-sort-media-queries';
 import stylelint from 'stylelint';
 
-class StyleComponent extends BaseComponent {
+export default class StyleComponent extends BaseComponent {
 
 	constructor() {
 		super();
-		this.slug = 'style';
+		this.description = `Process sass files`;
 	}
 
 	async init() {
@@ -194,5 +194,3 @@ class StyleComponent extends BaseComponent {
 	}
 
 }
-
-export { StyleComponent as default }

package/lib/project.js

@@ -4,6 +4,7 @@ let project = {
 	path: process.cwd(),
 	package: JSON.parse(await readFile(new URL(process.cwd() + '/package.json', import.meta.url))),
 	components: {},
+	builds: [],
 	globs: {},
 	entries: {},
 	files: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sdc-build-wp",
-	"version": "4.3.0",
+	"version": "4.3.2",
 	"description": "Custom WordPress build process.",
 	"engines": {
 		"node": ">=22"
@@ -23,7 +23,7 @@
 	},
 	"dependencies": {
 		"@stylistic/stylelint-plugin": "^3.1.2",
-		"@wordpress/scripts": "^30.11.0",
+		"@wordpress/scripts": "^30.12.0",
 		"autoprefixer": "^10.4.20",
 		"browser-sync": "^3.0.3",
 		"chalk": "^5.4.1",
@@ -39,8 +39,8 @@
 		"postcss": "^8.5.3",
 		"postcss-scss": "^4.0.9",
 		"postcss-sort-media-queries": "^5.2.0",
-		"sass": "^1.85.0",
-		"stylelint": "^16.14.1",
+		"sass": "^1.85.1",
+		"stylelint": "^16.15.0",
 		"tail": "^2.2.6"
 	}
 }