@markjaquith/agency 1.11.1 → 2.1.0

package/src/commands/validate.test.ts

@@ -0,0 +1,91 @@
+import { afterEach, beforeEach, describe, expect, test } from "bun:test"
+import { mkdir } from "node:fs/promises"
+import { join } from "node:path"
+import {
+	captureLogs,
+	cleanupTempDir,
+	createTempDir,
+	runTestEffect,
+} from "../test-utils"
+import { validate } from "./validate"
+
+describe("validate command", () => {
+	let root: string
+
+	beforeEach(async () => {
+		root = await createTempDir()
+		await Bun.write(join(root, "agency.json"), '{"version":2}\n')
+		await mkdir(join(root, "repos/agency"), { recursive: true })
+		await mkdir(join(root, "tasks/example"), { recursive: true })
+	})
+
+	afterEach(async () => {
+		await cleanupTempDir(root)
+	})
+
+	test("succeeds for a valid workbase", async () => {
+		await Bun.write(
+			join(root, "tasks/example/TASK.md"),
+			`---
+ticketUrl: https://example.com/tasks/example
+repo: agency
+branch: task/example
+base: main
+pr: null
+---
+
+# Example
+`,
+		)
+
+		await expect(
+			runTestEffect(validate({ cwd: root, silent: true })),
+		).resolves.toBeUndefined()
+	})
+
+	test("outputs the validation report as JSON", async () => {
+		await Bun.write(
+			join(root, "tasks/example/TASK.md"),
+			`---
+ticketUrl: https://example.com/tasks/example
+repo: agency
+branch: task/example
+base: main
+pr: null
+---
+`,
+		)
+		const logs = await captureLogs(() =>
+			runTestEffect(validate({ cwd: root, json: true })),
+		)
+
+		expect(JSON.parse(logs[0]!)).toEqual({
+			root,
+			issues: [],
+			epicCount: 0,
+			taskCount: 1,
+			phaseCount: 0,
+			valid: true,
+		})
+	})
+
+	test("fails with document diagnostics", async () => {
+		await Bun.write(
+			join(root, "tasks/example/TASK.md"),
+			`---
+ticketUrl: https://example.com/tasks/example
+repo: missing
+branch: task/example
+base: main
+pr: null
+---
+
+# Example
+`,
+		)
+
+		await expect(
+			runTestEffect(validate({ cwd: root, silent: true })),
+		).rejects.toThrow("Unknown repository alias 'missing'")
+	})
+})

package/src/commands/validate.ts

@@ -0,0 +1,50 @@
+import { Data, Effect } from "effect"
+import type { BaseCommandOptions } from "../utils/command"
+import { WorkbaseService } from "../services/WorkbaseService"
+import { createLoggers } from "../utils/effect"
+
+interface ValidateOptions extends BaseCommandOptions {
+	readonly json?: boolean
+}
+
+class ValidationFailedError extends Data.TaggedError("ValidationFailedError")<{
+	readonly message: string
+}> {}
+
+export const validate = (options: ValidateOptions = {}) =>
+	Effect.gen(function* () {
+		const workbase = yield* WorkbaseService
+		const { log } = createLoggers(options)
+		const report = yield* workbase.validate(options.cwd ?? process.cwd())
+
+		if (options.json) {
+			log(JSON.stringify(report, null, 2))
+		}
+
+		if (!report.valid) {
+			const details = report.issues
+				.map((issue) => `- ${issue.path}: ${issue.message}`)
+				.join("\n")
+			return yield* new ValidationFailedError({
+				message: `Workbase validation failed with ${report.issues.length} issue${report.issues.length === 1 ? "" : "s"}:\n${details}`,
+			})
+		}
+
+		if (!options.json) {
+			log(
+				`Valid workbase: ${report.epicCount} epic${report.epicCount === 1 ? "" : "s"}, ` +
+					`${report.taskCount} task${report.taskCount === 1 ? "" : "s"}, ` +
+					`${report.phaseCount} phase${report.phaseCount === 1 ? "" : "s"}`,
+			)
+		}
+	})
+
+export const help = `
+Usage: agency validate [options]
+
+Validate the current workbase configuration, frontmatter, references, and
+dependency graphs.
+
+Options:
+  --json              Output the validation report as JSON
+`