Files
worklane/.opencode/tools/worklane.ts
T
Ansho ReiandClaude Opus 5 ddbd45e332 (dca0b61) Add priority as a ticket field
Priority lived in tags, as p1 to p3, which ls could neither sort nor
filter on, nothing validated, and a typo like P1 passed silently. ls
sorted by title only, so a backlog of any size gave no ordering signal.

Levels are 1 to 5 with 1 most urgent, matching what the tags meant.
Omitting the flag leaves the field _Not set_, like Due and Owner: there is
no implicit middle level, because a priority nobody chose is worse than
none. clap rejects anything outside the range before a ticket is written.

Priority parses to three states rather than two. A stored value outside
the range is Invalid, kept distinct from Unset, so a typo cannot read as
"no priority": it shows as ? and sorts just ahead of the unset tail.

ls sorts on priority and falls back to the old title sort, and --priority
filters, composing with the status filter in both the grouped and the
filtered listing. TicketItem becomes a struct, since a sixth tuple field
was past reading.

Migrated the 31 tickets already carrying p1 to p3 tags: the level moves to
the field and the tag is dropped.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-20 15:36:19 +02:00

237 lines
7.7 KiB
TypeScript

import { tool, ToolContext } from "@opencode-ai/plugin";
import path from "path";
function resolveWorklaneDir(context: ToolContext): string {
return path.join(context.worktree || context.directory || ".");
}
/**
* Run worklane and return its stdout, throwing with its stderr on failure.
*
* Both streams have to be piped. Bun defaults stderr to inherit, so it went to
* this process and never reached the model, and Bun.$ throws a ShellError whose
* message is only "Failed with exit code 1". Either way the CLI explained itself
* and nothing relayed the explanation.
*
* stdout is the fallback, not the source: worklane writes errors to stderr.
*/
async function run(cmd: string[], context: ToolContext): Promise<string> {
const proc = Bun.spawn(["worklane", ...cmd], {
cwd: resolveWorklaneDir(context),
stdout: "pipe",
stderr: "pipe",
});
const [stdout, stderr, exitCode] = await Promise.all([
new Response(proc.stdout).text(),
new Response(proc.stderr).text(),
proc.exited,
]);
if (exitCode !== 0) {
// anyhow prefixes its own "Error: ", and every caller here adds a prefix of
// its own, so drop it rather than relaying "Error adding comment: Error: ...".
const reason = stderr.trim().replace(/^Error:\s*/, "");
throw new Error(reason || stdout.trim() || `worklane exited with code ${exitCode}`);
}
return stdout.trim();
}
export const init = tool({
description:
"Initialize worklane in the current project. Creates the .worklane/ directory with backlog, committed, reviewing, and done subdirectories.",
args: {},
async execute(_args: Record<string, any>, context: ToolContext) {
try {
return await run(["init"], context);
} catch (err: any) {
return `Error initializing worklane: ${err.message}`;
}
},
});
export const add = tool({
description:
"Add a new ticket to the worklane backlog. Requires a title. Description, acceptance criteria, and plan each support multiple lines (one item per line). Tags are comma-separated.",
args: {
title: tool.schema
.string()
.describe("Ticket title (required)"),
description: tool.schema
.string()
.describe("Description text. Use newlines between paragraphs."),
acceptance: tool.schema
.string()
.describe("Acceptance criteria, one per line. Put each criterium on its own line."),
plan: tool.schema
.string()
.describe("Implementation plan steps, one per line. Put each step on its own line."),
tags: tool.schema
.string()
.describe("Comma-separated tags, e.g. 'bug,frontend,urgent'"),
due: tool.schema
.string()
.describe("Due date in YYYY-MM-DD format"),
owner: tool.schema
.string()
.describe("Ticket owner name. If omitted, defaults to the git user."),
priority: tool.schema
.string()
.describe("Priority level, 1 (most urgent) to 5 (least). Left unset if omitted.")
.optional(),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.title) {
return "Error adding ticket: title is required";
}
const cmd: string[] = ["add", "--title", args.title];
if (args.description) {
args.description
.split("\n")
.map((l: string) => l.trim())
.filter(Boolean)
.forEach((line: string) => cmd.push("--description", line));
}
if (args.acceptance) {
args.acceptance
.split("\n")
.map((l: string) => l.trim())
.filter(Boolean)
.forEach((line: string) => cmd.push("--acceptance", line));
}
if (args.plan) {
args.plan
.split("\n")
.map((l: string) => l.trim())
.filter(Boolean)
.forEach((line: string) => cmd.push("--plan", line));
}
if (args.tags) cmd.push("--tags", args.tags);
if (args.due) cmd.push("--due", args.due);
if (args.owner) cmd.push("--owner", args.owner);
if (args.priority) cmd.push("--priority", String(args.priority));
try {
return await run(cmd, context);
} catch (err: any) {
return `Error adding ticket: ${err.message}`;
}
},
});
export const ls = tool({
description:
"List all worklane tickets, sorted by priority then title. Optionally filter by status and by priority.",
args: {
status: tool.schema
.enum(["backlog", "committed", "reviewing", "done"])
.describe("Filter by status")
.optional(),
priority: tool.schema
.string()
.describe("Only show tickets at this priority, 1 (most urgent) to 5 (least)")
.optional(),
},
async execute(args: Record<string, any>, context: ToolContext) {
const cmd = args.status ? ["ls", args.status] : ["ls"];
if (args.priority) cmd.push("--priority", String(args.priority));
try {
return await run(cmd, context);
} catch (err: any) {
// The directory is worth naming here: the usual failure is that there is
// no .worklane above it.
return `Error listing tickets: ${err.message}, Dir: ${resolveWorklaneDir(context)}`;
}
},
});
export const show = tool({
description:
"Show a complete ticket by UUID or title. Displays title, description, acceptance criteria, implementation plan, metadata, and comments.",
args: {
id: tool.schema
.string()
.describe("Ticket UUID (8+ chars) or title substring (required)"),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.id) {
return "Error showing ticket: id is required";
}
try {
return await run(["show", args.id], context);
} catch (err: any) {
return `Error showing ticket: ${err.message}`;
}
},
});
export const mv = tool({
description:
"Move a ticket to a different status in the workflow (backlog -> committed -> reviewing -> done).",
args: {
ticket: tool.schema
.string()
.describe("Ticket UUID (8+ chars) or title substring (required)"),
status: tool.schema
.enum(["backlog", "committed", "reviewing", "done"])
.describe("Target status (required)"),
force: tool.schema
.boolean()
.describe("Force move (allows non-sequential moves like done -> backlog). Use with caution.")
.optional(),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.ticket) {
return "Error moving ticket: ticket is required";
}
if (!args.status) {
return "Error moving ticket: status is required. Must be one of: backlog, committed, reviewing, done";
}
const cmd: string[] = ["mv", args.ticket, "--status", args.status];
if (args.force) cmd.push("--force");
try {
return await run(cmd, context);
} catch (err: any) {
return `Error moving ticket: ${err.message}`;
}
},
});
export const comment = tool({
description: "Add a comment to an existing ticket. The comment body supports markdown and newlines. Use it to add review feedback, notes, or status updates.",
args: {
ticket: tool.schema
.string()
.describe("Ticket UUID (8+ chars) or title substring (required)"),
body: tool.schema
.string()
.describe("Comment body text (required). Supports markdown formatting and multiple paragraphs separated by newlines."),
owner: tool.schema
.string()
.describe("Comment author. If omitted, defaults to the git user.")
.optional(),
},
async execute(args: Record<string, any>, context: ToolContext) {
if (!args.ticket) {
return "Error adding comment: ticket is required";
}
if (!args.body) {
return "Error adding comment: body is required";
}
const cmd: string[] = ["comment", args.ticket, args.body];
if (args.owner) cmd.push("--owner", args.owner);
try {
return await run(cmd, context);
} catch (err: any) {
return `Error adding comment: ${err.message}`;
}
},
});