@wpelevator/wp-release 0.15.0 → 0.16.0

package/dist/summary.js

@@ -99,6 +99,26 @@ function formatDetails(title, content) {
 function joinBlocks(blocks) {
     return `${blocks.filter(Boolean).join('\n\n')}\n`;
 }
+/**
+ * Get the summary of a directory build.
+ *
+ * @param context Workspace directory.
+ * @param result  Output directory and number of copied files.
+ * @return Markdown summary.
+ */
+export function getBuildSummary(context, result) {
+    return joinBlocks([
+        '### Build',
+        formatList([
+            `**Directory:** ${formatFile(context, result.outputDir)}, ${result.files} files`,
+            ...(result.checksumsPath
+                ? [
+                    `**Checksums:** ${formatFile(context, result.checksumsPath)}`,
+                ]
+                : []),
+        ]),
+    ]);
+}
 /**
  * Get the summary of a ZIP.
  *
@@ -111,6 +131,11 @@ export function getZipSummary(context, result) {
         '### ZIP',
         formatList([
             `**ZIP:** ${formatFile(context, result.zipPath)}, ${result.files} files`,
+            ...(result.checksumsEmbedded
+                ? [
+                    `**Embedded checksums:** ${formatCode(result.checksumsEmbedded)}`,
+                ]
+                : []),
             ...(result.checksumsPath
                 ? [
                     `**Checksums:** ${formatFile(context, result.checksumsPath)}`,

package/dist/zip.d.ts

@@ -14,6 +14,8 @@ export interface CreateZipInput {
     sourceDir: string;
     /** Relative file paths with forward slashes, from selectFiles(). */
     files: string[];
+    /** Generated entries, keyed by relative archive path. */
+    entries?: Record<string, Buffer>;
     /** Archive path. */
     zipPath: string;
     /** Folder to put the files in inside the archive, or null for the root. */
@@ -30,3 +32,4 @@ export interface CreateZipInput {
  * @throws {ValidationError} If the archive exists and force isn't set.
  */
 export declare function createZip(input: CreateZipInput): Promise<void>;
+export declare function isValidRootFolder(name: string): boolean;

package/dist/zip.js

@@ -31,11 +31,21 @@ export async function createZip(input) {
     }
     const zip = new yazl.ZipFile();
     const output = createWriteStream(zipPath, { flags: force ? 'w' : 'wx' });
-    [...files].sort().forEach((file) => zip.addFile(join(sourceDir, file), rootFolder ? posix.join(rootFolder, file) : file, {
-        mtime: ZIP_MTIME,
-        mode: ZIP_FILE_MODE,
-        forceDosTimestamp: true,
-    }));
+    const entries = input.entries ?? {};
+    [...files, ...Object.keys(entries)].sort().forEach((file) => {
+        const path = rootFolder ? posix.join(rootFolder, file) : file;
+        const options = {
+            mtime: ZIP_MTIME,
+            mode: ZIP_FILE_MODE,
+            forceDosTimestamp: true,
+        };
+        if (Object.hasOwn(entries, file)) {
+            zip.addBuffer(entries[file] ?? Buffer.alloc(0), path, options);
+        }
+        else {
+            zip.addFile(join(sourceDir, file), path, options);
+        }
+    });
     zip.end();
     try {
         await pipeline(zip.outputStream, output);
@@ -48,6 +58,6 @@ export async function createZip(input) {
         throw error;
     }
 }
-function isValidRootFolder(name) {
+export function isValidRootFolder(name) {
     return !/[\\/]/.test(name) && '.' !== name && '..' !== name;
 }

package/package.json

@@ -1,8 +1,13 @@
 {
 	"name": "@wpelevator/wp-release",
-	"version": "0.15.0",
+	"version": "0.16.0",
 	"description": "Package, checksum, sign, verify and version-check WordPress plugins and themes, and deploy plugins to WordPress.org SVN",
 	"license": "MIT",
+	"author": "WP Elevator (https://wpelevator.com)",
+	"homepage": "https://github.com/wpelevator/basement/tree/main/packages/js/wp-release#readme",
+	"bugs": {
+		"url": "https://github.com/wpelevator/basement/issues"
+	},
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/wpelevator/basement.git",