@wpelevator/wp-release 0.15.0 → 0.16.0

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/package-source.d.ts

@@ -0,0 +1,43 @@
+import type { PackageType } from '../checksums.ts';
+import type { FileSelection } from '../file-selection.ts';
+import type { ParsedValues } from './command.ts';
+/** Release source, file selection and package metadata. */
+export interface PackageSource {
+    sourceDir: string;
+    selection: FileSelection;
+    slug: string;
+    version: string | null;
+    type?: PackageType;
+    package?: string;
+}
+/**
+ * Get the configured package to release, failing for the options that set the
+ * source directory and the files instead.
+ *
+ * @param  values      Parsed CLI values.
+ * @param  positionals Positional arguments.
+ * @return The package identifier or path, or undefined without --package.
+ * @throws {ValidationError} For an empty --package, or --package with a source directory or file selection option.
+ */
+export declare function getPackageArg(values: ParsedValues, positionals: string[]): string | undefined;
+/**
+ * Get the files of a source directory from the CLI options.
+ *
+ * @param values      Parsed CLI values.
+ * @param positionals Positional arguments.
+ * @param cwd         Working directory.
+ * @return Source directory, file selection, slug and version.
+ */
+export declare function getDirectorySource(values: ParsedValues, positionals: string[], cwd: string): Promise<PackageSource>;
+/**
+ * Get the directory of a configured package with the files config of its
+ * package group, which its deploys use too.
+ *
+ * @param  values     Parsed CLI values.
+ * @param  cwd        Repository root with the wp-release config.
+ * @param  name       Package identifier or path under the configured root.
+ * @param  configFile Config file, instead of the conventional one.
+ * @return Source directory, file selection, slug, version and package.
+ * @throws {ValidationError} Without a config or for an unknown package.
+ */
+export declare function getPackageSource(values: ParsedValues, cwd: string, name: string, configFile?: string): Promise<PackageSource>;

package/dist/commands/package-source.js

@@ -0,0 +1,101 @@
+import { basename, resolve } from 'node:path';
+import { ValidationError } from "../errors.js";
+import { resolveFileSelection } from "../file-selection.js";
+import { getPackageFiles } from "../package-deploy.js";
+import { readPackageMeta } from "../package-meta.js";
+import { checkDirectory, getFileSelectionInput, getSourceDirArg, } from "./args.js";
+import { getBoolean, getString, getStrings } from "./command.js";
+/** Options of a source directory and its files, which --package takes from the config. */
+const SOURCE_FLAGS = [
+    'source-dir',
+    'distignore',
+    'no-distignore',
+    'exclude',
+    'exclude-gitattributes',
+];
+/**
+ * Get the configured package to release, failing for the options that set the
+ * source directory and the files instead.
+ *
+ * @param  values      Parsed CLI values.
+ * @param  positionals Positional arguments.
+ * @return The package identifier or path, or undefined without --package.
+ * @throws {ValidationError} For an empty --package, or --package with a source directory or file selection option.
+ */
+export function getPackageArg(values, positionals) {
+    const name = getString(values, 'package')?.trim();
+    const conflicts = SOURCE_FLAGS.filter((flag) => undefined !== getString(values, flag) ||
+        getBoolean(values, flag) ||
+        getStrings(values, flag).length);
+    if ('' === name) {
+        throw new ValidationError('--package <name> must not be empty.');
+    }
+    if (name && (positionals.length || conflicts.length)) {
+        throw new ValidationError(`--package takes the directory and files of the package from the config, so it can't be combined with ${positionals.length
+            ? 'a source directory'
+            : conflicts.map((flag) => `--${flag}`).join(', ')}.`);
+    }
+    return name;
+}
+/**
+ * Describe the files of a directory with the slug and the version from the
+ * options, or from the plugin or theme headers.
+ *
+ * @param values    Parsed CLI values.
+ * @param sourceDir Directory to release.
+ * @param selection File selection.
+ * @param slug      Default slug.
+ * @return Source directory, file selection, slug, version and type.
+ */
+async function describeSource(values, sourceDir, selection, slug) {
+    const name = getString(values, 'slug') ?? slug;
+    const meta = await readPackageMeta({ dir: sourceDir, slug: name });
+    return {
+        sourceDir,
+        selection,
+        slug: name,
+        version: getString(values, 'version') ?? meta?.version ?? null,
+        ...(meta ? { type: meta.type } : {}),
+    };
+}
+/**
+ * Get the files of a source directory from the CLI options.
+ *
+ * @param values      Parsed CLI values.
+ * @param positionals Positional arguments.
+ * @param cwd         Working directory.
+ * @return Source directory, file selection, slug and version.
+ */
+export async function getDirectorySource(values, positionals, cwd) {
+    const sourceDir = resolve(cwd, getSourceDirArg(values, positionals));
+    await checkDirectory(sourceDir);
+    return describeSource(values, sourceDir, resolveFileSelection({
+        cwd,
+        sourceDir,
+        ...getFileSelectionInput(values),
+    }), basename(cwd));
+}
+/**
+ * Get the directory of a configured package with the files config of its
+ * package group, which its deploys use too.
+ *
+ * @param  values     Parsed CLI values.
+ * @param  cwd        Repository root with the wp-release config.
+ * @param  name       Package identifier or path under the configured root.
+ * @param  configFile Config file, instead of the conventional one.
+ * @return Source directory, file selection, slug, version and package.
+ * @throws {ValidationError} Without a config or for an unknown package.
+ */
+export async function getPackageSource(values, cwd, name, configFile) {
+    const pkg = await getPackageFiles({
+        cwd,
+        package: name,
+        ...(configFile ? { configFile } : {}),
+    });
+    const source = await describeSource(values, pkg.directory, resolveFileSelection({
+        cwd,
+        sourceDir: pkg.directory,
+        ...pkg.files,
+    }), basename(pkg.directory));
+    return { ...source, package: pkg.name };
+}

package/dist/commands/verify.d.ts

@@ -12,6 +12,12 @@ declare const _default: {
         checksums: {
             type: "string";
         };
+        'checksums-format': {
+            type: "string";
+        };
+        'checksums-file': {
+            type: "string";
+        };
         zip: {
             type: "string";
         };
@@ -28,6 +34,6 @@ declare const _default: {
             type: "string";
         };
     };
-    run({ values, positionals, cwd, logger }: import("./command.ts").CommandContext): Promise<CommandOutcome<unknown>>;
+    run({ values, positionals, cwd, configFile, logger }: import("./command.ts").CommandContext): Promise<CommandOutcome<unknown>>;
 };
 export default _default;