@wpelevator/wp-release 0.14.0 → 0.16.0

package/dist/single-project.js

@@ -0,0 +1,144 @@
+import { readdir } from 'node:fs/promises';
+import path from 'node:path';
+import { packageJsonVersion, composerJsonVersion, wordpressPluginVersion, wordpressThemeVersion, wordpressStableTag, } from "./changeset-config.js";
+import { ValidationError } from "./errors.js";
+import { readJsonIfExists } from "./json-files.js";
+import { parseFileHeaders, readFileStart } from "./package-meta.js";
+/** CLI names of version descriptor kinds. */
+export const VERSION_KINDS = {
+    'package-json': 'package-json',
+    'composer-json': 'composer-json',
+    'wordpress-plugin': 'wordpress-plugin-header',
+    'wordpress-theme': 'wordpress-theme-header',
+    'wordpress-stable-tag': 'wordpress-stable-tag',
+    'php-constant': 'php-constant',
+    'git-tag': 'git-tag',
+};
+function descriptorId(descriptor) {
+    if ('git-tag' === descriptor.kind) {
+        return descriptor.pattern ?? '';
+    }
+    return 'php-constant' === descriptor.kind
+        ? `${descriptor.file}#${descriptor.constant}`
+        : descriptor.file ?? '';
+}
+function selectSource(versions, selector) {
+    let candidates = versions;
+    if (selector) {
+        const separator = selector.indexOf(':');
+        const kind = separator < 0 ? selector : selector.slice(0, separator);
+        const id = separator < 0 ? undefined : selector.slice(separator + 1);
+        const descriptorKind = VERSION_KINDS[kind];
+        candidates = versions.filter((descriptor) => descriptor.kind === descriptorKind &&
+            (undefined === id || descriptorId(descriptor) === id));
+    }
+    else if (versions.length > 1) {
+        // A Stable tag can accompany a unique authoritative version file.
+        candidates = versions.filter((descriptor) => 'wordpress-stable-tag' !== descriptor.kind);
+    }
+    if (candidates.length !== 1) {
+        throw new ValidationError('Cannot choose the current version source. Pass --version-from <kind> or --version-from <kind>:<file> (PHP constants use <file>#<constant>), or add a wp-release config.');
+    }
+    return candidates[0];
+}
+async function detectVersions(cwd) {
+    const versions = [];
+    const entries = await readdir(cwd, { withFileTypes: true });
+    for (const entry of entries
+        .filter((item) => item.isFile() &&
+        (item.name.endsWith('.php') || 'style.css' === item.name))
+        .sort((a, b) => a.name.localeCompare(b.name))) {
+        const contents = await readFileStart(path.join(cwd, entry.name));
+        const theme = 'style.css' === entry.name;
+        const nameHeader = theme ? 'Theme Name' : 'Plugin Name';
+        const headers = parseFileHeaders({
+            contents: contents ?? '',
+            headers: [nameHeader, 'Version'],
+        });
+        if (headers[nameHeader]) {
+            versions.push(theme
+                ? wordpressThemeVersion({ file: entry.name })
+                : wordpressPluginVersion({ file: entry.name }));
+        }
+    }
+    for (const file of ['package.json', 'composer.json']) {
+        const manifest = await readJsonIfExists(path.join(cwd, file)).catch((error) => {
+            throw new ValidationError(`Could not read ${file}: ${error instanceof Error ? error.message : String(error)}`);
+        });
+        if (manifest && 'package.json' === file && manifest.workspaces) {
+            throw new ValidationError('Automatic changeset configuration is for a single root project. Configure workspace packages in a wp-release config or pass explicit --version-* descriptors.');
+        }
+        if (manifest &&
+            'string' === typeof manifest.version &&
+            manifest.version.trim()) {
+            versions.push('package.json' === file
+                ? packageJsonVersion()
+                : composerJsonVersion());
+        }
+    }
+    if (versions.length > 1) {
+        throw new ValidationError('Cannot choose among multiple root version sources. Pass explicit --version-* descriptors or add a wp-release config.');
+    }
+    if (1 === versions.length &&
+        'wordpress-plugin-header' === versions[0]?.kind) {
+        const readmes = await Promise.all(['readme.txt', 'readme.md'].map(async (file) => {
+            const contents = await readFileStart(path.join(cwd, file));
+            const headers = parseFileHeaders({
+                contents: contents ?? '',
+                headers: ['Stable tag'],
+            });
+            return headers['Stable tag'] ? file : undefined;
+        }));
+        const readme = readmes.find(Boolean);
+        if (readme) {
+            versions.push(wordpressStableTag({ file: readme }));
+        }
+    }
+    return versions;
+}
+/**
+ * Build the root package config, without creating a configuration file.
+ *
+ * @param cwd       Project root directory.
+ * @param options   Explicit descriptors and shared release settings.
+ * @param tagFormat Tag format override, otherwise v{version}.
+ * @return Root package config, or undefined without a version source.
+ */
+export async function resolveSingleProjectConfig(cwd, options = {}, tagFormat) {
+    const versions = options.versions ?? (await detectVersions(cwd));
+    if (!versions.length) {
+        return undefined;
+    }
+    const ids = versions.map((descriptor) => `${descriptor.kind}:${descriptorId(descriptor)}`);
+    if (new Set(ids).size !== ids.length) {
+        throw new ValidationError('A version descriptor was supplied more than once. Pass each --version-* file or constant only once.');
+    }
+    const from = selectSource(versions, options.versionFrom);
+    const to = versions.filter((descriptor) => 'git-tag' !== descriptor.kind);
+    // Composer targets preserve the existing optional-version convention.
+    const targets = to.map((descriptor) => 'composer-json' === descriptor.kind
+        ? { ...descriptor, ifPresent: descriptor.ifPresent ?? true }
+        : descriptor);
+    let idFrom = 'path';
+    if ('package-json' === from.kind && 'package.json' === from.file) {
+        idFrom = 'package.json#name';
+    }
+    else if ('composer-json' === from.kind &&
+        'composer.json' === from.file) {
+        idFrom = 'composer.json#name';
+    }
+    return {
+        ...(options.baseBranch ? { baseBranch: options.baseBranch } : {}),
+        ...(options.remote ? { remote: options.remote } : {}),
+        ...(undefined !== options.readmeChangelog
+            ? { readmeChangelog: options.readmeChangelog }
+            : {}),
+        ...(options.changelogInsertAfter
+            ? { changelogInsertAfter: options.changelogInsertAfter }
+            : {}),
+        root: '.',
+        changesets: options.changesets ?? '.changeset',
+        tagFormat: tagFormat ?? 'v{version}',
+        packages: [{ glob: '.', idFrom, version: { from, to: targets } }],
+    };
+}

package/dist/summary.d.ts

@@ -1,5 +1,6 @@
 import type { ChecksumsResult } from './commands/checksums.ts';
 import type { SignResult } from './commands/sign.ts';
+import type { BuildPackageResult } from './package-build.ts';
 import type { ZipPackageResult } from './package-zip.ts';
 import type { ChangesetTagResult } from './changeset-release.ts';
 import type { PackageRelease } from './changesets.ts';
@@ -69,6 +70,14 @@ export declare function formatTable(header: string[], rows: string[][]): string;
  * @return Markdown code.
  */
 export declare function formatFile(context: SummaryContext, file: string, line?: number | null): string;
+/**
+ * Get the summary of a directory build.
+ *
+ * @param context Workspace directory.
+ * @param result  Output directory and number of copied files.
+ * @return Markdown summary.
+ */
+export declare function getBuildSummary(context: SummaryContext, result: BuildPackageResult): string;
 /**
  * Get the summary of a ZIP.
  *

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.14.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",