@shortcut-cli/shortcut-cli 4.0.0 → 5.0.0

package/build/bin/short-objective.js

@@ -0,0 +1,151 @@
+#!/usr/bin/env node
+import client from "../lib/client.js";
+import spinner from "../lib/spinner.js";
+import { Command } from "commander";
+import os from "os";
+import { exec } from "child_process";
+import chalk from "chalk";
+//#region src/bin/short-objective.ts
+const spin = spinner();
+const log = console.log;
+const program = new Command().usage("[command] [options]").description("view, create, or update objectives");
+program.command("view <id>").description("view an objective by id").option("-O, --open", "Open objective in browser").action(viewObjective);
+program.command("create").description("create a new objective").option("-n, --name [text]", "Set name of objective, required", "").option("-d, --description [text]", "Set description of objective", "").option("-s, --state [name]", "Set state of objective (to do, in progress, done)", "").option("--started-at [date]", "Set started override (ISO date or YYYY-MM-DD)", "").option("--completed-at [date]", "Set completed override (ISO date or YYYY-MM-DD)", "").option("-I, --idonly", "Print only ID of objective result").option("-O, --open", "Open objective in browser").action(createObjective);
+program.command("update <id>").description("update an existing objective").option("-n, --name [text]", "Set name of objective", "").option("-d, --description [text]", "Set description of objective", "").option("-s, --state [name]", "Set state of objective (to do, in progress, done)", "").option("--started-at [date]", "Set started override (ISO date or YYYY-MM-DD)", "").option("--completed-at [date]", "Set completed override (ISO date or YYYY-MM-DD)", "").option("-a, --archived", "Archive objective").option("-O, --open", "Open objective in browser").action(updateObjective);
+program.command("epics <id>").description("list epics in an objective").action(listObjectiveEpics);
+const args = process.argv.slice(2);
+if (args.length > 0 && args[0] && /^\d+$/.test(args[0])) process.argv.splice(2, 0, "view");
+program.parse(process.argv);
+if (args.length === 0) {
+	program.outputHelp();
+	process.exit(1);
+}
+async function viewObjective(id, options) {
+	spin.start();
+	try {
+		const objective = await client.getObjective(parseInt(id, 10)).then((r) => r.data);
+		spin.stop(true);
+		printObjective(objective);
+		if (options.open) openURL(objective.app_url);
+	} catch (e) {
+		spin.stop(true);
+		const error = e;
+		if (error.response?.status === 404) log(`Objective #${id} not found`);
+		else log("Error fetching objective:", error.message ?? String(e));
+		process.exit(1);
+	}
+}
+async function createObjective(options) {
+	if (!options.name) {
+		log("Must provide --name");
+		process.exit(1);
+	}
+	if (!options.idonly) spin.start();
+	const objectiveData = { name: options.name };
+	if (options.description) objectiveData.description = options.description;
+	const state = normalizeObjectiveState(options.state);
+	if (state) objectiveData.state = state;
+	if (options.startedAt) objectiveData.started_at_override = normalizeDate(options.startedAt);
+	if (options.completedAt) objectiveData.completed_at_override = normalizeDate(options.completedAt);
+	let objective;
+	try {
+		objective = await client.createObjective(objectiveData).then((r) => r.data);
+	} catch (e) {
+		if (!options.idonly) spin.stop(true);
+		log("Error creating objective:", e.message ?? String(e));
+		process.exit(1);
+	}
+	if (!options.idonly) spin.stop(true);
+	if (options.idonly) {
+		log(objective.id);
+		return;
+	}
+	printObjective(objective);
+	if (options.open) openURL(objective.app_url);
+}
+async function updateObjective(id, options) {
+	const updateData = {};
+	if (options.name) updateData.name = options.name;
+	if (options.description) updateData.description = options.description;
+	const state = normalizeObjectiveState(options.state);
+	if (state) updateData.state = state;
+	if (options.startedAt) updateData.started_at_override = normalizeDate(options.startedAt);
+	if (options.completedAt) updateData.completed_at_override = normalizeDate(options.completedAt);
+	if (options.archived) updateData.archived = true;
+	if (Object.keys(updateData).length === 0) {
+		log("No updates provided. Use --name, --description, --state, --started-at, --completed-at, or --archived");
+		process.exit(1);
+	}
+	spin.start();
+	try {
+		const objective = await client.updateObjective(parseInt(id, 10), updateData).then((r) => r.data);
+		spin.stop(true);
+		printObjective(objective);
+		if (options.open) openURL(objective.app_url);
+	} catch (e) {
+		spin.stop(true);
+		const error = e;
+		if (error.response?.status === 404) log(`Objective #${id} not found`);
+		else log("Error updating objective:", error.message ?? String(e));
+		process.exit(1);
+	}
+}
+async function listObjectiveEpics(id) {
+	spin.start();
+	try {
+		const epics = await client.listObjectiveEpics(parseInt(id, 10)).then((r) => r.data);
+		spin.stop(true);
+		if (epics.length === 0) {
+			log(`No epics found in objective #${id}`);
+			return;
+		}
+		log(chalk.bold(`Epics in objective #${id}:`));
+		log();
+		epics.forEach(printEpic);
+	} catch (e) {
+		spin.stop(true);
+		const error = e;
+		if (error.response?.status === 404) log(`Objective #${id} not found`);
+		else log("Error fetching objective epics:", error.message ?? String(e));
+		process.exit(1);
+	}
+}
+function normalizeObjectiveState(state) {
+	if (!state) return void 0;
+	const stateMap = {
+		todo: "to do",
+		"to do": "to do",
+		inprogress: "in progress",
+		"in progress": "in progress",
+		done: "done"
+	};
+	return stateMap[state.toLowerCase().replace(/[^a-z]/g, "")] || stateMap[state.toLowerCase()];
+}
+function normalizeDate(value) {
+	if (/^\d{4}-\d{2}-\d{2}$/.test(value)) return (/* @__PURE__ */ new Date(`${value}T00:00:00.000Z`)).toISOString();
+	return new Date(value).toISOString();
+}
+function printObjective(objective) {
+	log(`#${objective.id} ${objective.name}`);
+	log(`State:\t\t${objective.state}`);
+	log(`Started:\t${objective.started ? "yes" : "no"}`);
+	log(`Completed:\t${objective.completed ? "yes" : "no"}`);
+	log(`Archived:\t${objective.archived ? "yes" : "no"}`);
+	if (objective.description) log(`Description:\t${objective.description}`);
+	if (objective.categories.length > 0) log(`Categories:\t${objective.categories.map((category) => category.name).join(", ")}`);
+	if (objective.started_at) log(`Started At:\t${objective.started_at}`);
+	if (objective.completed_at) log(`Completed At:\t${objective.completed_at}`);
+	log(`Updated:\t${objective.updated_at}`);
+	log(`URL:\t\t${objective.app_url}`);
+}
+function printEpic(epic) {
+	log(`${chalk.bold("#" + epic.id)} ${chalk.blue(epic.name)}`);
+	log(`  State: ${epic.state} | Started: ${epic.started ? "yes" : "no"} | Completed: ${epic.completed ? "yes" : "no"}`);
+	log(`  URL: ${epic.app_url}`);
+	log();
+}
+function openURL(url) {
+	exec(`${os.platform() === "darwin" ? "open" : "xdg-open"} '${url}'`);
+}
+//#endregion
+export {};

package/build/bin/short-objectives.js

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+import client from "../lib/client.js";
+import spinner from "../lib/spinner.js";
+import { Command } from "commander";
+import chalk from "chalk";
+//#region src/bin/short-objectives.ts
+const log = console.log;
+const spin = spinner();
+const program = new Command().description(`List and search Shortcut objectives. By default, lists all objectives.
+  Passing search operators will use the Shortcut objective search API and page through all results.`).allowExcessArguments(true).usage("[options] [SEARCH OPERATORS]").option("-a, --archived", "List only objectives including archived", "").option("-c, --completed", "List only objectives that have been completed", "").option("-d, --detailed", "List more details for each objective", "").option("-f, --format [template]", "Format each objective output by template", "").option("-s, --started", "List objectives that have been started", "").option("-S, --state [state]", "Filter objectives by state", "").option("-t, --title [query]", "Filter objectives with name/title containing query", "");
+program.parse(process.argv);
+const opts = program.opts();
+const main = async () => {
+	spin.start();
+	let objectives = [];
+	try {
+		objectives = program.args.length ? await searchObjectives(program.args) : await listObjectives();
+	} catch (e) {
+		spin.stop(true);
+		log("Error fetching objectives:", e.message ?? String(e));
+		process.exit(1);
+	}
+	spin.stop(true);
+	const textMatch = new RegExp(opts.title ?? "", "i");
+	const stateMatch = new RegExp(opts.state ?? "", "i");
+	objectives.filter((objective) => {
+		return `${objective.name} ${objective.description ?? ""}`.match(textMatch) && objective.state.match(stateMatch);
+	}).forEach(printItem);
+};
+async function listObjectives() {
+	return client.listObjectives().then((r) => r.data);
+}
+async function searchObjectives(args) {
+	const query = args.join(" ");
+	let result = await client.searchObjectives({
+		query,
+		detail: "full"
+	});
+	let objectives = result.data.data;
+	while (result.data.next) {
+		const nextCursor = new URLSearchParams(result.data.next).get("next");
+		result = await client.searchObjectives({
+			query,
+			detail: "full",
+			next: nextCursor ?? void 0
+		});
+		objectives = objectives.concat(result.data.data);
+	}
+	return objectives;
+}
+const printItem = (objective) => {
+	if (objective.archived && !opts.archived) return;
+	if (!objective.started && opts.started) return;
+	if (!objective.completed && opts.completed) return;
+	let defaultFormat = `#%id %t\nState:\t\t%s\nStarted:\t%st\nCompleted:\t%co\n`;
+	if (opts.detailed) defaultFormat += `Updated:\t%u\nCategories:\t%cat\nURL:\t\t%url\nDescription:\t%d\n`;
+	const format = opts.format || defaultFormat;
+	const categories = "categories" in objective ? objective.categories.map((category) => category.name).join(", ") || "_" : "_";
+	log(format.replace(/%id/g, chalk.bold(`${objective.id}`)).replace(/%t/g, chalk.blue(`${objective.name}`)).replace(/%st/g, `${objective.started ? "yes" : "no"}`).replace(/%co/g, `${objective.completed ? "yes" : "no"}`).replace(/%s/g, `${objective.state}`).replace(/%u/g, `${objective.updated_at}`).replace(/%cat/g, categories).replace(/%url/g, `${objective.app_url}`).replace(/%d/g, `${objective.description || "_"}`));
+};
+main();
+//#endregion
+export {};

package/build/bin/short-projects.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+import client from "../lib/client.js";
+import spinner from "../lib/spinner.js";
+import { Command } from "commander";
+import chalk from "chalk";
+//#region src/bin/short-projects.ts
+const spin = spinner();
+const log = console.log;
+const opts = new Command().description("Display projects available for stories").option("-a, --archived", "List only projects including archived", "").option("-d, --detailed", "List more details for each project", "").option("-t, --title [query]", "List projects with name/title containing query", "").parse(process.argv).opts();
+const main = async () => {
+	spin.start();
+	const projects = await client.listProjects().then((r) => r.data);
+	spin.stop(true);
+	const textMatch = new RegExp(opts.title ?? "", "i");
+	projects.filter((o) => {
+		return !!`${o.name} ${o.name}`.match(textMatch);
+	}).map(printItem);
+};
+const printItem = (proj) => {
+	if (proj.archived && !opts.archived) return;
+	log(chalk.bold(`#${proj.id}`) + chalk.blue(` ${proj.name}`));
+	log(chalk.bold("Points:        ") + ` ${proj.stats.num_points}`);
+	log(chalk.bold("Stories:       ") + ` ${proj.stats.num_stories}`);
+	log(chalk.bold("Started:       ") + ` ${proj.start_time}`);
+	if (proj.archived) log(chalk.bold("Archived:      ") + ` ${proj.archived}`);
+	if (opts.detailed) log(chalk.bold("Description:    ") + ` ${proj.description}`);
+	log();
+};
+main();
+//#endregion
+export {};

package/build/bin/short-search.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+import configure_default from "../lib/configure.js";
+import spinner from "../lib/spinner.js";
+import stories_default from "../lib/stories.js";
+import { Command } from "commander";
+//#region src/bin/short-search.ts
+const spin = spinner("Finding... %s ");
+const log = console.log;
+const program = new Command().description(`Search through Shortcut stories. Arguments (non-flag/options) will be
+  passed to Shortcut story search API as search operators. Passing '%self%' as
+  a search operator argument will be replaced by your mention name. Note that
+  passing search operators and options (e.g. --owner foobar) will use the
+  options as extra filtering in the client.
+
+  Refer to https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators
+  for more details about search operators.`).allowExcessArguments(true).usage("[options] [SEARCH OPERATORS]").option("-a, --archived", "Include archived Stories").option("-c, --created [operator][date]", "Stories created within criteria (operator is one of <|>|=)", "").option("-q, --quiet", "Print only story output, no loading dialog", "").option("-l, --label [id|name]", "Stories with label id/name, by regex", "").option("-o, --owner [name]", "Stories with owner, by regex", "").option("-p, --project [id]", "Stories in project", "").option("-s, --state [id|name]", "Stories in workflow state id/name, by regex", "").option("--epic [id|name]", "Stories in epic id/name, by regex", "").option("-i, --iteration [id|name]", "Stories in iteration id/name, by regex", "").option("-S, --save [name]", "Save search configuration as workspace").option("-t, --text [name]", "Stories with text in name, by regex", "").option("-e, --estimate [operator][number]", "Stories estimated within criteria (operator is one of <|>|=)", "").option("-u, --updated [operator][date]", "Stories updated within criteria (operator is one of <|>|=)", "").option("-y, --type [name]", "Stories of type, by regex", "").option("-r, --sort [field]", "Sort stories by field (accessor[:asc|desc][,next])", "state.position:asc,position:asc").option("-f, --format [template]", "Format each story output by template", "");
+const getWorkspaceOptions = (opts) => {
+	const blacklistedKeys = ["save"];
+	return Object.entries(opts).filter(([key]) => !blacklistedKeys.includes(key)).reduce((obj, [key, val]) => Object.assign(obj, { [key]: val }), {});
+};
+const main = async () => {
+	program.parse(process.argv);
+	const opts = program.opts();
+	if (!opts.quiet) {
+		if (!program.args.length) log("Fetching all stories for search since no search operators were passed ...");
+		spin.start();
+	}
+	let stories = [];
+	try {
+		stories = await stories_default.listStories({
+			...opts,
+			args: program.args
+		});
+	} catch (e) {
+		log("Error fetching stories:", e);
+	}
+	if (!opts.quiet) spin.stop(true);
+	stories.map(stories_default.printFormattedStory(opts));
+	if (!opts.save) return;
+	const name = opts.save === true ? "default" : opts.save;
+	if (configure_default.saveWorkspace(name, getWorkspaceOptions(opts))) log("Saved query as %s workspace", name);
+};
+if (process.argv[1]?.includes("short-search")) main();
+//#endregion
+export { main, program };