@wpelevator/wp-release 0.15.0 → 0.17.0

package/dist/commands/changeset-project-args.js

@@ -0,0 +1,114 @@
+import { packageJsonVersion, composerJsonVersion, wordpressPluginVersion, wordpressThemeVersion, wordpressStableTag, phpConstantVersion, gitTagVersion, } from "../changeset-config.js";
+import { ValidationError } from "../errors.js";
+import { getBoolean, getString, getStrings } from "./command.js";
+export const changesetProjectArgs = {
+    'version-package-json': { type: 'string', multiple: true },
+    'version-composer-json': { type: 'string', multiple: true },
+    'version-wordpress-plugin': { type: 'string', multiple: true },
+    'version-wordpress-theme': { type: 'string', multiple: true },
+    'version-wordpress-stable-tag': { type: 'string', multiple: true },
+    'version-php-constant': { type: 'string', multiple: true },
+    'version-git-tag': { type: 'string', multiple: true },
+    'version-from': { type: 'string' },
+    'base-branch': { type: 'string' },
+    remote: { type: 'string' },
+    'changesets-dir': { type: 'string' },
+    'readme-changelog': { type: 'boolean' },
+    'no-readme-changelog': { type: 'boolean' },
+    'changelog-insert-after': { type: 'string' },
+};
+export const changesetProjectHelp = `
+Single-project options (without a release config file):
+  --version-package-json <file>             npm version source/target (repeatable)
+  --version-composer-json <file>            Composer source/target (repeatable)
+  --version-wordpress-plugin <file>         Plugin header source/target (repeatable)
+  --version-wordpress-theme <file>          Theme header source/target (repeatable)
+  --version-wordpress-stable-tag <file>     Readme Stable tag source/target (repeatable)
+  --version-php-constant <file>#<constant>  PHP constant source/target (repeatable)
+  --version-git-tag <pattern>               Git tag source only; use {version}
+  --version-from <kind>[:<file>]            Choose the source; constants use file#constant
+  --base-branch <branch>                   Default comparison branch on the remote
+  --remote <name>                          Git remote (default: origin)
+  --changesets-dir <dir>                   Changeset directory (default: .changeset)
+  --readme-changelog / --no-readme-changelog
+                                          Enable/disable readme changelog updates
+  --changelog-insert-after <marker>        Insert changelog entries after this marker
+
+Explicit descriptors define all version targets. Without them, detect one root
+project. A unique non-Stable-tag descriptor is the inferred source; otherwise
+pass --version-from, qualifying it with :file when its kind is repeated.
+Use the same project options for every changeset command.`;
+/**
+ * Parse shared single-project settings; operation flags stay command-specific.
+ *
+ * @param values Parsed command arguments.
+ * @return Fallback settings when explicitly supplied.
+ */
+export function parseChangesetProjectArgs(values) {
+    const options = {};
+    const versions = [];
+    const factories = {
+        'package-json': packageJsonVersion,
+        'composer-json': composerJsonVersion,
+        'wordpress-plugin': wordpressPluginVersion,
+        'wordpress-theme': wordpressThemeVersion,
+        'wordpress-stable-tag': wordpressStableTag,
+    };
+    for (const [kind, factory] of Object.entries(factories)) {
+        for (const file of getStrings(values, `version-${kind}`)) {
+            if (!file.trim()) {
+                throw new ValidationError(`--version-${kind} <file> must not be empty.`);
+            }
+            versions.push(factory({ file }));
+        }
+    }
+    for (const value of getStrings(values, 'version-php-constant')) {
+        const separator = value.lastIndexOf('#');
+        const file = value.slice(0, separator);
+        const constant = value.slice(separator + 1);
+        if (separator < 1 ||
+            !file.trim() ||
+            !/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(constant)) {
+            throw new ValidationError('--version-php-constant must be <file>#<constant>, for example plugin.php#PLUGIN_VERSION.');
+        }
+        versions.push(phpConstantVersion({ file, constant }));
+    }
+    const patterns = getStrings(values, 'version-git-tag');
+    if (patterns.length > 1) {
+        throw new ValidationError('--version-git-tag accepts one source pattern.');
+    }
+    for (const pattern of patterns) {
+        if (!pattern.trim() || !pattern.includes('{version}')) {
+            throw new ValidationError('--version-git-tag <pattern> must contain {version}.');
+        }
+        versions.push(gitTagVersion({ pattern }));
+    }
+    if (versions.length) {
+        options.versions = versions;
+    }
+    const strings = {
+        'version-from': 'versionFrom',
+        'base-branch': 'baseBranch',
+        remote: 'remote',
+        'changesets-dir': 'changesets',
+        'changelog-insert-after': 'changelogInsertAfter',
+    };
+    for (const [flag, key] of Object.entries(strings)) {
+        const value = getString(values, flag);
+        if (undefined !== value) {
+            if (!value.trim()) {
+                throw new ValidationError(`--${flag} must not be empty.`);
+            }
+            options[key] = value;
+        }
+    }
+    if (getBoolean(values, 'readme-changelog') &&
+        getBoolean(values, 'no-readme-changelog')) {
+        throw new ValidationError('--readme-changelog cannot be combined with --no-readme-changelog.');
+    }
+    if (getBoolean(values, 'readme-changelog') ||
+        getBoolean(values, 'no-readme-changelog')) {
+        options.readmeChangelog = getBoolean(values, 'readme-changelog');
+    }
+    return Object.keys(options).length ? { singleProject: options } : {};
+}

package/dist/commands/changeset-status.d.ts

@@ -22,7 +22,56 @@ declare const _default: {
     summary: string;
     help: string;
     options: {
-        readonly since: {
+        'version-package-json': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-composer-json': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-wordpress-plugin': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-wordpress-theme': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-wordpress-stable-tag': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-php-constant': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-git-tag': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-from': {
+            readonly type: "string";
+        };
+        'base-branch': {
+            readonly type: "string";
+        };
+        remote: {
+            readonly type: "string";
+        };
+        'changesets-dir': {
+            readonly type: "string";
+        };
+        'readme-changelog': {
+            readonly type: "boolean";
+        };
+        'no-readme-changelog': {
+            readonly type: "boolean";
+        };
+        'changelog-insert-after': {
+            readonly type: "string";
+        };
+        since: {
             readonly type: "string";
         };
     };

package/dist/commands/changeset-status.js

@@ -1,3 +1,4 @@
+import { changesetProjectArgs, changesetProjectHelp, parseChangesetProjectArgs, } from "./changeset-project-args.js";
 import { getChangesetStatus } from "../changeset-release.js";
 import { changesetStatusArgs, parseChangesetStatusArgs, } from "./changeset-args.js";
 export default {
@@ -8,12 +9,13 @@ export default {
   --since <ref>          Compare changed files with this git ref (for CI)
 
 Exit status is 2 when a changed package has no changeset added since the comparison base.
-An empty changeset added since the comparison base counts as an explicit no-release decision.`,
-    options: changesetStatusArgs,
+An empty changeset added since the comparison base counts as an explicit no-release decision.${changesetProjectHelp}`,
+    options: { ...changesetStatusArgs, ...changesetProjectArgs },
     async run({ values, cwd, configFile, tagFormat, logger }) {
         const { since } = parseChangesetStatusArgs(values);
         const result = await getChangesetStatus({
             cwd,
+            ...parseChangesetProjectArgs(values),
             ...(configFile ? { configFile } : {}),
             ...(tagFormat ? { tagFormat } : {}),
             ...(since ? { since } : {}),

package/dist/commands/changeset-tag.d.ts

@@ -4,23 +4,72 @@ declare const _default: {
     summary: string;
     help: string;
     options: {
-        readonly push: {
+        'version-package-json': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-composer-json': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-wordpress-plugin': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-wordpress-theme': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-wordpress-stable-tag': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-php-constant': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-git-tag': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-from': {
+            readonly type: "string";
+        };
+        'base-branch': {
+            readonly type: "string";
+        };
+        remote: {
+            readonly type: "string";
+        };
+        'changesets-dir': {
+            readonly type: "string";
+        };
+        'readme-changelog': {
+            readonly type: "boolean";
+        };
+        'no-readme-changelog': {
+            readonly type: "boolean";
+        };
+        'changelog-insert-after': {
+            readonly type: "string";
+        };
+        push: {
             readonly type: "boolean";
         };
-        readonly 'dry-run': {
+        'dry-run': {
             readonly type: "boolean";
         };
-        readonly untagged: {
+        untagged: {
             readonly type: "boolean";
         };
-        readonly since: {
+        since: {
             readonly type: "string";
         };
-        readonly package: {
+        package: {
             readonly type: "string";
             readonly multiple: true;
         };
-        readonly version: {
+        version: {
             readonly type: "string";
         };
     };

package/dist/commands/changeset-tag.js

@@ -1,3 +1,4 @@
+import { changesetProjectArgs, changesetProjectHelp, parseChangesetProjectArgs, } from "./changeset-project-args.js";
 import { tagChangesets } from "../changeset-release.js";
 import { parseChangesetTagArgs, changesetTagArgs } from "./changeset-args.js";
 import { getChangesetTagSummary, getTagStatus } from "../summary.js";
@@ -12,8 +13,9 @@ export default {
   --since <ref>          Tag packages changed since this git ref
   --package <name>       Tag only this package, by identifier or path under
                          the configured root (repeatable)
-  --version <version>    Fail unless the single --package is at this version;
-                         the version to tag for packages versioned by git tags
+  --version <version>    Fail unless the selected package is at this version;
+                         the version to tag for packages versioned by git tags.
+                         A sole root package is selected without --package
   --push                 Push newly created tags to the configured remote
                          (default: origin), one at a time
 
@@ -22,12 +24,13 @@ safe. Before a tag is created, every configured version target must match the
 version. With --json or --github-output, each tag comes with the title, notes
 and pre-release flag of its release, for a workflow step that creates the
 GitHub Release. --untagged lists only the releases that still need a tag, for
-example to release each of them with a separate workflow.`,
-    options: changesetTagArgs,
+example to release each of them with a separate workflow.${changesetProjectHelp}`,
+    options: { ...changesetTagArgs, ...changesetProjectArgs },
     async run({ values, cwd, configFile, tagFormat, logger }) {
         const args = parseChangesetTagArgs(values);
         const result = await tagChangesets({
             cwd,
+            ...parseChangesetProjectArgs(values),
             ...(configFile ? { configFile } : {}),
             ...(tagFormat ? { tagFormat } : {}),
             ...args,

package/dist/commands/changeset-version.d.ts

@@ -16,23 +16,72 @@ declare const _default: {
     summary: string;
     help: string;
     options: {
-        readonly 'dry-run': {
+        'version-package-json': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-composer-json': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-wordpress-plugin': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-wordpress-theme': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-wordpress-stable-tag': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-php-constant': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-git-tag': {
+            readonly type: "string";
+            readonly multiple: true;
+        };
+        'version-from': {
+            readonly type: "string";
+        };
+        'base-branch': {
+            readonly type: "string";
+        };
+        remote: {
+            readonly type: "string";
+        };
+        'changesets-dir': {
+            readonly type: "string";
+        };
+        'readme-changelog': {
+            readonly type: "boolean";
+        };
+        'no-readme-changelog': {
+            readonly type: "boolean";
+        };
+        'changelog-insert-after': {
+            readonly type: "string";
+        };
+        'dry-run': {
             readonly type: "boolean";
         };
-        readonly date: {
+        date: {
             readonly type: "string";
         };
-        readonly package: {
+        package: {
             readonly type: "string";
             readonly multiple: true;
         };
-        readonly 'no-dependents': {
+        'no-dependents': {
             readonly type: "boolean";
         };
-        readonly prerelease: {
+        prerelease: {
             readonly type: "string";
         };
-        readonly snapshot: {
+        snapshot: {
             readonly type: "string";
         };
     };

package/dist/commands/changeset-version.js

@@ -1,3 +1,4 @@
+import { changesetProjectArgs, changesetProjectHelp, parseChangesetProjectArgs, } from "./changeset-project-args.js";
 import { versionChangesets } from "../changeset-release.js";
 import { getChangesetVersionSummary } from "../summary.js";
 import { parseChangesetVersionArgs, changesetVersionArgs, } from "./changeset-args.js";
@@ -26,12 +27,13 @@ since the pre-release consumes the changesets that the stable release needs.
 The readme Stable tag keeps the last stable version.
 
 With --snapshot, build and publish the versioned files without committing
-them, for example to test a pull request.`,
-    options: changesetVersionArgs,
+them, for example to test a pull request.${changesetProjectHelp}`,
+    options: { ...changesetVersionArgs, ...changesetProjectArgs },
     async run({ values, cwd, configFile, tagFormat, logger }) {
         const args = parseChangesetVersionArgs(values);
         const result = await versionChangesets({
             cwd,
+            ...parseChangesetProjectArgs(values),
             ...(configFile ? { configFile } : {}),
             ...(tagFormat ? { tagFormat } : {}),
             ...args,

package/dist/commands/checksums.d.ts

@@ -27,10 +27,13 @@ declare const _default: {
         'filename-format': {
             type: "string";
         };
+        'checksums-format': {
+            type: "string";
+        };
         output: {
             type: "string";
         };
     };
-    run({ values, positionals, cwd, logger, }: import("./command.ts").CommandContext): Promise<CommandOutcome<ChecksumsResult>>;
+    run({ values, positionals, cwd, configFile, logger, }: import("./command.ts").CommandContext): Promise<CommandOutcome<ChecksumsResult>>;
 };
 export default _default;

package/dist/commands/checksums.js

@@ -1,6 +1,10 @@
-import { basename, resolve } from 'node:path';
-import { CHECKSUMS_EXTENSION, createChecksums, writeChecksums, } from "../checksums.js";
-import { ignoreOwnFile, ignoreOwnSignature, loadFileRules, resolveFileSelection, } from "../file-selection.js";
+import { ValidationError } from "../errors.js";
+import { mkdir, writeFile } from 'node:fs/promises';
+import { dirname, basename, resolve } from 'node:path';
+import { loadChangesetConfig } from "../changeset-config.js";
+import { resolveManifestCodec, encodeIntegrity } from "../integrity.js";
+import { CHECKSUMS_EXTENSION, createChecksums } from "../checksums.js";
+import { isErrorCode, ignoreOwnFile, ignoreOwnSignature, loadFileRules, resolveFileSelection, } from "../file-selection.js";
 import { FILENAME_FORMAT, formatFilename } from "../filename.js";
 import { readPackageMeta } from "../package-meta.js";
 import { getChecksumsSummary } from "../summary.js";
@@ -15,6 +19,7 @@ export default {
                               accepted as --source-dir <dir>
 
 Options:
+  --checksums-format <name>    wordpress-json (default) or sha256sum
   --output <file>             Manifest file (default: the --filename-format name
                               in the current directory)
   --slug <slug>               Plugin or theme slug (default: project directory name)
@@ -40,22 +45,27 @@ matches the ZIP contents.`,
         version: { type: 'string' },
         type: { type: 'string' },
         'filename-format': { type: 'string' },
+        'checksums-format': { type: 'string' },
         output: { type: 'string' },
         ...sourceDirArgs,
         ...fileSelectionArgs,
         force: { type: 'boolean' },
     },
-    async run({ values, positionals, cwd, logger, }) {
+    async run({ values, positionals, cwd, configFile, logger, }) {
         const sourceDir = resolve(cwd, getSourceDirArg(values, positionals));
         const slug = getString(values, 'slug') ?? basename(cwd);
         await checkDirectory(sourceDir);
         const meta = await readPackageMeta({ dir: sourceDir, slug });
         const version = getString(values, 'version') ?? meta?.version ?? null;
         const filename = formatFilename(getString(values, 'filename-format') ?? FILENAME_FORMAT, { slug, version });
+        const loaded = await loadChangesetConfig({ cwd, configFile });
+        const codec = resolveManifestCodec(getString(values, 'checksums-format') ?? loaded?.config.integrity?.codec);
         const checksumsPath = resolveOutput({
             cwd,
             output: getString(values, 'output'),
-            filename: filename + CHECKSUMS_EXTENSION,
+            filename: codec.id === 'wordpress-json'
+                ? filename + CHECKSUMS_EXTENSION
+                : codec.filename,
         });
         const selection = resolveFileSelection({
             cwd,
@@ -71,7 +81,18 @@ matches the ZIP contents.`,
             type: getString(values, 'type') ?? meta?.type,
         });
         const files = Object.keys(manifest.files).length;
-        await writeChecksums(checksumsPath, manifest, getBoolean(values, 'force'));
+        await mkdir(dirname(checksumsPath), { recursive: true });
+        try {
+            await writeFile(checksumsPath, await encodeIntegrity(codec, manifest), {
+                flag: getBoolean(values, 'force') ? 'w' : 'wx',
+            });
+        }
+        catch (error) {
+            if (isErrorCode(error, 'EEXIST')) {
+                throw new ValidationError(`${checksumsPath} already exists, pass --force to overwrite it.`);
+            }
+            throw error;
+        }
         logger.debug(`Hashed ${files} files in ${sourceDir}.`);
         logger.info(checksumsPath);
         logger.summary((context) => getChecksumsSummary(context, { checksumsPath, files }));

package/dist/commands/i18n-audit.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("./command.ts").Command;
+export default _default;

package/dist/commands/i18n-audit.js

@@ -0,0 +1,2 @@
+import { createI18nCommand } from "./i18n.js";
+export default createI18nCommand('audit');

package/dist/commands/i18n-compile.d.ts

@@ -0,0 +1,6 @@
+import type { Command } from './command.ts';
+/**
+ * Flat compiler adapters: translated PO input, independent of package/source discovery.
+ * @param format
+ */
+export declare function createI18nCompileCommand(format: 'mo' | 'json' | 'php'): Command;

package/dist/commands/i18n-compile.js

@@ -0,0 +1,76 @@
+import { resolve } from 'node:path';
+import { compileTranslations } from "../i18n/compile.js";
+import { ValidationError } from "../errors.js";
+import { readJson } from "../json-files.js";
+import { getBoolean, getString } from "./command.js";
+/**
+ * Flat compiler adapters: translated PO input, independent of package/source discovery.
+ * @param format
+ */
+export function createI18nCompileCommand(format) {
+    return {
+        name: `i18n-${format}`,
+        usage: `i18n-${format} <file.po> [options]`,
+        summary: `Compile translated PO into ${'php' === format ? 'WordPress .l10n.php' : format.toUpperCase()} files.`,
+        help: `Options:
+  --output <path>     Output file (${format === 'json' ? 'directory for JSON' : 'defaults beside the PO'})
+  --check             Compare generated bytes without writing
+${'json' === format
+            ? '  --domain <domain>   Required text domain\n  --map <file.json>   Source paths to runtime script path arrays (many-to-many)'
+            : ''}
+
+Requires Language and Plural-Forms headers. Fuzzy, obsolete and untranslated
+entries are excluded. Input PO files are never changed. No PHP/WP-CLI runtime
+is needed; compilation validates data before independent atomic output writes.`,
+        options: {
+            output: { type: 'string' },
+            check: { type: 'boolean' },
+            ...('json' === format
+                ? {
+                    domain: { type: 'string' },
+                    map: { type: 'string' },
+                }
+                : {}),
+        },
+        async run({ values, positionals, cwd, logger }) {
+            if (1 !== positionals.length || !positionals[0]?.trim()) {
+                throw new ValidationError(`i18n-${format} requires exactly one input PO file.`);
+            }
+            const output = getString(values, 'output');
+            const map = getString(values, 'map');
+            if ('' === output?.trim() || '' === map?.trim()) {
+                throw new ValidationError('--output and --map paths must not be empty.');
+            }
+            let scriptMap;
+            if (map) {
+                const parsed = await readJson(resolve(cwd, map));
+                if (!parsed ||
+                    'object' !== typeof parsed ||
+                    Array.isArray(parsed)) {
+                    throw new ValidationError('The script map must be an object of source paths to runtime path arrays.');
+                }
+                scriptMap = parsed;
+            }
+            const result = await compileTranslations({
+                sourcePath: resolve(cwd, positionals[0]),
+                format,
+                ...(output ? { outputPath: resolve(cwd, output) } : {}),
+                domain: getString(values, 'domain'),
+                scriptMap,
+                check: getBoolean(values, 'check'),
+            });
+            const stale = result.outputs.filter((outputFile) => !outputFile.current);
+            for (const outputFile of result.outputs) {
+                logger.info(outputFile.outputPath);
+            }
+            for (const outputFile of stale) {
+                logger.error('Translation output is missing or stale.', {
+                    file: outputFile.outputPath,
+                    title: 'stale-translation',
+                });
+            }
+            logger.summary(() => `### wp-release i18n-${format}\n\n${result.messages} translated messages for ${result.locale}; ${result.outputs.length} outputs.\n`);
+            return { exitCode: stale.length ? 2 : 0, result };
+        },
+    };
+}

package/dist/commands/i18n-json.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("./command.ts").Command;
+export default _default;

package/dist/commands/i18n-json.js

@@ -0,0 +1,2 @@
+import { createI18nCompileCommand } from "./i18n-compile.js";
+export default createI18nCompileCommand('json');

package/dist/commands/i18n-mo.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("./command.ts").Command;
+export default _default;

package/dist/commands/i18n-mo.js

@@ -0,0 +1,2 @@
+import { createI18nCompileCommand } from "./i18n-compile.js";
+export default createI18nCompileCommand('mo');

package/dist/commands/i18n-php.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("./command.ts").Command;
+export default _default;

package/dist/commands/i18n-php.js

@@ -0,0 +1,2 @@
+import { createI18nCompileCommand } from "./i18n-compile.js";
+export default createI18nCompileCommand('php');

package/dist/commands/i18n-pot.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("./command.ts").Command;
+export default _default;

package/dist/commands/i18n-pot.js

@@ -0,0 +1,2 @@
+import { createI18nCommand } from "./i18n.js";
+export default createI18nCommand('pot');

package/dist/commands/i18n.d.ts

@@ -0,0 +1,12 @@
+import type { PackagePotResult } from '../i18n/generate.ts';
+import type { Command } from './command.ts';
+export interface I18nCommandResult {
+    packages: Array<PackagePotResult & {
+        package?: string;
+    }>;
+}
+/**
+ * Small command adapters share selection/reporting; domain logic stays in the library.
+ * @param operation
+ */
+export declare function createI18nCommand(operation: 'pot' | 'audit'): Command;