@ideasonpurpose/build-tools-wordpress 2.10.3 → 2.10.4

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### v2.10.3
+
+> 17 July 2026
+
+- More reporter tweaks
+
 #### v2.10.2
 
 > 16 July 2026

package/README.md

@@ -1,6 +1,6 @@
 # @ideasonpurpose/build-tools-wordpress
 
-#### Version 2.10.3
+#### Version 2.10.4
 
 [![NPM Version](https://img.shields.io/npm/v/%40ideasonpurpose%2Fbuild-tools-wordpress?logo=npm)](https://www.npmjs.com/package/@ideasonpurpose/build-tools-wordpress)
 [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ideasonpurpose/build-tools-wordpress/npm-publish.yml?logo=github&logoColor=white)](https://github.com/ideasonpurpose/build-tools-wordpress#readme)

package/bin/zip.js

@@ -1,49 +1,46 @@
 #! /usr/bin/env node
+// @ts-check
 
-import { readJsonSync, ensureFileSync } from "fs-extra/esm";
-import { stat } from "node:fs/promises";
-
-import { basename, dirname, join } from "node:path/posix";
 import { createReadStream, createWriteStream, statSync } from "node:fs";
-
+import { basename, dirname, join } from "node:path/posix";
 import { clearLine, cursorTo } from "node:readline";
 
-import url from "url";
-import { fileURLToPath, pathToFileURL } from "node:url";
-
 import { ZipArchive } from "archiver";
 import chalk from "chalk";
-import { cosmiconfig, cosmiconfigSync } from "cosmiconfig";
+import cliTruncate from "cli-truncate";
+import { cosmiconfig } from "cosmiconfig";
 import { filesize } from "filesize";
+import { readJsonSync, ensureFileSync } from "fs-extra/esm";
 import { globby } from "globby";
 import isTextPath from "is-text-path";
-import cliTruncate from "cli-truncate";
-import stringLength from "string-length";
 import replaceStream from "replacestream";
+import stringLength from "string-length";
 
-// import buildConfig from "../lib/buildConfig.js";
 import { buildConfig } from "../index.js";
-// import {dirname} from "node:path";
 import { prettierHrtime } from "../lib/prettier-hrtime.js";
 
-// console.log(process.cwd());
-// console.log(import.meta.url);
-// console.log(new URL(import.meta.url));
+/**
+ * @typedef {import("../lib/buildConfig.js").BuildConfig} BuildConfig
+ *
+ * @typedef {Object} ArchiveFile
+ * @property {string} path - Path relative to projectDir
+ * @property {import("node:fs").Stats} stat
+ * @property {import("node:stream").Readable} contents
+ */
 
 async function getConfig() {
   const siteDir = process.cwd();
   const explorer = cosmiconfig("ideasonpurpose");
   const configFile = await explorer.search(siteDir);
-  const config = await buildConfig(configFile);
 
-  // config.configFileUrl2 = configFile.filepath;
-  // console.log({ config, configFile });
+  /** @type {BuildConfig} */
+  const config = await buildConfig(configFile);
 
   return { config };
 }
+/** @type {{ config: BuildConfig }} */
 const { config } = await getConfig();
 
-// config.configFileUrl = new URL("package.json", config.configFileUrl);
 const pkgJson = readJsonSync(new URL("package.json", config.configFileUrl));
 pkgJson.name = pkgJson.name ?? "archive";
 pkgJson.version = pkgJson.version ?? "";
@@ -56,14 +53,6 @@ const versionDirName = `${archiveName}${archiveVersion}`.replace(/[ .]/g, "_");
 const zipFileName = `${versionDirName}.zip`;
 const zipFile = new URL(`_builds/${zipFileName}`, config.configFileUrl);
 
-// console.log({
-//   archiveName,
-//   archiveVersion,
-//   versionDirName,
-//   zipFile,
-//   zipFileName,
-// });
-
 ensureFileSync(zipFile.pathname);
 const output = createWriteStream(zipFile);
 
@@ -80,7 +69,6 @@ const start = process.hrtime();
  * files will be found relative to this.
  */
 const projectDir = new URL(`${config.src}/../`, config.configFileUrl);
-// process.exit();
 
 /**
  * Counters for total uncompressed size and number of files
@@ -143,7 +131,10 @@ globby(
         inBytes += chunk.length;
       });
 
-      file.contents.on("end", () => foundReporter(file));
+      file.contents.on("end", () => {
+        fileCount += 1;
+        foundReporter(file);
+      });
 
       /**
        * Adding a data handler changes a stream's mode from paused to flowing
@@ -164,8 +155,11 @@ globby(
   .then(() => archive.finalize())
   .catch(console.error);
 
+/**
+ * @param {ArchiveFile} file
+ */
 function foundReporter(file) {
-  fileCount += 1;
+  if (!process.stdout.isTTY) return;
   let outString = [
     "🔍 ",
     chalk.yellow("Found"),
@@ -181,9 +175,7 @@ function foundReporter(file) {
   outString += chalk.blue(cliTruncate(file.path, cols, { position: "middle" }));
 
   if (fileCount % 25 == 0) {
-    // process.stdout.clearLine();
-    clearLine(process.stdout);
-    // process.stdout.cursorTo(0);
+    clearLine(process.stdout, 0);
     cursorTo(process.stdout, 0);
     process.stdout.write(outString);
   }
@@ -196,10 +188,7 @@ function finishReporter() {
   const savedBytes = inBytes - outBytes;
   const savedPercent = ((1 - outBytes / inBytes) * 100).toFixed(2);
 
-  // process.stdout.clearLine();
-  clearLine(process.stdout);
-
-  // process.stdout.cursorTo(0);
+  clearLine(process.stdout, 0);
   cursorTo(process.stdout, 0);
 
   console.log(

package/lib/buildConfig.js

@@ -1,11 +1,10 @@
+// @ts-check
+
 import fs from "fs-extra";
 import { posix as path } from "path";
 import chalk from "chalk";
 import url from "url";
 
-// import { findLocalPort } from "../index.js";
-
-// import defaultConfig from "../default.config.js";
 /**
  * Future node versions should import package.json directly:
  *   import packageJson from "./package.json" with { type: "json" };
@@ -19,11 +18,46 @@ import url from "url";
  * create a theme named 'iop-build-tools'.
  */
 const pkgJsonPath = path.resolve(process.cwd(), "./package.json");
-const packageJson = JSON.parse(fs.readFileSync(pkgJsonPath));
-// import packageJson from "./package.json" with { type: "json" };
+const packageJson = JSON.parse(fs.readFileSync(pkgJsonPath, "utf8"));
 
 const { name: themeName } = packageJson;
 
+/**
+ * Resolved project config returned by {@link buildConfig}.
+ *
+ * @typedef {Object} BuildConfig
+ * @property {string} src - Absolute path to the project source directory
+ * @property {string} dist - Absolute path to the project dist directory
+ * @property {Record<string, string|string[]>} entry - Webpack entry map keyed by basename
+ * @property {string} publicPath - Public URL path for compiled assets
+ * @property {string} contentBase
+ * @property {string} manifestFile
+ * @property {string} esTarget
+ * @property {string|false} devtool
+ * @property {string[]} transpileDependencies
+ * @property {string|boolean} proxy
+ * @property {URL} configFileUrl - File URL for the discovered config/package.json
+ * @property {"theme"|"plugin"|string} [type] - Project type; plugins omit version from archive names
+ */
+
+/**
+ * User-facing config values before path resolution and entry normalization.
+ *
+ * @typedef {Object} BuildConfigInput
+ * @property {string} [src]
+ * @property {string} [dist]
+ * @property {string|string[]|Record<string, string|string[]>} [entry]
+ * @property {string} [publicPath]
+ * @property {string} [contentBase]
+ * @property {string} [manifestFile]
+ * @property {string} [esTarget]
+ * @property {string|false} [devtool]
+ * @property {string|string[]} [transpileDependencies]
+ * @property {string|boolean} [proxy]
+ * @property {"theme"|"plugin"|string} [type]
+ * @property {URL} [configFileUrl]
+ */
+
 const defaultConfig = {
   src: `./wp-content/themes/${themeName}/src`,
   dist: `./wp-content/themes/${themeName}/dist`,
@@ -45,8 +79,10 @@ const defaultConfig = {
  *
  * Asynchronous values:
  *  -
+ *
+ * @param {{ filepath?: string, config?: BuildConfigInput } | null} [configFile]
+ * @returns {Promise<BuildConfig>}
  */
-
 export async function buildConfig(configFile = { config: {} }) {
   /**
    * This is a temporary workaround for a problem with using `process.env.NAME` in
@@ -150,17 +186,22 @@ export async function buildConfig(configFile = { config: {} }) {
    * Overlapping basenames will be joined into a single entrypoint
    *   ["./index.js", "./app.js", "./index.scss"]  =>  { app: ["./app.js"], index: ["./index.js", "./index.scss"]}
    */
-  if (typeof config.entry === "string") {
-    config.entry = [config.entry];
+  let entry = config.entry;
+  if (typeof entry === "string") {
+    entry = [entry];
   }
-  if (Array.isArray(config.entry)) {
-    config.entry = config.entry.reduce((obj, src) => {
-      obj[path.parse(src).name] = []
-        .concat(obj[path.parse(src).name], src)
-        .filter((i) => i);
-      return obj;
-    }, {});
+  if (Array.isArray(entry)) {
+    entry = entry.reduce(
+      (obj, src) => {
+        obj[path.parse(src).name] = /** @type {string[]} */ ([])
+          .concat(obj[path.parse(src).name], src)
+          .filter((i) => i);
+        return obj;
+      },
+      /** @type {Record<string, string[]>} */ ({}),
+    );
   }
+  config.entry = /** @type {Record<string, string | string[]>} */ (entry);
 
   /**
    * Remap proxy: true to default value
@@ -169,12 +210,13 @@ export async function buildConfig(configFile = { config: {} }) {
     config.proxy = defaultConfig.proxy;
   }
 
-  return config;
+  return /** @type {BuildConfig} */ (config);
 }
 
 /**
  * Warnings are broken out below
  */
+/** @param {string} src */
 const noSrcExists = (src) => {
   console.log(
     "🛑 ",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ideasonpurpose/build-tools-wordpress",
-  "version": "2.10.3",
+  "version": "2.10.4",
   "description": "Build scripts and dependencies for IOP's WordPress development environments.",
   "homepage": "https://github.com/ideasonpurpose/build-tools-wordpress#readme",
   "bugs": {