pi-onedev-toolkit 0.1.0

package/src/tools/pull.ts

@@ -0,0 +1,298 @@
+import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import { StringEnum } from "@earendil-works/pi-ai";
+import { Type, type Static } from "typebox";
+import {
+	confirmGate,
+	pushRepeated,
+	QUERY_DESCRIPTION,
+	REF_DESCRIPTION,
+	requireParam,
+	runInContext,
+	toolResult,
+	withFooter,
+	type ToolDeps,
+} from "./common.js";
+
+const PULL_ACTIONS = [
+	"list",
+	"get",
+	"get_comments",
+	"get_code_comments",
+	"get_builds",
+	"get_patch",
+	"create",
+	"edit",
+	"add_comment",
+	"add_code_comment",
+	"approve",
+	"request_changes",
+	"merge",
+	"discard",
+	"checkout",
+	"current_reference",
+	"valid_labels",
+	"query_description",
+	"title_description_requirement",
+	"commit_message_requirement",
+] as const;
+export type PullAction = (typeof PULL_ACTIONS)[number];
+
+export interface PullParams {
+	action?: PullAction;
+	ref?: string;
+	title?: string;
+	description?: string;
+	content?: string;
+	summary?: string;
+	commitMessage?: string;
+	comment?: string;
+	file?: string;
+	fromLine?: number;
+	toLine?: number;
+	sourceBranch?: string;
+	targetBranch?: string;
+	sourceProject?: string;
+	targetProject?: string;
+	assignees?: string[];
+	reviewers?: string[];
+	removeReviewers?: string[];
+	labels?: string[];
+	mergeStrategy?: string;
+	autoMerge?: boolean;
+	autoMergeCommitMessage?: string;
+	forCodeReview?: boolean;
+	forWrite?: boolean;
+	project?: string;
+	query?: string;
+	count?: number;
+	offset?: number;
+	confirm?: boolean;
+}
+
+export function buildPullArgs(params: PullParams): string[] {
+	const args: string[] = ["pr"];
+	const action = requireParam(params.action, "pr", "action");
+	const ref = (): string => requireParam(params.ref, action, "ref");
+	const branchScope = (): void => {
+		if (params.sourceBranch !== undefined)
+			args.push("--source-branch", params.sourceBranch);
+		if (params.targetBranch !== undefined)
+			args.push("--target-branch", params.targetBranch);
+		if (params.sourceProject !== undefined)
+			args.push("--source-project", params.sourceProject);
+		if (params.targetProject !== undefined)
+			args.push("--target-project", params.targetProject);
+	};
+	switch (action) {
+		case "list":
+			args.push("list");
+			if (params.project !== undefined) args.push("--project", params.project);
+			if (params.query !== undefined) args.push("--query", params.query);
+			if (params.offset !== undefined)
+				args.push("--offset", String(params.offset));
+			args.push("--count", String(params.count ?? 25));
+			return args;
+		case "get":
+			return [...args, "get", ref()];
+		case "get_comments":
+			return [...args, "get-comments", ref()];
+		case "get_code_comments":
+			return [...args, "get-code-comments", ref()];
+		case "get_builds":
+			return [...args, "get-builds", ref()];
+		case "get_patch":
+			args.push("get-patch", ref());
+			if (params.forCodeReview === true) args.push("--for-code-review");
+			return args;
+		case "create":
+			args.push("create", requireParam(params.title, action, "title"));
+			branchScope();
+			if (params.description !== undefined)
+				args.push("--description", params.description);
+			pushRepeated(args, "--assignee", params.assignees);
+			pushRepeated(args, "--reviewer", params.reviewers);
+			pushRepeated(args, "--label", params.labels);
+			if (params.mergeStrategy !== undefined)
+				args.push("--merge-strategy", params.mergeStrategy);
+			return args;
+		case "edit":
+			args.push("edit", ref());
+			if (params.title !== undefined) args.push("--title", params.title);
+			if (params.description !== undefined)
+				args.push("--description", params.description);
+			pushRepeated(args, "--assignee", params.assignees);
+			pushRepeated(args, "--add-reviewer", params.reviewers);
+			pushRepeated(args, "--remove-reviewer", params.removeReviewers);
+			pushRepeated(args, "--label", params.labels);
+			if (params.mergeStrategy !== undefined)
+				args.push("--merge-strategy", params.mergeStrategy);
+			if (params.autoMerge === true) {
+				args.push("--auto-merge");
+				if (params.autoMergeCommitMessage !== undefined)
+					args.push("--auto-merge-commit-message", params.autoMergeCommitMessage);
+			}
+			return args;
+		case "add_comment":
+			return [
+				...args,
+				"add-comment",
+				ref(),
+				requireParam(params.content, action, "content"),
+			];
+		case "add_code_comment":
+			args.push(
+				"add-code-comment",
+				ref(),
+				requireParam(params.content, action, "content"),
+			);
+			args.push("--file", requireParam(params.file, action, "file"));
+			args.push(
+				"--from-line",
+				String(requireParam(params.fromLine, action, "from_line")),
+			);
+			args.push("--to-line", String(params.toLine ?? params.fromLine));
+			return args;
+		case "approve":
+			args.push("approve", ref());
+			if (params.summary !== undefined) args.push("--summary", params.summary);
+			return args;
+		case "request_changes":
+			args.push("request-changes", ref());
+			if (params.summary !== undefined) args.push("--summary", params.summary);
+			return args;
+		case "merge":
+			confirmGate(action, params.confirm);
+			args.push("merge", ref());
+			if (params.commitMessage !== undefined)
+				args.push("--commit-message", params.commitMessage);
+			return args;
+		case "discard":
+			confirmGate(action, params.confirm);
+			args.push("discard", ref());
+			if (params.comment !== undefined) args.push("--comment", params.comment);
+			return args;
+		case "checkout":
+			args.push("checkout", ref());
+			if (params.forWrite === true) args.push("--for-write");
+			return args;
+		case "current_reference":
+			return [...args, "current-reference"];
+		case "valid_labels":
+			return ["get-valid-labels"];
+		case "query_description":
+			return [...args, "get-query-description"];
+		case "title_description_requirement":
+			args.push("get-title-and-description-requirement");
+			branchScope();
+			return args;
+		case "commit_message_requirement":
+			args.push("get-commit-message-requirement");
+			branchScope();
+			return args;
+	}
+}
+
+export function registerPullTool(pi: ExtensionAPI, deps: ToolDeps): void {
+	const parameters = Type.Object({
+		action: StringEnum(PULL_ACTIONS, {
+			description:
+				"list, get, get_comments, get_code_comments, get_builds, get_patch (diff; for_code_review scopes it), create, edit, add_comment, add_code_comment (line-anchored), approve, request_changes, merge (confirm), discard (confirm), checkout, current_reference, valid_labels, query_description, title_description_requirement, commit_message_requirement",
+		}),
+		ref: Type.Optional(Type.String({ description: REF_DESCRIPTION })),
+		title: Type.Optional(Type.String()),
+		description: Type.Optional(Type.String({ description: "Markdown body" })),
+		content: Type.Optional(Type.String({ description: "Markdown comment text" })),
+		summary: Type.Optional(
+			Type.String({
+				description: "Markdown review summary for approve/request_changes",
+			}),
+		),
+		comment: Type.Optional(
+			Type.String({ description: "Markdown note for discard" }),
+		),
+		commitMessage: Type.Optional(
+			Type.String({
+				description: "Commit message for merge (required by squash merges)",
+			}),
+		),
+		file: Type.Optional(
+			Type.String({ description: "add_code_comment: file path in the PR patch" }),
+		),
+		fromLine: Type.Optional(
+			Type.Integer({
+				minimum: 1,
+				description: "add_code_comment: 1-based start line (right side of patch)",
+			}),
+		),
+		toLine: Type.Optional(
+			Type.Integer({
+				minimum: 1,
+				description: "add_code_comment: 1-based end line; defaults to from_line",
+			}),
+		),
+		sourceBranch: Type.Optional(Type.String()),
+		targetBranch: Type.Optional(Type.String()),
+		sourceProject: Type.Optional(Type.String()),
+		targetProject: Type.Optional(Type.String()),
+		assignees: Type.Optional(
+			Type.Array(Type.String(), { description: "User logins, repeatable" }),
+		),
+		reviewers: Type.Optional(
+			Type.Array(Type.String(), { description: "User logins, repeatable" }),
+		),
+		removeReviewers: Type.Optional(
+			Type.Array(Type.String(), { description: "edit: user logins to remove" }),
+		),
+		labels: Type.Optional(
+			Type.Array(Type.String(), {
+				description: "Label names; discover via valid_labels",
+			}),
+		),
+		mergeStrategy: Type.Optional(Type.String()),
+		autoMerge: Type.Optional(Type.Boolean()),
+		autoMergeCommitMessage: Type.Optional(Type.String()),
+		forCodeReview: Type.Optional(
+			Type.Boolean({ description: "get_patch: review-scoped patch" }),
+		),
+		forWrite: Type.Optional(
+			Type.Boolean({ description: "checkout: set up the branch for pushing" }),
+		),
+		project: Type.Optional(
+			Type.String({
+				description: "Project path for list; defaults to the current project",
+			}),
+		),
+		query: Type.Optional(Type.String({ description: QUERY_DESCRIPTION })),
+		count: Type.Optional(Type.Integer({ minimum: 1, maximum: 100 })),
+		offset: Type.Optional(Type.Integer({ minimum: 0 })),
+		confirm: Type.Optional(
+			Type.Boolean({
+				description:
+					"Required true for merge/discard: re-run with confirm after the user approves the destructive action",
+			}),
+		),
+	});
+	type Params = Static<typeof parameters>;
+
+	pi.registerTool({
+		name: "onedev_pull",
+		label: "OneDev Pull Requests",
+		description:
+			"Read and edit OneDev pull requests: metadata, labels, comments, line-anchored code comments, builds, patch, review outcomes, and guarded merge/discard. Runs in the current repository's project.",
+		promptGuidelines: [
+			"Use onedev_pull get_patch with for_code_review for review-scoped diffs.",
+			"merge and discard require confirm: true after explicit user approval.",
+		],
+		parameters,
+		async execute(_toolCallId, params: Params, signal) {
+			const output = await runInContext(deps, buildPullArgs(params), { signal });
+			return toolResult(
+				withFooter(output.text, deps.context(), output.truncated),
+				{
+					action: params.action,
+					truncated: output.truncated,
+				},
+			);
+		},
+	});
+}