atlass 1.7.0 → 1.8.0

package/README.md

@@ -86,6 +86,19 @@ body sent is everything between the H1 and `## Comments`.
 - Confluence uploads local images referenced in the body as attachments. Jira
   update does not support image changes yet.
 
+## List
+
+```bash
+atlass jira list
+atlass jira list --project PROJ
+atlass jira list --all
+```
+
+Lists issues assigned to you as `KEY  Status  Age  Summary`, with In Progress
+first, then To Do, and the most recently updated at the top of each group. Done
+issues are left out; `--all` adds those updated in the last 30 days. `--json`
+and `--copy` work as for search.
+
 ## Search
 
 ```bash

package/dist/cli.mjs

@@ -7,6 +7,7 @@ import { basename, dirname, isAbsolute, join, resolve } from "node:path";
 import { Entry } from "@napi-rs/keyring";
 import { marked } from "marked";
 import { randomUUID } from "node:crypto";
+import { stripVTControlCharacters } from "node:util";
 import kleur from "kleur";
 import { common, createLowlight } from "lowlight";
 //#region src/api/client.ts
@@ -980,7 +981,7 @@ async function runSearch(rows, options, noun, copyOne) {
 		return;
 	}
 	if (rows.length === 0) {
-		console.log(`No matching ${noun.plural}.`);
+		console.log(options.empty);
 		return;
 	}
 	if (options.copy) {
@@ -989,7 +990,11 @@ async function runSearch(rows, options, noun, copyOne) {
 		return;
 	}
 	for (const row of rows) console.log(formatRow(row));
-	if (options.hasMore) console.log(`\nShowing first ${options.limit}; refine with flags or raise --limit.`);
+	if (options.footer) console.log(options.footer);
+}
+function searchFooter(limit) {
+	return `
+Showing first ${limit}; refine with flags or raise --limit.`;
 }
 async function copySelected(rows, noun, copyOne) {
 	if (!process.stdin.isTTY) throw new Error("--copy requires an interactive terminal.");
@@ -1022,7 +1027,7 @@ async function copySelected(rows, noun, copyOne) {
 	else console.log(`${summary}, failed ${failures.length}: ${failures.join(", ")}`);
 }
 function formatRow(row) {
-	const room = (process.stdout.columns ?? 80) - row.fixedColumns.length - 2;
+	const room = (process.stdout.columns ?? 80) - stripVTControlCharacters(row.fixedColumns).length - 2;
 	const text = room > 0 ? truncate(row.freeText, room) : "";
 	return text ? `${row.fixedColumns}  ${text}` : row.fixedColumns;
 }
@@ -1765,9 +1770,9 @@ async function confluenceSearch(query, options) {
 	})), {
 		json: options.json,
 		copy: options.copy,
-		limit,
-		hasMore,
-		out: options.out
+		out: options.out,
+		empty: "No matching pages.",
+		footer: hasMore ? searchFooter(limit) : void 0
 	}, {
 		singular: "page",
 		plural: "pages"
@@ -1832,19 +1837,28 @@ async function updateIssue(client, key, update) {
 	if (update.summary !== void 0) fields["summary"] = update.summary;
 	await client.putNoContent(`/rest/api/3/issue/${encodeURIComponent(key)}`, { fields });
 }
+const SEARCH_FIELDS = "summary,status,updated";
 async function searchIssues(client, site, params) {
-	const jql = buildJql(params);
+	return ((await fetchSearchPage(client, buildJql(params), params.limit)).issues ?? []).map((i) => toIssueSummary(site, i));
+}
+async function fetchSearchPage(client, jql, maxResults, nextPageToken) {
 	const query = new URLSearchParams({
 		jql,
-		maxResults: String(params.limit),
-		fields: "summary,status"
+		maxResults: String(maxResults),
+		fields: SEARCH_FIELDS
 	});
-	return ((await client.getJson(`/rest/api/3/search/jql?${query.toString()}`)).issues ?? []).map((i) => ({
+	if (nextPageToken) query.set("nextPageToken", nextPageToken);
+	return client.getJson(`/rest/api/3/search/jql?${query.toString()}`);
+}
+function toIssueSummary(site, i) {
+	return {
 		key: i.key,
 		status: i.fields?.status?.name ?? "",
+		statusCategory: i.fields?.status?.statusCategory?.key ?? "",
 		summary: decodeEntities(i.fields?.summary ?? ""),
+		updated: i.fields?.updated ?? "",
 		url: browseUrl(site, i.key)
-	}));
+	};
 }
 function buildJql(params) {
 	if (params.jql) return params.jql;
@@ -1856,6 +1870,46 @@ function buildJql(params) {
 	if (clauses.length === 0) clauses.push(RECENT_ISSUES_CLAUSE);
 	return `${clauses.join(" AND ")} ORDER BY updated DESC`;
 }
+const OPEN_CLAUSE = "statusCategory != Done";
+function buildListJql(params) {
+	const clauses = ["assignee = currentUser()"];
+	if (params.project) clauses.push(`project = ${jqlStringLiteral(params.project)}`);
+	clauses.push(params.all ? `(${OPEN_CLAUSE} OR ${RECENT_ISSUES_CLAUSE})` : OPEN_CLAUSE);
+	return `${clauses.join(" AND ")} ORDER BY updated DESC`;
+}
+const LIST_PAGE_SIZE = 100;
+const LIST_CAP = 500;
+async function listAssignedIssues(client, site, params) {
+	const jql = buildListJql(params);
+	const issues = [];
+	let nextPageToken;
+	for (;;) {
+		const room = LIST_CAP - issues.length;
+		const res = await fetchSearchPage(client, jql, Math.min(LIST_PAGE_SIZE, room), nextPageToken);
+		const page = res.issues ?? [];
+		issues.push(...page.map((i) => toIssueSummary(site, i)));
+		if (res.isLast || !res.nextPageToken || page.length === 0) return {
+			issues,
+			truncated: false
+		};
+		if (issues.length >= LIST_CAP) return {
+			issues,
+			truncated: true
+		};
+		nextPageToken = res.nextPageToken;
+	}
+}
+const LIST_CATEGORY_ORDER = {
+	indeterminate: 0,
+	new: 1,
+	done: 2
+};
+const LIST_UNKNOWN_CATEGORY_RANK = Object.keys(LIST_CATEGORY_ORDER).length;
+function sortByCategoryThenUpdated(issues) {
+	const rank = (i) => LIST_CATEGORY_ORDER[i.statusCategory] ?? LIST_UNKNOWN_CATEGORY_RANK;
+	const updatedMs = (i) => Date.parse(i.updated) || 0;
+	return [...issues].sort((a, b) => rank(a) - rank(b) || updatedMs(b) - updatedMs(a));
+}
 const PROJECT_PAGE_SIZE = 50;
 async function listProjects(client, site, query) {
 	const projects = [];
@@ -2123,6 +2177,9 @@ const CATEGORY_COLORS = {
 	indeterminate: kleur.yellow,
 	done: kleur.green
 };
+function colorForCategory(category) {
+	return CATEGORY_COLORS[category] ?? ((text) => text);
+}
 function formatIssueView(issue, nowMs, allComments) {
 	return [
 		`${kleur.bold(issue.key)}  ${issue.summary}`,
@@ -2133,7 +2190,7 @@ function formatIssueView(issue, nowMs, allComments) {
 	];
 }
 function fieldLines(issue, nowMs) {
-	const colorStatus = CATEGORY_COLORS[issue.statusCategory] ?? ((text) => text);
+	const colorStatus = colorForCategory(issue.statusCategory);
 	const kept = [
 		["Type", issue.type],
 		["Status", issue.status && colorStatus(issue.status)],
@@ -2226,14 +2283,47 @@ async function jiraSearch(query, options) {
 	})), {
 		json: options.json,
 		copy: options.copy,
-		limit,
-		hasMore: issues.length === limit,
-		out: options.out
-	}, {
-		singular: "issue",
-		plural: "issues"
-	}, (key) => copyIssue(client, auth.site, key, options.out));
+		out: options.out,
+		empty: "No matching issues.",
+		footer: issues.length === limit ? searchFooter(limit) : void 0
+	}, ISSUE_NOUN, (key) => copyIssue(client, auth.site, key, options.out));
+}
+async function jiraList(options) {
+	if (options.json && options.copy) throw new Error("--json and --copy cannot be used together.");
+	const auth = await requireAuth();
+	const client = new AtlassianClient(auth);
+	const { issues, truncated } = await listAssignedIssues(client, auth.site, {
+		all: options.all,
+		project: options.project
+	});
+	await runSearch(formatListRows(sortByCategoryThenUpdated(issues), Date.now()), {
+		json: options.json,
+		copy: options.copy,
+		out: options.out,
+		empty: options.all ? "No issues assigned to you." : "No open issues assigned to you.",
+		footer: truncated ? `\nShowing the first ${issues.length}; narrow with --project.` : void 0
+	}, ISSUE_NOUN, (key) => copyIssue(client, auth.site, key, options.out));
+}
+function formatListRows(issues, nowMs) {
+	const ages = issues.map((i) => relativeTime(i.updated, nowMs));
+	const width = (values) => Math.max(...values.map((v) => v.length));
+	const keyWidth = width(issues.map((i) => i.key));
+	const statusWidth = width(issues.map((i) => i.status));
+	const ageWidth = width(ages);
+	return issues.map((i, n) => {
+		const status = colorForCategory(i.statusCategory)(i.status.padEnd(statusWidth));
+		return {
+			id: i.key,
+			fixedColumns: `${i.key.padEnd(keyWidth)}  ${status}  ${(ages[n] ?? "").padEnd(ageWidth)}`,
+			freeText: i.summary,
+			json: { ...i }
+		};
+	});
 }
+const ISSUE_NOUN = {
+	singular: "issue",
+	plural: "issues"
+};
 async function copyIssue(client, site, key, out) {
 	console.log(`Fetching ${key} ...`);
 	await runCopy(planIssueCopy(await fetchIssue(client, site, key), out), (url) => client.getBinary(url));
@@ -2245,7 +2335,7 @@ const ISSUE_REF = {
 };
 //#endregion
 //#region package.json
-var version = "1.7.0";
+var version = "1.8.0";
 //#endregion
 //#region src/cli.ts
 const program = new Command();
@@ -2260,6 +2350,7 @@ jira.command("statuses [query]").description("List statuses (optionally filtered
 jira.command("view [issue]").description("Show a Jira issue (key or URL) in the terminal").option("--all-comments", "show all comments instead of the last 5").action(run(jiraView));
 jira.command("copy [issue]").description("Copy a Jira issue (key or URL) to a Markdown file").option("-o, --out <path>", "output file or directory").action(run(jiraCopy));
 jira.command("update [file]").description("Update a Jira issue description from an edited Markdown file").option("--summary", "also push the H1 as the issue summary").option("-f, --force", "skip the stale-issue and data-loss checks").option("--dry-run", "show what would change without writing").action(run(jiraUpdate));
+jira.command("list").description("List open issues assigned to you").option("-p, --project <key>", "limit to a project").option("-a, --all", "include Done issues updated in the last 30 days").option("--json", "output results as JSON").option("-c, --copy", "pick results to copy to Markdown").option("-o, --out <dir>", "output directory for --copy").action(run(jiraList));
 jira.command("search [query]").description("Search Jira issues (text query, filters, or --jql)").option("-p, --project <key>", "limit to a project").option("-a, --assignee <who>", "limit to an assignee (or 'me')").option("-s, --status <status>", "limit to a status").option("--jql <jql>", "raw JQL query (ignores other filters)").option("-l, --limit <n>", "max results (default 25, max 100)").option("--json", "output results as JSON").option("-c, --copy", "pick results to copy to Markdown").option("-o, --out <dir>", "output directory for --copy").action(run(jiraSearch));
 const confluence = program.command("confluence").description("Confluence commands");
 confluence.command("copy [page]").description("Copy a Confluence page (id or URL) to a Markdown file").option("-o, --out <path>", "output file or directory").action(run(confluenceCopy));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "atlass",
-	"version": "1.7.0",
+	"version": "1.8.0",
 	"description": "CLI to copy Jira issues and Confluence pages to Markdown, and update Confluence pages.",
 	"license": "MIT",
 	"repository": {