Merge pull request #9414 from gitbutlerapp/split-commit-tool

Split commit tool

Author: estib-vega

apps/desktop/src/components/FeedItemKind.svelte

@@ -186,6 +186,13 @@
 								{parsedCall.parameters?.branchName}
 							</span>
 						</p>
+					{:else if parsedCall.name === 'split_commit'}
+						<p class="operation__title">
+							Split commit
+							<span>
+								{parsedCall.parameters?.sourceCommitId.substring(0, 7)}
+							</span>
+						</p>
 					{/if}
 				</div>
 

apps/desktop/src/lib/ai/tool.ts

@@ -10,7 +10,8 @@ type ToolName =
 	| 'get_commit_details'
 	| 'squash_commits'
 	| 'split_branch'
-	| 'get_branch_changes';
+	| 'get_branch_changes'
+	| 'split_commit';
 
 export type ToolCall = {
 	name: ToolName;
@@ -193,6 +194,40 @@ function isGetBranchChangesParameters(params: unknown): params is GetBranchChang
 	);
 }
 
+type CommitShard = {
+	messageTitle: string;
+	messageBody: string;
+	files: string[];
+};
+
+function isCommitShard(shard: unknown): shard is CommitShard {
+	return (
+		typeof shard === 'object' &&
+		shard !== null &&
+		typeof (shard as CommitShard).messageTitle === 'string' &&
+		typeof (shard as CommitShard).messageBody === 'string' &&
+		Array.isArray((shard as CommitShard).files) &&
+		(shard as CommitShard).files.every((file) => typeof file === 'string')
+	);
+}
+
+type SplitCommitParameters = {
+	sourceStackId: string;
+	sourceCommitId: string;
+	shards: CommitShard[];
+};
+
+function isSplitCommitParameters(params: unknown): params is SplitCommitParameters {
+	return (
+		typeof params === 'object' &&
+		params !== null &&
+		typeof (params as SplitCommitParameters).sourceStackId === 'string' &&
+		typeof (params as SplitCommitParameters).sourceCommitId === 'string' &&
+		Array.isArray((params as SplitCommitParameters).shards) &&
+		(params as SplitCommitParameters).shards.every(isCommitShard)
+	);
+}
+
 interface BaseParsedToolCall {
 	name: ToolName;
 	parameters:
@@ -206,6 +241,7 @@ interface BaseParsedToolCall {
 		| SquashCommitsToolParams
 		| SplitBranchToolParams
 		| GetBranchChangesParameters
+		| SplitCommitParameters
 		| undefined;
 	result: string;
 	isError: boolean;
@@ -265,6 +301,11 @@ interface ParsedGetBranchChangesToolCall extends BaseParsedToolCall {
 	parameters: GetBranchChangesParameters | undefined;
 }
 
+interface ParsedSplitCommitToolCall extends BaseParsedToolCall {
+	name: 'split_commit';
+	parameters: SplitCommitParameters | undefined;
+}
+
 export type ParsedToolCall =
 	| ParsedCommitToolCall
 	| ParsedCreateBranchToolCall
@@ -275,7 +316,8 @@ export type ParsedToolCall =
 	| ParsedGetCommitDetailsToolCall
 	| ParsedSquashCommitsToolCall
 	| ParsedSplitBranchToolCall
-	| ParsedGetBranchChangesToolCall;
+	| ParsedGetBranchChangesToolCall
+	| ParsedSplitCommitToolCall;
 
 function safeParseJson(jsonString: string): unknown {
 	try {
@@ -326,6 +368,8 @@ export function getToolCallIcon(name: ToolName, isError: boolean): IconName {
 	}
 
 	switch (name) {
+		case 'split_commit':
+			return 'branch-shadow-commit';
 		case 'commit':
 			return 'commit';
 		case 'amend':
@@ -469,5 +513,16 @@ export function parseToolCall(toolCall: ToolCall): ParsedToolCall {
 				rawResult
 			};
 		}
+		case 'split_commit': {
+			const parameters = isSplitCommitParameters(rawParams) ? rawParams : undefined;
+			return {
+				name: toolCall.name,
+				parameters,
+				result: toolCall.result,
+				isError,
+				rawParameters: rawParams,
+				rawResult
+			};
+		}
 	}
 }

crates/but-action/src/lib.rs

@@ -90,7 +90,7 @@ pub fn freestyle(
     - `absorb`: Take a set of file changes and amend them into the existing commits in the project.
       This requires you to figure out where the changes should go based on the locks, assingments and any other user provided information.
     - `split a commit`: Take an existing commit and split it into multiple commits based on the the user directive.
-        This is a multi-step operation where you will need to create one or more black commits, and the move the file changes from the original commit to the new commits.
+        This can be achieved by using the `split_commit` tool.
     - `split a branch`: Take an existing branch and split it into two branches. This basically takes a set of committed file changes and moves them to a new branch, removing them from the original branch.
         This is useful when you want to separate the changes into a new branch for further work.
         In order to do this, you will need to get the branch changes for the intended source branch (call the `get_branch_changes` tool), and then call the split branch tool with the changes you want to split off.

crates/but-tools/src/tool.rs

@@ -144,3 +144,8 @@ impl ToolResult for Result<gix::ObjectId, anyhow::Error> {
         result_to_json(self, action_identifier, "gix::ObjectId")
     }
 }
+impl ToolResult for Result<Vec<gix::ObjectId>, anyhow::Error> {
+    fn to_json(&self, action_identifier: &str) -> serde_json::Value {
+        result_to_json(self, action_identifier, "Vec<gix::ObjectId>")
+    }
+}