@ideasonpurpose/build-tools-wordpress 1.1.5 → 1.1.7

package/CHANGELOG.md

@@ -4,6 +4,19 @@ 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).
 
+#### v1.1.6
+
+> 30 January 2024
+
+- test stuff and fixes
+- misc fixes and first zip testing
+
+#### v1.1.5
+
+> 25 January 2024
+
+- move the localPort stuff into devserver-proxy
+
 #### v1.1.4
 
 > 25 January 2024

package/README.md

@@ -1,18 +1,25 @@
 # @ideasonpurpose/build-tools-wordpress
 
-#### Version 1.1.5
+#### Version 1.1.7
 
 ![NPM Version](https://img.shields.io/npm/v/%40ideasonpurpose%2Fbuild-tools-wordpress?logo=npm)
 ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ideasonpurpose/build-tools-wordpress/npm-publish.yml?logo=github&logoColor=white)
 
-
 Build scripts and dependencies for IOP's WordPress development environments.
 
+## Config
+
+Each project should have an **ideasonpurpose.config.js** file in the same directory as **package.json**. This file should export an object with at least three properties set:
+
+- **`src`** - The **source** directory containing source files which should be compiled or transposed. The contents of this directory will be omitted from builds.
+- **`dist`** - The **distribution** directory where processed, production-ready files will be output to. All contents of this directory will be included in builds.
+- **`src`** - An array of file entry points relative to the `src` directory. Each entry point will generate a like-named output file. All files and assets imported by a given entry point will be accessible from that entry's corresponding output file.
+
 ## About This Project
 
 These tools were migrated from our [Docker-based WordPress build tools](https://github.com/ideasonpurpose/docker-build) to speed up development and began the process of moving our build tools away from webpack. Gathering dependencies also simplifies the package.json files in host projects, making those slightly more manageable.
 
-The included webpack.config.js file works best when paired with a PHP environment like our [Docker WordPress environments](https://github.com/ideasonpurpose/docker-wordpress-dev). It's capable of proxying to other servers, but that's sort of crazy.
+The **example/webpack.config.js** file works best when paired with a PHP environment like our [Docker WordPress environments](https://github.com/ideasonpurpose/docker-wordpress-dev). It's capable of proxying to other servers, but that's sort of crazy.
 
 ### Additional Notes
 
@@ -20,12 +27,14 @@ This project expects an entirely ES Module based environment and specifies all d
 
 #### Publishing to [npm](https://www.npmjs.com/package/@ideasonpurpose/build-tools-wordpress)
 
-A GitHub action will auto-publish version-tagged releases to npm. In order to publish, the repository must have an `NPM_TOKEN` secret set with the token from npm. [Log into npmjs.org](https://www.npmjs.com/login) with a publish-authorized account, then find the token page linked from the Profile page sidebar. Generate a new token and update the repository secret. 
+A GitHub action will auto-publish version-tagged releases to npm. In order to publish, the repository must have an `NPM_TOKEN` secret set with the token from npm. [Log into npmjs.org](https://www.npmjs.com/login) with a publish-authorized account, then find the token page linked from the Profile page sidebar. Generate a new token and update the repository secret.
 
-##  
+<!-- START IOP CREDIT BLURB -->
 
+## &nbsp;
 
 #### Brought to you by IOP
 
 <a href="https://www.ideasonpurpose.com"><img src="https://raw.githubusercontent.com/ideasonpurpose/ideasonpurpose/master/iop-logo-white-on-black-88px.png" height="44" align="top" alt="IOP Logo"></a><img src="https://raw.githubusercontent.com/ideasonpurpose/ideasonpurpose/master/spacer.png" align="middle" width="4" height="54"> This project is actively developed and used in production at <a href="https://www.ideasonpurpose.com">Ideas On Purpose</a>.
 
+<!-- END IOP CREDIT BLURB -->

package/bin/port-reporter.js

@@ -15,7 +15,7 @@ const main = async () => {
       "\n",
       " 🚀 ",
       chalk.bold("Local WP site:"),
-      chalk.magenta(`http://${info.hostname}:${chalk.bold(info.port)}`),
+      chalk.yellow(`http://${info.hostname}:${chalk.bold(info.port)}`),
       "\n",
     );
   } else {

package/bin/zip.js

@@ -0,0 +1,227 @@
+import { readJson, ensureFile } 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 url from "url";
+import { fileURLToPath, pathToFileURL } from "node:url";
+
+import archiver from "archiver";
+import chalk from "chalk";
+import { cosmiconfig, cosmiconfigSync } from "cosmiconfig";
+import { filesize } from "filesize";
+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 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));
+
+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 });
+
+  return { config };
+}
+const { config } = await getConfig();
+
+config.configFileUrl = new URL("package.json", config.configFileUrl);
+const packageJson = readJson(new URL("package.json", config.configFileUrl));
+packageJson.version = (await packageJson).version ??= "";
+
+console.log({ pgk: await packageJson });
+// console.log({ packageJson, env: process.env });
+
+const archiveName = (await packageJson).name || "archive";
+
+const versionDirName = packageJson.version
+  ? `${archiveName}-${packageJson.version}`.replace(/[ .]/g, "_")
+  : archiveName;
+
+const zipFileName = `${versionDirName}.zip`;
+const zipFile = new URL(`_builds/${zipFileName}`, config.configFileUrl);
+// .pathname;
+
+console.log({ zipFile, zipFileName });
+await ensureFile(zipFile.pathname);
+const output = createWriteStream(zipFile);
+
+output.on("finish", finishReporter);
+
+const archive = archiver("zip", { zlib: { level: 9 } });
+archive.pipe(output);
+
+console.log(chalk.bold("Bundling Project for Deployment"));
+const start = process.hrtime();
+
+/**
+ * Set projectDir to the parent directory of config.src, all bundled
+ * 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
+ * and a re-usable scoped continuer for file info
+ */
+let inBytes = 0;
+let fileCount = 0;
+
+const globOpts = { cwd: projectDir.pathname, nodir: false };
+globby(
+  [
+    "**/*",
+    "!_builds",
+    "!**/*.sql",
+    "!**/node_modules",
+    "!CHANGELOG.md",
+    "!composer.lock",
+    "!coverage*",
+    "!docker-compose.yml",
+    "!docker-compose.yml",
+    "!package-lock.json",
+    "!phpunit.xml",
+    "!src",
+    "!test",
+    "!tests",
+  ],
+  globOpts,
+)
+  .then((fileList) => {
+    /**
+     * Throw an error and bail out if there are no files to zip
+     */
+    if (!fileList.length) {
+      throw new Error("No files found.");
+    }
+    return fileList;
+  })
+  .then((fileList) =>
+    fileList.map((f) => {
+      const file = {
+        path: f,
+        stat: statSync(new URL(f, projectDir)),
+        contents: createReadStream(join(globOpts.cwd, f)),
+      };
+
+      /**
+       * Replace the dev folder name with the versioned folder name in hard-coded
+       * include paths. These replacements are only run against webpack's compiled
+       * assets and Composer's generated autoloaders.
+       */
+      if (isTextPath(f)) {
+        const devPath = new RegExp(`wp-content/themes/${archiveName}/`, "gi");
+
+        file.contents = file.contents.pipe(
+          replaceStream(devPath, `wp-content/themes/${versionDirName}/`),
+        );
+      }
+
+      file.contents.on("data", (chunk) => {
+        inBytes += chunk.length;
+      });
+
+      file.contents.on("end", () => foundReporter(file));
+
+      /**
+       * Adding a data handler changes a stream's mode from paused to flowing
+       * so we need to change it back or the streams will be truncated
+       */
+      file.contents.pause();
+      return file;
+    }),
+  )
+  .then((fileList) =>
+    fileList.map((f) =>
+      archive.append(f.contents, {
+        name: f.path,
+        prefix: versionDirName,
+      }),
+    ),
+  )
+  .then(() => archive.finalize())
+  .catch(console.error);
+
+function foundReporter(file) {
+  fileCount += 1;
+  let outString = [
+    "🔍 ",
+    chalk.yellow("Found"),
+    chalk.magenta(fileCount),
+    chalk.yellow("files..."),
+    chalk.gray(`(Uncompressed: ${filesize(inBytes)}) `),
+  ].join(" ");
+
+  /**
+   * calculate width of terminal then shorten paths
+   */
+  const cols = process.stdout.columns - stringLength(outString) - 1;
+  outString += chalk.blue(cliTruncate(file.path, cols, { position: "middle" }));
+
+  if (fileCount % 25 == 0) {
+    process.stdout.clearLine();
+    process.stdout.cursorTo(0);
+    process.stdout.write(outString);
+  }
+}
+
+function finishReporter() {
+  const outBytes = archive.pointer();
+  const end = process.hrtime(start);
+  const duration = prettierHrtime(end);
+  const savedBytes = inBytes - outBytes;
+  const savedPercent = ((1 - outBytes / inBytes) * 100).toFixed(2);
+
+  process.stdout.clearLine();
+  process.stdout.cursorTo(0);
+
+  console.log(
+    "🔍 ",
+    chalk.yellow("Found"),
+    chalk.magenta(fileCount),
+    chalk.yellow("files"),
+    chalk.gray(`(Uncompressed: ${filesize(inBytes)})`),
+  );
+  console.log(
+    "👀 ",
+    chalk.yellow("Webpack Bundle Analyzer report:"),
+    chalk.magenta("webpack/stats/index.html"),
+  );
+  console.log(
+    "📦 ",
+    chalk.yellow("Created"),
+    chalk.magenta(filesize(outBytes)),
+    chalk.yellow("Zip archive"),
+    chalk.gray(`(Saved ${filesize(savedBytes)}, ${savedPercent}%)`),
+  );
+  console.log(
+    "🎁 ",
+    chalk.yellow("Theme archive"),
+    chalk.magenta(
+      `${basename(dirname(zipFile.pathname))}/${chalk.bold(zipFileName)}`,
+    ),
+    chalk.yellow("created in"),
+    chalk.magenta(duration),
+  );
+  console.log("⏳");
+  console.log(
+    "🚀 ",
+    chalk.bold(`Remember to push to ${chalk.cyan("GitHub!")}`),
+  );
+  console.log("✨");
+}