@krapht/ork 1.0.0-alpha.2 → 1.0.0-alpha.20

package/dist/follow-ups-CtlhHbwe.mjs

@@ -0,0 +1,563 @@
+import { $n as isGithubIssueUrl, Cn as followUpProblem, Gr as placeFor, Kt as followUpListTable, Qn as followUpActions, Sn as deliverFollowUp, Yn as changeFollowUp, Zn as findFollowUp, _n as postFollowUpMessage, bn as recordPublished, mr as runGh, yn as markDue } from "./src-8cOPOgrT.mjs";
+import { d as followUpsRule, f as refreshDue, n as flagValues } from "./run-DBUAq-Uu.mjs";
+import { t as applyFilters } from "./apply-Mb0fNpCX.mjs";
+import { n as unknownProjectRefusal } from "./refusals-DQQX3AIb.mjs";
+import { t as findRun } from "./find-BTikxc54.mjs";
+import { a as plain, c as write, l as writeErr, s as style } from "./output-B1kwo0YU.mjs";
+import { t as refuseExtraArguments } from "./extra-arguments-BxQMXARO.mjs";
+import { c as refuseUnknownFlags, i as readListArgs, n as filterArgs } from "./flags-C8yCq0j5.mjs";
+import { t as printList } from "./print-DNYzq4Rr.mjs";
+import { t as withStore } from "./store-CDpk8Wtz.mjs";
+import { homedir } from "node:os";
+import { defineCommand } from "citty";
+// src/follow-ups/command.ts
+/**
+* @file What the `ork follow-ups` subcommands share: the flags, the project a
+*   call is about, and the due check every call runs first, in the user's
+*   store. A `gh` that fails only warns.
+*/
+const json = {
+	type: "boolean",
+	description: "Print JSON",
+	default: false
+};
+const project = {
+	type: "string",
+	description: "A registered project's id (default: the one you are in)"
+};
+const idArg = {
+	type: "positional",
+	description: "A follow-up's id, or a prefix of one",
+	required: true
+};
+/** Says why, and makes the command exit 1. */
+const fail = (message) => {
+	writeErr(message);
+	process.exitCode = 1;
+};
+/** The project a command is about, from `--project` or the folder. */
+const placeOf = (store, key) => {
+	const projects = store.projects();
+	if (key === void 0) return placeFor(process.cwd(), projects);
+	const found = projects.find((p) => p.id === key || p.root === key);
+	if (found === void 0) {
+		fail(unknownProjectRefusal(key, projects.map((p) => p.id)));
+		return;
+	}
+	return placeFor(found.root, projects);
+};
+/** Runs `body` in the project, after the due check, in the user's store. */
+const inProject = (key, body) => withStore(async (store) => {
+	const place = placeOf(store, key);
+	if (place === void 0) return;
+	await refreshDue(store, place.root, (line) => {
+		writeErr(style("dim", line));
+	});
+	await body(store, place);
+});
+/**
+* Like `inProject`, for a list: `key` may be `all`, which gives every
+* registered project's place. The due check runs for each.
+*/
+const inProjects = (key, body) => withStore(async (store) => {
+	const projects = store.projects();
+	const places = key === "all" ? projects.map((p) => placeFor(p.root, projects)) : [placeOf(store, key)];
+	if (places.includes(void 0)) return;
+	const found = places.filter((place) => place !== void 0);
+	await Promise.all(found.map((place) => refreshDue(store, place.root, (line) => {
+		writeErr(style("dim", line));
+	})));
+	await body(store, found);
+});
+/** Runs `body` on the follow-up `id` names, or says why there is none. */
+const withFollowUp = (args, body) => inProject(args.project, async (store, place) => {
+	const found = findFollowUp(store, place.root, args.id);
+	if (!found.ok) {
+		fail(found.error);
+		return;
+	}
+	await body(store, place, found.followUp);
+});
+/**
+* The follow-ups several words name (`done a b`, `drop a,b`: a comma splits a
+* word too), each once, or `undefined` after saying every word that failed and
+* making the command exit 1; the caller then changes nothing.
+*/
+const eachTarget = (words, resolve) => {
+	const named = [...new Set(words.flatMap((word) => word.split(",")).map((word) => word.trim()).filter((word) => word !== ""))];
+	if (named.length === 0) {
+		fail("Give a follow-up id.");
+		return;
+	}
+	const found = /* @__PURE__ */ new Map();
+	let failed = false;
+	for (const word of named) {
+		const one = resolve(word);
+		if (one.ok) for (const f of one.followUps) found.set(f.id, f);
+		else {
+			fail(one.error);
+			failed = true;
+		}
+	}
+	return failed ? void 0 : [...found.values()];
+};
+/**
+* Like `withFollowUp`, for every id in `args._` (space or comma separated):
+* `refused` says why one may not be changed, and any refusal stops the call.
+*/
+const withFollowUps = (args, refused, body) => inProject(args.project, async (store, place) => {
+	const followUps = eachTarget(args._, (word) => {
+		const found = findFollowUp(store, place.root, word);
+		if (!found.ok) return found;
+		const why = refused(found.followUp);
+		return why === void 0 ? {
+			ok: true,
+			followUps: [found.followUp]
+		} : {
+			ok: false,
+			error: why
+		};
+	});
+	if (followUps !== void 0) await body(store, place, followUps);
+});
+// src/follow-ups/format.ts
+/** The groups of the list, in the order they are shown. */
+const GROUPS = [
+	{
+		status: "due",
+		title: "Due"
+	},
+	{
+		status: "waiting",
+		title: "Waiting"
+	},
+	{
+		status: "done",
+		title: "Done"
+	},
+	{
+		status: "dropped",
+		title: "Dropped"
+	}
+];
+/** `agent` first, then the maintainer, other projects, then people. */
+const FOR_ORDER = [
+	"agent",
+	"me",
+	"project:",
+	"person:"
+];
+const forOrder = (value) => FOR_ORDER.findIndex((prefix) => value.startsWith(prefix));
+/** The list's order within a status: by who it is for. */
+const byFor = (a, b) => forOrder(a.for) - forOrder(b.for) || a.for.localeCompare(b.for);
+/** A multi-line text, each line safe to print. */
+const linesOf = (text) => text.split("\n").map((line) => plain(line));
+const when = (f) => f.ref === void 0 ? f.due : `${f.due} ${f.ref}`;
+/** One follow-up on one line; a short note when a run has taken it. */
+const followUpLine = (f) => `${style("dim", f.id)}  ${f.kind.padEnd(7)} ${plain(f.title)} ${style("dim", `(${plain(when(f))})`)}${f.takenBy === void 0 ? "" : style("dim", ` taken by ${plain(f.takenBy)}`)}`;
+/** What to do with a draft: copy and send it, unless it is closed already. */
+const draftHeading = (f, to) => f.status === "done" || f.status === "dropped" ? `Draft to ${to} (${f.status})` : `Draft to ${to}: copy it, send it, then \`ork follow-ups done ${f.id}\``;
+/**
+* The follow-ups grouped by status, then by `for`; the closed ones only with
+* `all`. A line each, under a heading each.
+*/
+const formatFollowUps = (followUps, all) => {
+	const lines = [];
+	for (const group of GROUPS) {
+		if (!all && group.status !== "due" && group.status !== "waiting") continue;
+		const inGroup = followUps.filter((f) => f.status === group.status).toSorted(byFor);
+		if (inGroup.length === 0) continue;
+		if (lines.length > 0) lines.push("");
+		lines.push(style("bold", `${group.title} (${String(inGroup.length)})`));
+		for (const kind of new Set(inGroup.map((f) => f.for))) {
+			lines.push(`  ${style("cyan", `for ${plain(kind)}`)}`);
+			for (const f of inGroup.filter((one) => one.for === kind)) lines.push(`    ${followUpLine(f)}`);
+		}
+	}
+	return lines.length === 0 ? [style("dim", "No follow-ups.")] : lines;
+};
+const fromLine = (f) => f.from.run === void 0 ? [] : [`from run ${plain(f.from.run)}${f.from.node === void 0 ? "" : `, node ${plain(f.from.node)}`}`];
+/** One follow-up whole: its record, its draft and its steps, ready to copy. */
+const formatFollowUp = (f) => [
+	`${style("bold", plain(f.title))}  ${style("dim", f.id)}`,
+	`status ${f.status}${f.note === void 0 ? "" : ` (${plain(f.note)})`}, for ${plain(f.for)}, ${f.kind}, due ${plain(f.due)}`,
+	...f.ref === void 0 ? [] : [`waits on ${plain(f.ref)}`],
+	...f.takenBy === void 0 ? [] : [`taken by run ${plain(f.takenBy)}`],
+	...fromLine(f),
+	...f.where.length === 0 ? [] : [`files ${f.where.map((file) => plain(file)).join(", ")}`],
+	...f.url === void 0 ? [] : [`kept at ${plain(f.url)}`],
+	...f.body === "" ? [] : ["", ...linesOf(f.body)],
+	...f.draft === void 0 ? [] : [
+		"",
+		style("bold", draftHeading(f, `${plain(f.draft.to)}${f.draft.channel === void 0 ? "" : ` (${plain(f.draft.channel)})`}`)),
+		...linesOf(f.draft.text).map((line) => `  ${line}`)
+	],
+	...f.steps === void 0 ? [] : [
+		"",
+		style("bold", "Steps (Ork never runs them):"),
+		...f.steps.flatMap((step, index) => [`  ${String(index + 1)}. ${plain(step.text)}`, ...step.command === void 0 ? [] : [`     ${plain(step.command)}`]])
+	]
+];
+// src/commands/follow-ups-act.ts
+/**
+* @file What `ork follow-ups` does to one follow-up: done (a message: sent),
+*   drop, reopen, make due, post a drafted GitHub comment, and `published`,
+*   which a workflow's step calls once its change is out. Posting goes through
+*   the person's own `gh` and only with `--confirm`, after showing the exact
+*   text; Ork never runs a task's commands.
+*/
+/**
+* `done`, `drop` or `reopen`: one change of status for each id given (space or
+* comma separated), or why one can't be; any refusal changes none.
+*/
+const closing = (action, description, verb) => defineCommand({
+	meta: {
+		name: action,
+		description
+	},
+	args: {
+		id: {
+			...idArg,
+			description: "A follow-up's id, or a prefix of one; several allowed, space or comma separated"
+		},
+		project
+	},
+	run: ({ args }) => withFollowUps(args, (followUp) => {
+		const allowed = followUpActions(followUp)[action];
+		return allowed.ok ? void 0 : allowed.error;
+	}, (store, _place, followUps) => {
+		for (const followUp of followUps) {
+			const changed = changeFollowUp(store, followUp, action);
+			if (!changed.ok) {
+				fail(changed.error);
+				continue;
+			}
+			write(`${style("green", "✓")} ${verb} ${changed.followUp.id}: ${plain(changed.followUp.title)}`);
+		}
+	})
+});
+const due = defineCommand({
+	meta: {
+		name: "due",
+		description: "Make a waiting follow-up due now, or all of a run's (after a deploy, say)"
+	},
+	args: {
+		target: {
+			type: "positional",
+			description: "A follow-up's id (or a prefix), or a run id; several allowed, space or comma separated",
+			required: true
+		},
+		project
+	},
+	run: ({ args }) => inProject(args.project, (store, place) => {
+		const waiting = eachTarget(args._, (target) => {
+			const one = findFollowUp(store, place.root, target);
+			const run = findRun(store, target, "");
+			const runId = run.ok ? run.run.id : target;
+			const ready = (one.ok ? [one.followUp] : store.followUps(place.root).filter((f) => f.from.run === runId)).filter((f) => f.status === "waiting");
+			return ready.length === 0 ? {
+				ok: false,
+				error: `Nothing waiting under \`${target}\`: give a waiting follow-up's id, or a run that left some.`
+			} : {
+				ok: true,
+				followUps: ready
+			};
+		});
+		for (const f of waiting ?? []) for (const marked of markDue(store, place.root, f.id)) write(`${style("green", "✓")} due ${marked.id}: ${plain(marked.title)}`);
+	})
+});
+const post = defineCommand({
+	meta: {
+		name: "post",
+		description: "Post a message drafted for GitHub, as a comment through your own gh, with --confirm; without it, show what would be posted"
+	},
+	plugins: [refuseExtraArguments],
+	args: {
+		id: idArg,
+		confirm: {
+			type: "boolean",
+			description: "Yes: post exactly this text",
+			default: false
+		},
+		project
+	},
+	run: ({ args }) => withFollowUp(args, async (store, _place, followUp) => {
+		const allowed = followUpActions(followUp).post;
+		if (!allowed.ok) {
+			fail(allowed.error);
+			return;
+		}
+		const draft = followUp.draft;
+		if (!args.confirm && draft !== void 0) {
+			write(`Would post to ${plain(draft.to)} through your gh:`);
+			for (const line of draft.text.split("\n")) write(`  ${plain(line)}`);
+			writeErr("Run again with --confirm to post it.");
+			return;
+		}
+		const posted = await postFollowUpMessage(followUp, {
+			rows: store,
+			gh: runGh,
+			confirmed: args.confirm,
+			home: homedir()
+		});
+		if (!posted.ok) {
+			fail(posted.error);
+			return;
+		}
+		write(`${style("green", "✓")} posted${posted.url === void 0 ? "" : ` ${posted.url}`}; done ${followUp.id}`);
+	})
+});
+const published = defineCommand({
+	meta: {
+		name: "published",
+		description: "Record that this run published a pull request or branch (a workflow step calls it): its follow-ups wait on it, and the ones it took are done"
+	},
+	plugins: [refuseExtraArguments],
+	args: { ref: {
+		type: "positional",
+		description: "The pull request URL or the branch",
+		required: true
+	} },
+	run: ({ args }) => withStore((store) => {
+		const runId = process.env["ORK_RUN"];
+		if (runId === void 0 || runId === "") {
+			fail("ork follow-ups published runs inside a run: ORK_RUN is not set.");
+			return;
+		}
+		const found = findRun(store, runId, "");
+		if (!found.ok) {
+			fail(found.error);
+			return;
+		}
+		const callers = [];
+		for (let parent = found.run.parent; parent !== void 0 && !callers.includes(parent); parent = store.lookup(parent).find((r) => r.id === parent)?.parent) callers.push(parent);
+		const recorded = recordPublished(store, {
+			project: found.run.project,
+			run: found.run.id,
+			ref: args.ref,
+			callers
+		});
+		write(`${style("green", "✓")} ${String(recorded.referenced.length)} follow-up(s) now wait on ${plain(args.ref)}; ${String(recorded.done.length)} done`);
+	})
+});
+// src/commands/follow-ups-add.ts
+/**
+* @file `ork follow-ups add`: a follow-up the maintainer adds by hand, with its
+*   `for`, `kind` and `due`, a message's draft or a task's steps. It is kept
+*   where the project's rule says, and one for another project goes into that
+*   project's list and, when a run is live there, to its session.
+*/
+/** `text :: command` as a step; the command is optional. */
+const stepOf = (raw) => {
+	const [text = "", command] = raw.split(" :: ", 2);
+	return command === void 0 ? { text: text.trim() } : {
+		text: text.trim(),
+		command: command.trim()
+	};
+};
+const defaultKind = (value) => {
+	if (value.startsWith("person:")) return "message";
+	return value === "agent" || value.startsWith("project:") ? "change" : "task";
+};
+const isKind = (value) => [
+	"change",
+	"message",
+	"task",
+	"check"
+].includes(value);
+const isFor = (value) => /^(?:agent|me|project:.+|person:.+)$/u.test(value);
+const isDue = (value) => /^(?:now|after-merge|after-deploy|\d+-\d+-\d+)$/u.test(value);
+const add = defineCommand({
+	meta: {
+		name: "add",
+		description: "Add a follow-up: --for agent|me|project:<name>|person:<name>, --kind, --due"
+	},
+	args: {
+		title: {
+			type: "positional",
+			description: "What it is",
+			required: true
+		},
+		for: {
+			type: "string",
+			description: "agent, me, project:<name> or person:<name> (default: me)"
+		},
+		kind: {
+			type: "string",
+			description: "change, message, task or check (default: by --for)"
+		},
+		due: {
+			type: "string",
+			description: "now, after-merge, after-deploy or a YYYY-MM-DD date (default: now)"
+		},
+		body: {
+			type: "string",
+			description: "What and why"
+		},
+		where: {
+			type: "string",
+			description: "A file it is about (repeatable)"
+		},
+		ref: {
+			type: "string",
+			description: "The PR or branch it waits on"
+		},
+		to: {
+			type: "string",
+			description: "A message: who it is to (default: the person); for --channel github, the issue or PR URL"
+		},
+		channel: {
+			type: "string",
+			description: "A message: slack, email, github…"
+		},
+		text: {
+			type: "string",
+			description: "A message: its text, to send"
+		},
+		step: {
+			type: "string",
+			description: "A task's step, `text` or `text :: command` (repeatable); Ork never runs it"
+		},
+		project,
+		json
+	},
+	run: ({ args, rawArgs }) => inProject(args.project, async (store, place) => {
+		const recipient = args.for ?? "me";
+		const kind = args.kind ?? defaultKind(recipient);
+		if (!isKind(kind)) {
+			fail("--kind is change, message, task or check.");
+			return;
+		}
+		const due = args.due ?? "now";
+		if (!isFor(recipient) || !isDue(due)) {
+			fail(isFor(recipient) ? "--due is now, after-merge, after-deploy or a YYYY-MM-DD date." : "--for is agent, me, project:<name> or person:<name>.");
+			return;
+		}
+		if (kind === "message" && args.text === void 0) {
+			fail("a message needs --text.");
+			return;
+		}
+		if (args.channel === "github" && !isGithubIssueUrl(args.to ?? "")) {
+			fail("--channel github needs --to <the issue or pull request URL>, https://github.com/<owner>/<repo>/(issues|pull)/<n>.");
+			return;
+		}
+		const steps = flagValues(rawArgs, "--step").map((raw) => stepOf(raw));
+		const input = {
+			title: args.title,
+			for: recipient,
+			kind,
+			due,
+			where: flagValues(rawArgs, "--where"),
+			...args.body === void 0 ? {} : { body: args.body },
+			...args.ref === void 0 ? {} : { ref: args.ref },
+			...args.text === void 0 ? {} : { draft: {
+				to: args.to ?? recipient.replace(/^person:/u, ""),
+				...args.channel === void 0 ? {} : { channel: args.channel },
+				text: args.text
+			} },
+			...steps.length === 0 ? {} : { steps }
+		};
+		const problem = followUpProblem(input);
+		if (problem !== null) {
+			fail(`${problem}.`);
+			return;
+		}
+		const rule = followUpsRule(place);
+		const delivered = await deliverFollowUp(input, {
+			store,
+			project: place.root,
+			...rule === void 0 ? {} : { rule }
+		});
+		if (!delivered.ok) {
+			fail(delivered.error);
+			return;
+		}
+		if (args.json) {
+			write(JSON.stringify(delivered, void 0, 2));
+			return;
+		}
+		const { added, relayed } = delivered;
+		const { followUp } = added;
+		write(`${style("green", "✓")} ${added.merged ? "merged into" : "added"} ${followUp.id}: ${plain(followUp.title)}`);
+		if (added.note !== void 0) writeErr(style("dim", added.note));
+		if (added.merged && input.draft !== void 0 && followUp.draft !== void 0 && input.draft.text !== followUp.draft.text) write(style("dim", `  the new --text was not kept: ${followUp.id} keeps its first draft (see \`ork follow-ups show ${followUp.id}\`)`));
+		if (relayed !== void 0) write(style("dim", `  sent to ${relayed.node} of run ${relayed.run}, which is live in that project`));
+	})
+});
+// src/commands/follow-ups.ts
+/**
+* @file `ork follow-ups`: what shipped changes left for later, apart from
+*   feedback (specs/follow-ups.md): list and show them, add one, and mark one
+*   done, dropped, reopened or due, or post its drafted GitHub comment (in
+*   `follow-ups-act.ts`). Every call first moves what has come due, reading
+*   pull requests through the person's own `gh`; a `gh` that fails only warns.
+*/
+/** What a list with no `--status` shows. */
+const OPEN = /* @__PURE__ */ new Set(["due", "waiting"]);
+/** The list's own order: due first, then waiting, done, dropped; then `byFor`. */
+const RANK = {
+	due: 0,
+	waiting: 1,
+	done: 2,
+	dropped: 3
+};
+const followUps = defineCommand({
+	meta: {
+		name: "follow-ups",
+		description: "What shipped changes left for later: list, show, add, done, drop, reopen, due, post, published"
+	},
+	subCommands: {
+		list: defineCommand({
+			meta: {
+				name: "list",
+				description: "List the follow-ups, due first, then by who they are for"
+			},
+			plugins: [refuseUnknownFlags, refuseExtraArguments],
+			args: filterArgs(followUpListTable),
+			run: async ({ args }) => {
+				const given = args;
+				const asked = readListArgs(followUpListTable, given);
+				if (asked === void 0) return;
+				const { filter, limit } = asked;
+				const status = filter["status"];
+				await inProjects(filter["project"], (store, places) => {
+					const target = filter["for"]?.match(/^project:(.*)$/u)?.[1];
+					const ids = store.projects().map((p) => p.id);
+					if (target !== void 0 && !ids.includes(target)) {
+						fail(unknownProjectRefusal(target, ids));
+						return;
+					}
+					const stored = places.flatMap((place) => store.followUps(place.root));
+					const shown = applyFilters(followUpListTable, stored, filter).filter((f) => status !== void 0 || OPEN.has(f.status)).toSorted((a, b) => RANK[a.status] - RANK[b.status] || byFor(a, b)).slice(0, limit);
+					printList(shown, followUpListTable, given, (rows) => {
+						for (const line of formatFollowUps(rows, status !== void 0)) write(line);
+					});
+				});
+			}
+		}),
+		show: defineCommand({
+			meta: {
+				name: "show",
+				description: "Show a follow-up whole, with its draft and its steps to copy"
+			},
+			plugins: [refuseExtraArguments],
+			args: {
+				id: idArg,
+				project,
+				json
+			},
+			run: ({ args }) => withFollowUp(args, (_store, _place, followUp) => {
+				if (args.json) write(JSON.stringify(followUp, void 0, 2));
+				else for (const line of formatFollowUp(followUp)) write(line);
+			})
+		}),
+		add,
+		done: closing("done", "Mark a follow-up done; a message is done once you have sent it", "done"),
+		drop: closing("drop", "Drop a follow-up that no longer applies", "dropped"),
+		reopen: closing("reopen", "Bring a done or dropped follow-up back", "reopened"),
+		due,
+		post,
+		published
+	}
+});
+export { followUps };