[PROTOBUS] Move createRuleFile to protobus 🚌💨 (RooCodeInc#3122)

* createRuleFile protobus migration

* deleteRuleFile protobus

* mend

* mend

* mend

* Generic response for delete request

* refactored deleteRuleFile for consolidation

* rename ruleFileResult to ruleFile

* rebase and cleanup

* createRuleFile protobus migration

* ellipsis changes

* consolidated ruleFile protos

* prep for merge on to 3124

* removed ruleFileOperations

Author: canvrno

.changeset/hungry-islands-jog.md

@@ -0,0 +1,5 @@
+---
+"claude-dev": patch
+---
+
+createRuleFile protobus migration

proto/common.proto

@@ -49,9 +49,3 @@ message BooleanRequest {
 message Boolean {
   bool value = 1;
 }
-
-// Generic response for operations that return success status and a message
-message OperationResponse {
-  bool success = 1;     // Whether the operation was successful
-  string message = 2;   // Success or error message
-}

proto/file.proto

@@ -13,20 +13,26 @@ service FileService {
 
   // Opens an image in the system viewer
   rpc openImage(StringRequest) returns (Empty);
-  
+
   // Deletes a rule file from either global or workspace rules directory
-  rpc deleteRuleFile(DeleteRuleFileRequest) returns (RuleFile);
+  rpc deleteRuleFile(RuleFileRequest) returns (RuleFile);
+
+  // Creates a rule file from either global or workspace rules directory
+  rpc createRuleFile(RuleFileRequest) returns (RuleFile);
 }
 
-// Request for deleteRuleFile
-message DeleteRuleFileRequest {
+// Unified request for all rule file operations
+message RuleFileRequest {
   Metadata metadata = 1;
-  string rule_path = 2;
-  bool is_global = 3;
+  bool is_global = 2;            // Common field for all operations
+  optional string rule_path = 3; // Path field for deleteRuleFile (optional)
+  optional string filename = 4;  // Filename field for createRuleFile (optional)
 }
 
 // Result for rule file operations with meaningful data only
 message RuleFile {
   string file_path = 1;     // Path to the rule file
   string display_name = 2;  // Filename for display purposes
+  bool already_exists = 3;  // For createRuleFile, indicates if file already existed
 }
+

src/core/controller/file/createRuleFile.ts

@@ -0,0 +1,55 @@
+import { Controller } from ".."
+import { RuleFileRequest, RuleFile } from "@shared/proto/file"
+import { FileMethodHandler } from "./index"
+import {
+	createRuleFile as createRuleFileImpl,
+	refreshClineRulesToggles,
+} from "@core/context/instructions/user-instructions/cline-rules"
+import * as vscode from "vscode"
+import * as path from "path"
+import { handleFileServiceRequest } from "./index"
+import { cwd } from "@core/task"
+
+/**
+ * Creates a rule file in either global or workspace rules directory
+ * @param controller The controller instance
+ * @param request The request containing filename and isGlobal flag
+ * @returns Result with file path and display name
+ * @throws Error if operation fails
+ */
+export const createRuleFile: FileMethodHandler = async (controller: Controller, request: RuleFileRequest): Promise<RuleFile> => {
+	if (typeof request.isGlobal !== "boolean" || typeof request.filename !== "string" || !request.filename) {
+		console.error("createRuleFile: Missing or invalid parameters", {
+			isGlobal: typeof request.isGlobal === "boolean" ? request.isGlobal : `Invalid: ${typeof request.isGlobal}`,
+			filename: typeof request.filename === "string" ? request.filename : `Invalid: ${typeof request.filename}`,
+		})
+		throw new Error("Missing or invalid parameters")
+	}
+
+	const { filePath, fileExists } = await createRuleFileImpl(request.isGlobal, request.filename, cwd)
+
+	if (!filePath) {
+		throw new Error("Failed to create rule file.")
+	}
+
+	if (fileExists) {
+		vscode.window.showWarningMessage(`Rule file "${request.filename}" already exists.`)
+		// Still open it for editing
+		await handleFileServiceRequest(controller, "openFile", { value: filePath })
+	} else {
+		await refreshClineRulesToggles(controller.context, cwd)
+		await controller.postStateToWebview()
+
+		await handleFileServiceRequest(controller, "openFile", { value: filePath })
+
+		vscode.window.showInformationMessage(
+			`Created new ${request.isGlobal ? "global" : "workspace"} rule file: ${request.filename}`,
+		)
+	}
+
+	return RuleFile.create({
+		filePath: filePath,
+		displayName: path.basename(filePath),
+		alreadyExists: fileExists,
+	})
+}

src/core/controller/file/deleteRuleFile.ts

@@ -1,5 +1,5 @@
 import { Controller } from ".."
-import { DeleteRuleFileRequest, RuleFile } from "@shared/proto/file"
+import { RuleFileRequest, RuleFile } from "@shared/proto/file"
 import { FileMethodHandler } from "./index"
 import {
 	deleteRuleFile as deleteRuleFileImpl,
@@ -16,10 +16,7 @@ import { cwd } from "@core/task"
  * @returns Result with file path and display name
  * @throws Error if operation fails
  */
-export const deleteRuleFile: FileMethodHandler = async (
-	controller: Controller,
-	request: DeleteRuleFileRequest,
-): Promise<RuleFile> => {
+export const deleteRuleFile: FileMethodHandler = async (controller: Controller, request: RuleFileRequest): Promise<RuleFile> => {
 	if (typeof request.isGlobal !== "boolean" || typeof request.rulePath !== "string" || !request.rulePath) {
 		console.error("deleteRuleFile: Missing or invalid parameters", {
 			isGlobal: typeof request.isGlobal === "boolean" ? request.isGlobal : `Invalid: ${typeof request.isGlobal}`,
@@ -43,5 +40,6 @@ export const deleteRuleFile: FileMethodHandler = async (
 	return RuleFile.create({
 		filePath: request.rulePath,
 		displayName: fileName,
+		alreadyExists: false,
 	})
 }

src/core/controller/file/methods.ts

@@ -3,13 +3,15 @@
 
 // Import all method implementations
 import { registerMethod } from "./index"
+import { createRuleFile } from "./createRuleFile"
 import { deleteRuleFile } from "./deleteRuleFile"
 import { openFile } from "./openFile"
 import { openImage } from "./openImage"
 
 // Register all file service methods
 export function registerAllMethods(): void {
 	// Register each method with the registry
+	registerMethod("createRuleFile", createRuleFile)
 	registerMethod("deleteRuleFile", deleteRuleFile)
 	registerMethod("openFile", openFile)
 	registerMethod("openImage", openImage)

src/core/controller/index.ts

@@ -384,36 +384,6 @@ export class Controller {
 				break
 			case "fetchOpenGraphData":
 				this.fetchOpenGraphData(message.text!)
-				break
-			case "createRuleFile":
-				if (typeof message.isGlobal !== "boolean" || typeof message.filename !== "string" || !message.filename) {
-					console.error("createRuleFile: Missing or invalid parameters", {
-						isGlobal:
-							typeof message.isGlobal === "boolean" ? message.isGlobal : `Invalid: ${typeof message.isGlobal}`,
-						filename: typeof message.filename === "string" ? message.filename : `Invalid: ${typeof message.filename}`,
-					})
-					return
-				}
-				const { filePath, fileExists } = await createRuleFile(message.isGlobal, message.filename, cwd)
-				if (fileExists && filePath) {
-					vscode.window.showWarningMessage(`Rule file "${message.filename}" already exists.`)
-					// Still open it for editing
-					await handleFileServiceRequest(this, "openFile", { value: filePath })
-					return
-				} else if (filePath && !fileExists) {
-					await refreshClineRulesToggles(this.context, cwd)
-					await this.postStateToWebview()
-
-					await handleFileServiceRequest(this, "openFile", { value: filePath })
-
-					vscode.window.showInformationMessage(
-						`Created new ${message.isGlobal ? "global" : "workspace"} rule file: ${message.filename}`,
-					)
-				} else {
-					// null filePath
-					vscode.window.showErrorMessage(`Failed to create rule file.`)
-				}
-
 				break
 			case "openMention":
 				openMention(message.text)

src/shared/WebviewMessage.ts

@@ -24,7 +24,6 @@ export interface WebviewMessage {
 		| "requestOllamaModels"
 		| "requestLmStudioModels"
 		| "openInBrowser"
-		| "createRuleFile"
 		| "openMention"
 		| "showChatView"
 		| "refreshOpenRouterModels"

src/shared/proto-conversions/file.ts

@@ -0,0 +1,27 @@
+import { RuleFileRequest } from "../proto/file"
+
+/**
+ * Simplified clean interface for RuleFile requests
+ */
+
+// Helper for creating delete requests
+export const DeleteRuleFileRequest = {
+	create: (params: { rulePath: string; isGlobal: boolean; metadata?: any }): RuleFileRequest => {
+		return RuleFileRequest.create({
+			rulePath: params.rulePath,
+			isGlobal: params.isGlobal,
+			metadata: params.metadata,
+		})
+	},
+}
+
+// Helper for creating create requests
+export const CreateRuleFileRequest = {
+	create: (params: { filename: string; isGlobal: boolean; metadata?: any }): RuleFileRequest => {
+		return RuleFileRequest.create({
+			filename: params.filename,
+			isGlobal: params.isGlobal,
+			metadata: params.metadata,
+		})
+	},
+}

src/shared/proto-conversions/index.ts

@@ -0,0 +1 @@
+export * from "./file"