@magland/mochi 0.3.1

package/dist/cli/release-cmd.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.releaseCommands = void 0;
+const cli_api_1 = require("../cli-api");
+const exit_1 = require("./exit");
+const input_1 = require("./input");
+const output_1 = require("./output");
+const repo_1 = require("./repo");
+const target_1 = require("./target");
+// Releases: notes attached to a tag that already exists.
+//
+// There is no `release upload`, because a release's downloads are the archive
+// routes and there is nothing to upload. Anyone who knows `gh release upload`
+// will look for one, so docs/agents.md says plainly that it is not here.
+const COMMON = [repo_1.REPO_OPTION, ...target_1.TARGET_OPTIONS];
+const NOTES_OPTIONS = [
+    { name: 'title', type: 'string', value: '<t>', summary: 'Release title; the tag names itself otherwise' },
+    { name: 'notes', type: 'string', value: '<n>', summary: 'Release notes' },
+    { name: 'notes-file', type: 'string', value: '<f>', summary: "Read the notes from a file, or '-' for stdin" },
+    { name: 'prerelease', type: 'boolean', summary: 'Mark it a prerelease' },
+];
+async function notesOf(inv) {
+    const inline = inv.str('notes');
+    const file = inv.str('notes-file');
+    if (inline !== null && file !== null)
+        throw new exit_1.CliError('Pass either --notes or --notes-file, not both.', exit_1.EXIT_USAGE);
+    if (file !== null)
+        return await (0, input_1.readFileArg)(file);
+    return inline ?? undefined;
+}
+/** A tag may contain slashes, so it is encoded as one path segment. */
+function tagPath(tag) {
+    return encodeURIComponent(tag);
+}
+async function put(inv, tag, prereleaseGiven) {
+    const target = await (0, target_1.targetFrom)(inv);
+    const repo = await (0, repo_1.resolveRepo)(inv, target);
+    const data = await (0, cli_api_1.api)(target, 'PUT', `${(0, repo_1.repoPath)(repo)}/releases/${tagPath(tag)}`, {
+        name: inv.str('title') ?? undefined,
+        body: await notesOf(inv),
+        // Absent means "leave it as it is", which is what makes create and edit the
+        // same call; only a flag that was actually given changes anything.
+        prerelease: prereleaseGiven ? true : undefined,
+    });
+    const json = (0, output_1.jsonMode)(inv);
+    if (json.enabled) {
+        (0, output_1.printJson)((0, output_1.pickObject)(data, json.fields));
+        return;
+    }
+    console.log(`${target.host}/${repo.collection}/${repo.repo}/releases/${tag}`);
+}
+exports.releaseCommands = [
+    {
+        path: ['release', 'list'],
+        summary: 'List releases, newest first',
+        options: [output_1.JSON_OPTION, ...COMMON],
+        async run(inv) {
+            const target = await (0, target_1.targetFrom)(inv);
+            const repo = await (0, repo_1.resolveRepo)(inv, target);
+            const data = await (0, cli_api_1.api)(target, 'GET', `${(0, repo_1.repoPath)(repo)}/releases`);
+            const releases = (data.releases ?? []);
+            const json = (0, output_1.jsonMode)(inv);
+            if (json.enabled) {
+                (0, output_1.printJson)({ releases: (0, output_1.pickFields)(releases, json.fields) });
+                return;
+            }
+            if (releases.length === 0) {
+                console.log('No releases');
+                return;
+            }
+            (0, output_1.printTable)(releases.map((r) => [
+                String(r.tag),
+                r.prerelease ? 'prerelease' : '',
+                String(r.name || r.tag),
+                String(r.author),
+                (0, output_1.shortDate)(r.created),
+            ]));
+        },
+    },
+    {
+        path: ['release', 'view'],
+        summary: 'Show one release',
+        args: [{ name: 'tag', required: true }],
+        options: [output_1.JSON_OPTION, ...COMMON],
+        async run(inv) {
+            const target = await (0, target_1.targetFrom)(inv);
+            const repo = await (0, repo_1.resolveRepo)(inv, target);
+            const data = await (0, cli_api_1.api)(target, 'GET', `${(0, repo_1.repoPath)(repo)}/releases/${tagPath(inv.args[0])}`);
+            const json = (0, output_1.jsonMode)(inv);
+            if (json.enabled) {
+                (0, output_1.printJson)((0, output_1.pickObject)(data, json.fields));
+                return;
+            }
+            console.log(`${data.tag}${data.prerelease ? ' (prerelease)' : ''}`);
+            if (data.name)
+                console.log(String(data.name));
+            console.log(`published by ${data.author} on ${(0, output_1.shortDate)(data.created)}`);
+            console.log('');
+            console.log(String(data.body ?? '').trimEnd());
+        },
+    },
+    {
+        path: ['release', 'create'],
+        summary: 'Publish notes for a tag that already exists',
+        description: `The tag has to be in the repository first: notes for a tag nobody can check out
+are notes about nothing. 'mochi tag create' makes one.
+
+Creating and editing are the same call underneath, since a release is keyed by its
+tag, so 'release create' on an existing release edits it rather than refusing.`,
+        args: [{ name: 'tag', required: true }],
+        options: [...NOTES_OPTIONS, output_1.JSON_OPTION, ...COMMON],
+        run: (inv) => put(inv, inv.args[0], inv.bool('prerelease')),
+    },
+    {
+        path: ['release', 'edit'],
+        summary: 'Change a release title, notes, or prerelease flag',
+        args: [{ name: 'tag', required: true }],
+        options: [
+            ...NOTES_OPTIONS,
+            { name: 'latest', type: 'boolean', summary: 'Clear the prerelease flag' },
+            output_1.JSON_OPTION,
+            ...COMMON,
+        ],
+        async run(inv) {
+            if (inv.bool('prerelease') && inv.bool('latest')) {
+                throw new exit_1.CliError('Pass either --prerelease or --latest, not both.', exit_1.EXIT_USAGE);
+            }
+            if (inv.bool('latest')) {
+                const target = await (0, target_1.targetFrom)(inv);
+                const repo = await (0, repo_1.resolveRepo)(inv, target);
+                const data = await (0, cli_api_1.api)(target, 'PUT', `${(0, repo_1.repoPath)(repo)}/releases/${tagPath(inv.args[0])}`, {
+                    name: inv.str('title') ?? undefined,
+                    body: await notesOf(inv),
+                    prerelease: false,
+                });
+                const json = (0, output_1.jsonMode)(inv);
+                if (json.enabled)
+                    (0, output_1.printJson)((0, output_1.pickObject)(data, json.fields));
+                else
+                    console.log(`${inv.args[0]} is no longer a prerelease`);
+                return;
+            }
+            await put(inv, inv.args[0], inv.bool('prerelease'));
+        },
+    },
+    {
+        path: ['release', 'delete'],
+        summary: "Delete a release's notes, keeping the tag",
+        args: [{ name: 'tag', required: true }],
+        options: [
+            { name: 'yes', type: 'boolean', summary: 'Required: confirm that this cannot be undone' },
+            output_1.JSON_OPTION,
+            ...COMMON,
+        ],
+        async run(inv) {
+            if (!inv.bool('yes'))
+                throw new exit_1.CliError('Deleting a release cannot be undone. Pass --yes.', exit_1.EXIT_USAGE);
+            const target = await (0, target_1.targetFrom)(inv);
+            const repo = await (0, repo_1.resolveRepo)(inv, target);
+            const data = await (0, cli_api_1.api)(target, 'DELETE', `${(0, repo_1.repoPath)(repo)}/releases/${tagPath(inv.args[0])}`);
+            const json = (0, output_1.jsonMode)(inv);
+            if (json.enabled) {
+                (0, output_1.printJson)((0, output_1.pickObject)(data, json.fields));
+                return;
+            }
+            // Worth saying, because the two are separate operations and a caller
+            // expecting the tag to go with the notes would be surprised.
+            console.log(`Deleted the release notes for ${data.deleted}; the tag itself is still there.`);
+        },
+    },
+];