@markjaquith/agency 2.4.0 → 2.5.0

package/src/workbase/schemas.test.ts

@@ -53,6 +53,15 @@ describe("body-of-work descriptions", () => {
 		expect(epic.description).toBeUndefined()
 	})
 
+	test("allows tasks without an external ticket", () => {
+		const task = Schema.decodeUnknownSync(TaskFrontmatter)({
+			ticketUrl: null,
+			phases: [],
+		})
+
+		expect(task.ticketUrl).toBeNull()
+	})
+
 	test("rejects an empty description when present", () => {
 		expect(() =>
 			Schema.decodeUnknownSync(PhaseFrontmatter)({
@@ -66,6 +75,47 @@ describe("body-of-work descriptions", () => {
 	})
 })
 
+describe("work status", () => {
+	test("defaults execution units to open", () => {
+		const task = Schema.decodeUnknownSync(TaskFrontmatter)({
+			ticketUrl: "https://example.com/task",
+			repo: "agency",
+			branch: "task/default-status",
+			base: "main",
+			pr: null,
+		})
+		const phase = Schema.decodeUnknownSync(PhaseFrontmatter)({
+			repo: "agency",
+			branch: "task/default-phase-status",
+			base: "main",
+			pr: null,
+		})
+
+		expect("status" in task && task.status).toBe("open")
+		expect(phase.status).toBe("open")
+	})
+
+	test("accepts supported statuses and rejects other values", () => {
+		const phase = Schema.decodeUnknownSync(PhaseFrontmatter)({
+			repo: "agency",
+			branch: "task/done",
+			base: "main",
+			pr: null,
+			status: "done",
+		})
+		expect(phase.status).toBe("done")
+		expect(() =>
+			Schema.decodeUnknownSync(PhaseFrontmatter)({
+				repo: "agency",
+				branch: "task/invalid",
+				base: "main",
+				pr: null,
+				status: "blocked",
+			}),
+		).toThrow()
+	})
+})
+
 describe("schema boundaries", () => {
 	const rejects = <S extends Schema.Schema.AnyNoContext>(
 		schema: S,

package/src/workbase/schemas.ts

@@ -15,6 +15,8 @@ export const RepositoryReference = Schema.Struct({
 	ref: NonEmptyString,
 })
 
+export const WorkStatus = Schema.Literal("open", "working", "done", "dropped")
+
 const Url = NonEmptyString.pipe(Schema.pattern(/^[a-zA-Z][a-zA-Z0-9+.-]*:/))
 
 const GitHubPullRequestUrl = NonEmptyString.pipe(
@@ -37,6 +39,7 @@ const ExecutionUnit = {
 	branch: NonEmptyString,
 	base: NonEmptyString,
 	pr: Schema.NullOr(GitHubPullRequestUrl),
+	status: Schema.optionalWith(WorkStatus, { default: () => "open" as const }),
 }
 
 export const EpicFrontmatter = Schema.Struct({
@@ -47,14 +50,14 @@ export const EpicFrontmatter = Schema.Struct({
 })
 
 const SinglePhaseTaskFrontmatter = Schema.Struct({
-	ticketUrl: Url,
+	ticketUrl: Schema.NullOr(Url),
 	description: Description,
 	epic: Schema.optional(EntityId),
 	...ExecutionUnit,
 })
 
 const MultiPhaseTaskFrontmatter = Schema.Struct({
-	ticketUrl: Url,
+	ticketUrl: Schema.NullOr(Url),
 	description: Description,
 	epic: Schema.optional(EntityId),
 	phases: Schema.Array(Dependency),
@@ -73,6 +76,7 @@ export const PhaseFrontmatter = Schema.Struct({
 export type WorkbaseConfig = Schema.Schema.Type<typeof WorkbaseConfig>
 export type Dependency = Schema.Schema.Type<typeof Dependency>
 export type RepositoryReference = Schema.Schema.Type<typeof RepositoryReference>
+export type WorkStatus = Schema.Schema.Type<typeof WorkStatus>
 export type EpicFrontmatter = Schema.Schema.Type<typeof EpicFrontmatter>
 export type TaskFrontmatter = Schema.Schema.Type<typeof TaskFrontmatter>
 export type PhaseFrontmatter = Schema.Schema.Type<typeof PhaseFrontmatter>

package/src/workbase/work-target.test.ts

@@ -25,7 +25,7 @@ describe("work target choices", () => {
 				{
 					id: "single",
 					path: "/workbase/tasks/single/TASK.md",
-					data: {},
+					data: { status: "done" },
 				},
 				{
 					id: "standalone",
@@ -38,19 +38,19 @@ describe("work target choices", () => {
 					taskId: "multi",
 					id: "verify",
 					path: "/workbase/tasks/multi/phases/verify/PHASE.md",
-					data: {},
+					data: { status: "done" },
 				},
 				{
 					taskId: "multi",
 					id: "build",
 					path: "/workbase/tasks/multi/phases/build/PHASE.md",
-					data: {},
+					data: { status: "working" },
 				},
 				{
 					taskId: "multi",
 					id: "unlisted",
 					path: "/workbase/tasks/multi/phases/unlisted/PHASE.md",
-					data: {},
+					data: { status: "dropped" },
 				},
 			],
 		)
@@ -58,11 +58,11 @@ describe("work target choices", () => {
 		expect(choices.map((choice) => choice.label)).toEqual([
 			"\x1b[35m\x1b[0m delivery\x1b[2m - Ship the release\x1b[0m",
 			"  \x1b[36m󰗡\x1b[0m multi",
-			"    \x1b[33m󰔚\x1b[0m build",
-			"    \x1b[33m󰔚\x1b[0m verify",
-			"    \x1b[33m󰔚\x1b[0m unlisted",
-			"  \x1b[36m󰗡\x1b[0m single",
-			"\x1b[36m󰗡\x1b[0m standalone\x1b[2m - Independent work\x1b[0m",
+			"    \x1b[34m◐\x1b[0m \x1b[33m󰔚\x1b[0m build",
+			"    \x1b[32m✓\x1b[0m \x1b[33m󰔚\x1b[0m verify",
+			"    \x1b[31m⊘\x1b[0m \x1b[33m󰔚\x1b[0m unlisted",
+			"  \x1b[32m✓\x1b[0m \x1b[36m󰗡\x1b[0m single",
+			"\x1b[2m○\x1b[0m \x1b[36m󰗡\x1b[0m standalone\x1b[2m - Independent work\x1b[0m",
 		])
 		expect(choices.map((choice) => choice.target.kind)).toEqual([
 			"epic",

package/src/workbase/work-target.ts

@@ -1,4 +1,5 @@
 import { Effect } from "effect"
+import type { WorkStatus } from "./schemas"
 
 export type WorkTarget =
 	| {
@@ -36,14 +37,17 @@ interface TaskRecord {
 				readonly description?: string
 				readonly phases: readonly { readonly id: string }[]
 		  }
-		| { readonly description?: string }
+		| { readonly description?: string; readonly status?: WorkStatus }
 }
 
 interface PhaseRecord {
 	readonly taskId: string
 	readonly id: string
 	readonly path: string
-	readonly data: { readonly description?: string }
+	readonly data: {
+		readonly description?: string
+		readonly status?: WorkStatus
+	}
 }
 
 export interface WorkTargetChoice {
@@ -51,13 +55,21 @@ export interface WorkTargetChoice {
 	readonly target: WorkTarget
 }
 
+const statusIcons: Record<WorkStatus, string> = {
+	open: "\x1b[2m○\x1b[0m",
+	working: "\x1b[34m◐\x1b[0m",
+	done: "\x1b[32m✓\x1b[0m",
+	dropped: "\x1b[31m⊘\x1b[0m",
+}
+
 const label = (
 	indent: string,
 	kind: WorkTarget["kind"],
 	id: string,
 	description?: string,
+	status?: WorkStatus,
 ) =>
-	`${indent}${
+	`${indent}${status === undefined ? "" : `${statusIcons[status]} `}${
 		{
 			epic: "\x1b[35m\x1b[0m",
 			task: "\x1b[36m󰗡\x1b[0m",
@@ -73,7 +85,13 @@ const taskChoices = (
 	const multiPhase = "phases" in task.data
 	const choices: WorkTargetChoice[] = [
 		{
-			label: label(indent, "task", task.id, task.data.description),
+			label: label(
+				indent,
+				"task",
+				task.id,
+				task.data.description,
+				multiPhase ? undefined : (task.data.status ?? "open"),
+			),
 			target: {
 				kind: "task",
 				taskId: task.id,
@@ -91,7 +109,13 @@ const taskChoices = (
 		if (!record) continue
 		renderedPhases.add(record.id)
 		choices.push({
-			label: label(`${indent}  `, "phase", record.id, record.data.description),
+			label: label(
+				`${indent}  `,
+				"phase",
+				record.id,
+				record.data.description,
+				record.data.status ?? "open",
+			),
 			target: {
 				kind: "phase",
 				taskId: task.id,
@@ -103,7 +127,13 @@ const taskChoices = (
 	for (const record of phaseRecords) {
 		if (renderedPhases.has(record.id)) continue
 		choices.push({
-			label: label(`${indent}  `, "phase", record.id, record.data.description),
+			label: label(
+				`${indent}  `,
+				"phase",
+				record.id,
+				record.data.description,
+				record.data.status ?? "open",
+			),
 			target: {
 				kind: "phase",
 				taskId: task.id,