@ideasonpurpose/build-tools-wordpress 1.1.10 → 1.1.12

package/CHANGELOG.md

@@ -4,6 +4,18 @@ 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.11
+
+> 4 March 2024
+
+- Remove version from plugin builds WIP
+
+#### v1.1.10
+
+> 4 March 2024
+
+- use process.stdout references (of course)
+
 #### v1.1.9
 
 > 4 March 2024

package/README.md

@@ -1,9 +1,9 @@
 # @ideasonpurpose/build-tools-wordpress
 
-#### Version 1.1.10
+#### Version 1.1.12
 
-![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)
+[![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)
 
 Build scripts and dependencies for IOP's WordPress development environments.
 
@@ -15,6 +15,12 @@ Each project should have an **ideasonpurpose.config.js** file in the same direct
 - **`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.
 
+### Versioned Releases
+
+IOP versions our theme releases so every release creates a clear rollback snapshot. To accomplish this, each theme release is generated into a versioned directory. This works well for themes, where only one can be active, but fails for plugins where multiple versions can be simultaneously activated if their directory names are different. 
+
+To work around this, a `type` property can be added to the config file. When `type` is `plugin`, builds will not add the version to directory names.
+
 ## 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.

package/bin/zip.js

@@ -1,4 +1,6 @@
-import { readJson, ensureFile } from "fs-extra/esm";
+#! /usr/bin/env node
+
+import { readJsonSync, ensureFileSync } from "fs-extra/esm";
 import { stat } from "node:fs/promises";
 
 import { basename, dirname, join } from "node:path/posix";
@@ -35,31 +37,34 @@ async function getConfig() {
   const config = await buildConfig(configFile);
 
   // config.configFileUrl2 = configFile.filepath;
-  console.log({ config, configFile });
+  // 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 });
+// 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 ?? "";
 
-const archiveName = (await packageJson).name || "archive";
+const archiveName = pkgJson.name || "archive";
+const archiveVersion = config.type !== "plugin" ? `-${pkgJson.version}` : "";
 
-const versionDirName = packageJson.version
-  ? `${archiveName}-${packageJson.version}`.replace(/[ .]/g, "_")
-  : archiveName;
+const versionDirName = `${archiveName}${archiveVersion}`.replace(/[ .]/g, "_");
 
 const zipFileName = `${versionDirName}.zip`;
 const zipFile = new URL(`_builds/${zipFileName}`, config.configFileUrl);
-// .pathname;
 
-console.log({ zipFile, zipFileName });
-await ensureFile(zipFile.pathname);
+console.log({
+  archiveName,
+  archiveVersion,
+  versionDirName,
+  zipFile,
+  zipFileName,
+});
+
+ensureFileSync(zipFile.pathname);
 const output = createWriteStream(zipFile);
 
 output.on("finish", finishReporter);
@@ -181,7 +186,6 @@ function foundReporter(file) {
     // process.stdout.cursorTo(0);
     cursorTo(process.stdout, 0);
     process.stdout.write(outString);
-
   }
 }
 

package/package.json

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