(8a2abf1) Give the wrapper tools for relate, campaign, assign and tags, and bump to 0.32.10
This commit is contained in:
+373
@@ -497,3 +497,376 @@ function checkboxTool(verb: "check" | "uncheck") {
|
||||
|
||||
export const check = checkboxTool("check");
|
||||
export const uncheck = checkboxTool("uncheck");
|
||||
|
||||
/**
|
||||
* relate is the only writer of the Relations section, so the tool mirrors it rather
|
||||
* than folding relations into set.
|
||||
*
|
||||
* The clear half is one argument per kind rather than a free-text "kind target" line,
|
||||
* which is what the CLI's single --clear flag would force here. A kind inside a value
|
||||
* cannot be typed by the schema, a target is a search that may itself contain spaces,
|
||||
* and splitting the pair apart by hand re-parses what clap already refuses to guess at.
|
||||
* Per kind the target stays a plain line, the way every other list argument works.
|
||||
*/
|
||||
export const relate = tool({
|
||||
description:
|
||||
"Record a relation from one ticket to another, or take one off. Kinds: blocked-by means this one waits on that one and its moves are refused while the target is open; regression-of means this one broke that one's fix; relates-to is a neighbour with no dependency. The edge is stored on the ticket you name alone, and show derives the other end for the target, so never record both directions.",
|
||||
args: {
|
||||
ticket: tool.schema
|
||||
.string()
|
||||
.describe("Ticket UUID prefix (4+ chars) or title substring (required)"),
|
||||
blocked_by: tool.schema
|
||||
.string()
|
||||
.describe("Target tickets this one waits on, one per line.")
|
||||
.optional(),
|
||||
regression_of: tool.schema
|
||||
.string()
|
||||
.describe("Target tickets whose fix this one broke, one per line.")
|
||||
.optional(),
|
||||
relates_to: tool.schema
|
||||
.string()
|
||||
.describe("Target tickets this one merely relates to, one per line.")
|
||||
.optional(),
|
||||
clear_blocked_by: tool.schema
|
||||
.string()
|
||||
.describe("Targets whose blocked-by edge comes off this ticket, one per line.")
|
||||
.optional(),
|
||||
clear_regression_of: tool.schema
|
||||
.string()
|
||||
.describe("Targets whose regression-of edge comes off this ticket, one per line.")
|
||||
.optional(),
|
||||
clear_relates_to: tool.schema
|
||||
.string()
|
||||
.describe("Targets whose relates-to edge comes off this ticket, one per line.")
|
||||
.optional(),
|
||||
},
|
||||
async execute(args: Record<string, any>, context: ToolContext) {
|
||||
if (!args.ticket) {
|
||||
return "Error relating tickets: ticket is required";
|
||||
}
|
||||
|
||||
const cmd: string[] = ["relate", args.ticket];
|
||||
if (args.blocked_by) itemLines(args.blocked_by).forEach((line) => cmd.push("--blocked-by", line));
|
||||
if (args.regression_of) {
|
||||
itemLines(args.regression_of).forEach((line) => cmd.push("--regression-of", line));
|
||||
}
|
||||
if (args.relates_to) itemLines(args.relates_to).forEach((line) => cmd.push("--relates-to", line));
|
||||
|
||||
// The kind is spelled the way the flag records it, not the way show prints it:
|
||||
// the CLI takes either, and the flag spelling is the one with no space in it.
|
||||
if (args.clear_blocked_by) {
|
||||
itemLines(args.clear_blocked_by).forEach((line) => cmd.push("--clear", "blocked-by", line));
|
||||
}
|
||||
if (args.clear_regression_of) {
|
||||
itemLines(args.clear_regression_of).forEach((line) => cmd.push("--clear", "regression-of", line));
|
||||
}
|
||||
if (args.clear_relates_to) {
|
||||
itemLines(args.clear_relates_to).forEach((line) => cmd.push("--clear", "relates-to", line));
|
||||
}
|
||||
|
||||
if (cmd.length === 2) {
|
||||
return "Error relating tickets: name a relation to record or one to clear";
|
||||
}
|
||||
|
||||
try {
|
||||
return await run(cmd, context);
|
||||
} catch (err: any) {
|
||||
return `Error relating tickets: ${err.message}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
/**
|
||||
* Five tools for the five campaign subcommands, one export each.
|
||||
*
|
||||
* One tool taking an action argument would mirror the CLI nesting, but the schema
|
||||
* could then no longer say which arguments belong to which action: campaign_set's
|
||||
* force only means something beside --codename, and campaign_append's description is
|
||||
* required where add's is not. Separate exports keep each schema true, and the ids
|
||||
* read as the CLI path anyway, since opencode builds them from this file name plus
|
||||
* the export: worklane_campaign_set.
|
||||
*/
|
||||
export const campaign_add = tool({
|
||||
description:
|
||||
"File a new campaign: several separate tickets that have to be finished together for one goal. Its state is derived from its members, so there is nothing to move or close. Give a codename when you can: one word the board draws on every card in the campaign and the shortest thing that addresses it.",
|
||||
args: {
|
||||
title: tool.schema
|
||||
.string()
|
||||
.describe("Campaign title (required)"),
|
||||
description: tool.schema
|
||||
.string()
|
||||
.describe("What the campaign is for. Use newlines between paragraphs.")
|
||||
.optional(),
|
||||
codename: tool.schema
|
||||
.string()
|
||||
.describe("One word to call the campaign by, e.g. 'v1' or 'beaver'.")
|
||||
.optional(),
|
||||
owner: tool.schema
|
||||
.string()
|
||||
.describe("Campaign owner name. If omitted, defaults to the git user.")
|
||||
.optional(),
|
||||
},
|
||||
async execute(args: Record<string, any>, context: ToolContext) {
|
||||
if (!args.title) {
|
||||
return "Error adding campaign: title is required";
|
||||
}
|
||||
|
||||
const cmd: string[] = ["campaign", "add", "--title", args.title];
|
||||
if (args.description) {
|
||||
descriptionLines(args.description).forEach((line: string) =>
|
||||
cmd.push("--description", line),
|
||||
);
|
||||
}
|
||||
if (args.codename) cmd.push("--codename", String(args.codename));
|
||||
if (args.owner) cmd.push("--owner", args.owner);
|
||||
|
||||
try {
|
||||
return await run(cmd, context);
|
||||
} catch (err: any) {
|
||||
return `Error adding campaign: ${err.message}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
export const campaign_set = tool({
|
||||
description:
|
||||
"Replace fields on an existing campaign: its title, its description or its codename. Replacing a codename the campaign already has needs force, since everything refers to the campaign by that word once it exists; setting the codename it already carries is a no-op either way. Membership is not set here, use assign.",
|
||||
args: {
|
||||
campaign: tool.schema
|
||||
.string()
|
||||
.describe("Campaign UUID prefix, codename or title substring (required)"),
|
||||
title: tool.schema
|
||||
.string()
|
||||
.describe("New title. The file is renamed to match, keeping the UUID.")
|
||||
.optional(),
|
||||
description: tool.schema
|
||||
.string()
|
||||
.describe("New description, replacing the whole section. Use newlines between paragraphs.")
|
||||
.optional(),
|
||||
codename: tool.schema
|
||||
.string()
|
||||
.describe("New codename, one word. Replacing an existing one needs force.")
|
||||
.optional(),
|
||||
force: tool.schema
|
||||
.boolean()
|
||||
.describe("Allow replacing a codename the campaign already has.")
|
||||
.optional(),
|
||||
},
|
||||
async execute(args: Record<string, any>, context: ToolContext) {
|
||||
if (!args.campaign) {
|
||||
return "Error setting campaign fields: campaign is required";
|
||||
}
|
||||
|
||||
const cmd: string[] = ["campaign", "set", args.campaign];
|
||||
if (args.title) cmd.push("--title", args.title);
|
||||
if (args.description) {
|
||||
descriptionLines(args.description).forEach((line: string) =>
|
||||
cmd.push("--description", line),
|
||||
);
|
||||
}
|
||||
if (args.codename) cmd.push("--codename", String(args.codename));
|
||||
if (args.force) cmd.push("--force");
|
||||
|
||||
if (cmd.length === 3) {
|
||||
return "Error setting campaign fields: give at least one field to change";
|
||||
}
|
||||
|
||||
try {
|
||||
return await run(cmd, context);
|
||||
} catch (err: any) {
|
||||
return `Error setting campaign fields: ${err.message}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
export const campaign_append = tool({
|
||||
description:
|
||||
"Add a paragraph to a campaign's description without replacing what is already written. To replace the whole description, use campaign_set.",
|
||||
args: {
|
||||
campaign: tool.schema
|
||||
.string()
|
||||
.describe("Campaign UUID prefix, codename or title substring (required)"),
|
||||
description: tool.schema
|
||||
.string()
|
||||
.describe("Text to add as a new paragraph at the end of the description (required)."),
|
||||
},
|
||||
async execute(args: Record<string, any>, context: ToolContext) {
|
||||
if (!args.campaign) {
|
||||
return "Error appending to campaign: campaign is required";
|
||||
}
|
||||
if (!args.description) {
|
||||
return "Error appending to campaign: description is required";
|
||||
}
|
||||
|
||||
const cmd: string[] = ["campaign", "append", args.campaign];
|
||||
descriptionLines(args.description).forEach((line: string) =>
|
||||
cmd.push("--description", line),
|
||||
);
|
||||
|
||||
try {
|
||||
return await run(cmd, context);
|
||||
} catch (err: any) {
|
||||
return `Error appending to campaign: ${err.message}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
export const campaign_ls = tool({
|
||||
description:
|
||||
"List campaigns with how far each has got: id, codename or title, owner, and done members against total. Open until every member is done or discarded.",
|
||||
args: {
|
||||
ids: tool.schema
|
||||
.boolean()
|
||||
.describe("Print only id and title, tab separated, one per line, for parsing.")
|
||||
.optional(),
|
||||
},
|
||||
async execute(args: Record<string, any>, context: ToolContext) {
|
||||
const cmd = ["campaign", "ls"];
|
||||
if (args.ids) cmd.push("--ids");
|
||||
try {
|
||||
return await run(cmd, context);
|
||||
} catch (err: any) {
|
||||
return `Error listing campaigns: ${err.message}, Dir: ${resolveWorklaneDir(context)}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
export const campaign_show = tool({
|
||||
description:
|
||||
"Show a campaign's body and its members grouped by status, done included, so what is finished against what is left is one answer.",
|
||||
args: {
|
||||
campaign: tool.schema
|
||||
.string()
|
||||
.describe("Campaign UUID prefix, codename or title substring (required)"),
|
||||
},
|
||||
async execute(args: Record<string, any>, context: ToolContext) {
|
||||
if (!args.campaign) {
|
||||
return "Error showing campaign: campaign is required";
|
||||
}
|
||||
try {
|
||||
return await run(["campaign", "show", args.campaign], context);
|
||||
} catch (err: any) {
|
||||
return `Error showing campaign: ${err.message}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
export const assign = tool({
|
||||
description:
|
||||
"Put a ticket in a campaign, moving it out of whichever campaign it was in: a ticket is in at most one. Note the order, campaign first and ticket second, after chown.",
|
||||
args: {
|
||||
campaign: tool.schema
|
||||
.string()
|
||||
.describe("Campaign UUID prefix, codename or title substring (required)"),
|
||||
ticket: tool.schema
|
||||
.string()
|
||||
.describe("Ticket UUID prefix (4+ chars) or title substring (required)"),
|
||||
actor: tool.schema
|
||||
.string()
|
||||
.describe("Who the entry is attributed to. If omitted, WORKLANE_ACTOR is used, then the git user, then \"unknown\". Set WORKLANE_ACTOR in the environment opencode is started with rather than passing this on every call.")
|
||||
.optional(),
|
||||
},
|
||||
async execute(args: Record<string, any>, context: ToolContext) {
|
||||
if (!args.campaign) {
|
||||
return "Error assigning ticket: campaign is required";
|
||||
}
|
||||
if (!args.ticket) {
|
||||
return "Error assigning ticket: ticket is required";
|
||||
}
|
||||
|
||||
const cmd: string[] = ["assign", args.campaign, args.ticket];
|
||||
if (args.actor) cmd.push("--actor", args.actor);
|
||||
|
||||
try {
|
||||
return await run(cmd, context);
|
||||
} catch (err: any) {
|
||||
return `Error assigning ticket: ${err.message}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
/**
|
||||
* Three tools for tags, and none for `tags ls`: it prints exactly what the bare
|
||||
* `worklane tags` listing prints, which the tags tool runs.
|
||||
*
|
||||
* The annotation lines go through descriptionLines, not itemLines: an empty value is
|
||||
* a paragraph break in an annotation, exactly as it is in a description, because the
|
||||
* value_parser on the CLI side accepts one and the vocabulary file stores prose under
|
||||
* the tag heading.
|
||||
*/
|
||||
export const tags = tool({
|
||||
description:
|
||||
"List the tags the board carries: the tag, how many tickets carry it, and the opening line of its declared meaning. Read this before inventing a tag. Case sensitive, so bug and Bug list separately and land next to each other, which is where a near-duplicate is spotted.",
|
||||
args: {},
|
||||
async execute(_args: Record<string, any>, context: ToolContext) {
|
||||
try {
|
||||
return await run(["tags"], context);
|
||||
} catch (err: any) {
|
||||
return `Error listing tags: ${err.message}, Dir: ${resolveWorklaneDir(context)}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
export const tags_add = tool({
|
||||
description:
|
||||
"Declare a tag and what it means: when the next ticket belongs in it. The tag is spelled exactly the way ls --tag matches it, one word with no comma in it.",
|
||||
args: {
|
||||
tag: tool.schema
|
||||
.string()
|
||||
.describe("The tag to declare (required), e.g. 'bug' or 'frontend'."),
|
||||
annotation: tool.schema
|
||||
.string()
|
||||
.describe("What the tag means and when it is appropriate. Use newlines between paragraphs.")
|
||||
.optional(),
|
||||
},
|
||||
async execute(args: Record<string, any>, context: ToolContext) {
|
||||
if (!args.tag) {
|
||||
return "Error declaring tag: tag is required";
|
||||
}
|
||||
|
||||
const cmd: string[] = ["tags", "add", args.tag];
|
||||
if (args.annotation) {
|
||||
descriptionLines(args.annotation).forEach((line: string) =>
|
||||
cmd.push("--annotation", line),
|
||||
);
|
||||
}
|
||||
|
||||
try {
|
||||
return await run(cmd, context);
|
||||
} catch (err: any) {
|
||||
return `Error declaring tag: ${err.message}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
export const tags_set = tool({
|
||||
description:
|
||||
"Replace what a declared tag means, keeping the tickets carrying it. There is no rename: changing the word itself means rewriting the Tags field of every ticket that carries it, which is a migration and not this call.",
|
||||
args: {
|
||||
tag: tool.schema
|
||||
.string()
|
||||
.describe("The tag to change, spelled the way it was declared (required)."),
|
||||
annotation: tool.schema
|
||||
.string()
|
||||
.describe("What the tag means, replacing whatever it said before. Use newlines between paragraphs (required)."),
|
||||
},
|
||||
async execute(args: Record<string, any>, context: ToolContext) {
|
||||
if (!args.tag) {
|
||||
return "Error setting tag meaning: tag is required";
|
||||
}
|
||||
if (!args.annotation) {
|
||||
return "Error setting tag meaning: annotation is required";
|
||||
}
|
||||
|
||||
const cmd: string[] = ["tags", "set", args.tag];
|
||||
descriptionLines(args.annotation).forEach((line: string) =>
|
||||
cmd.push("--annotation", line),
|
||||
);
|
||||
|
||||
try {
|
||||
return await run(cmd, context);
|
||||
} catch (err: any) {
|
||||
return `Error setting tag meaning: ${err.message}`;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user