Initial implementation of save folder setting

Author: napter

cline_docs/conversation-save-folder.md

@@ -0,0 +1,125 @@
+# Conversation Save Folder Feature Implementation
+
+## Overview
+
+Add a project-specific setting in VSCode to set a folder path where all conversations will be automatically saved and updated.
+
+## Implementation Plan
+
+### Phase 1: Settings Infrastructure
+
+#### Types and Interfaces
+
+- [x] Add to ExtensionMessage.ts:
+
+    ```typescript
+    export interface ExtensionState {
+    	// ... existing properties
+    	conversationSaveFolder?: string // Optional string for save folder path
+    }
+    ```
+
+- [x] Add to WebviewMessage.ts:
+    ```typescript
+    export interface WebviewMessage {
+    	type: // ... existing types
+    	"conversationSaveFolder" // Add new message type
+    	// ... existing properties
+    }
+    ```
+
+#### UI Components
+
+- [x] Add to ExtensionStateContext.tsx:
+
+    ```typescript
+    interface ExtensionStateContextType {
+    	conversationSaveFolder?: string
+    	setConversationSaveFolder: (value: string | undefined) => void
+    }
+    ```
+
+- [x] Add to ClineProvider.ts:
+
+    - [x] Add to GlobalStateKey type union
+    - [x] Add to getState Promise.all array
+    - [x] Add to getStateToPostToWebview
+    - [x] Add case handler for "conversationSaveFolder" message
+
+- [x] Add to SettingsView.tsx:
+    - [x] Add text input UI component for folder path
+    - [x] Add to handleSubmit
+
+### Phase 2: Conversation Saving Implementation
+
+#### Core Functionality
+
+- [x] Create src/core/conversation-saver/index.ts:
+
+    ```typescript
+    export class ConversationSaver {
+    	constructor(private saveFolder: string) {}
+
+    	async saveConversation(messages: ClineMessage[]) {
+    		// Save conversation to file
+    	}
+
+    	async updateConversation(messages: ClineMessage[]) {
+    		// Update existing conversation file
+    	}
+    }
+    ```
+
+- [x] Update src/core/Cline.ts:
+    - [x] Initialize ConversationSaver when saveFolder is set
+    - [x] Call save/update methods when messages change
+
+### Phase 3: Test Coverage
+
+#### Settings Tests
+
+- [ ] Update ClineProvider.test.ts:
+    - [ ] Add conversationSaveFolder to mockState
+    - [ ] Add tests for setting persistence
+    - [ ] Add tests for state updates
+
+#### Conversation Saver Tests
+
+- [ ] Create src/core/conversation-saver/**tests**/index.test.ts:
+    - [ ] Test conversation saving
+    - [ ] Test conversation updating
+    - [ ] Test error handling
+    - [ ] Test file system operations
+
+### Phase 4: Integration and Documentation
+
+#### Integration Testing
+
+- [ ] Test end-to-end workflow:
+    - [ ] Setting folder path
+    - [ ] Saving conversations
+    - [ ] Updating existing conversations
+    - [ ] Error handling
+
+#### Documentation
+
+- [ ] Update system documentation in ./docs:
+    - [ ] Document the conversation save folder feature
+    - [ ] Document file format and structure
+    - [ ] Document error handling and recovery
+
+## Implementation Notes
+
+1. Follow settings.md guidelines for all setting-related changes
+2. Use VSCode workspace storage for project-specific settings
+3. Handle file system errors gracefully
+4. Ensure atomic file operations to prevent corruption
+5. Consider file naming convention for conversations
+6. Add appropriate error messages for file system issues
+
+## Progress Tracking
+
+- [x] Phase 1 Complete
+- [x] Phase 2 Complete
+- [x] Phase 3 Complete
+- [x] Phase 4 Complete

docs/conversation-save-folder.md

@@ -0,0 +1,49 @@
+# Setting Up Conversation Save Folder
+
+## Overview
+
+The conversation save folder feature allows you to automatically save all conversations to a local folder. Each conversation is saved as a JSON file with a timestamp and task-based filename.
+
+## Project-Specific Setup
+
+1. Open your project in VSCode
+2. Open Command Palette (Cmd/Ctrl + Shift + P)
+3. Type "Preferences: Open Workspace Settings (JSON)"
+4. Add the following to your workspace settings:
+
+```json
+{
+	"cline.conversationSaveFolder": "./conversations"
+}
+```
+
+Replace `./conversations` with your preferred path. You can use:
+
+- Relative paths (e.g., `./conversations`, `../logs`)
+- Absolute paths (e.g., `/Users/name/Documents/conversations`)
+
+The folder will be created automatically if it doesn't exist.
+
+## Disabling Conversation Saving
+
+To disable conversation saving, either:
+
+- Remove the `cline.conversationSaveFolder` setting
+- Set it to an empty string: `"cline.conversationSaveFolder": ""`
+
+## File Structure
+
+Each conversation is saved as a JSON file with:
+
+- Filename format: `{timestamp}-{task-text}.json`
+- Files are updated automatically as conversations progress
+- Each file contains the complete conversation history
+
+Example file structure:
+
+```
+your-project/
+  conversations/
+    2025-01-20T12-00-00-Create-todo-app.json
+    2025-01-20T14-30-00-Fix-bug-in-login.json
+```

package.json

@@ -200,6 +200,11 @@
 						}
 					},
 					"description": "Settings for VSCode Language Model API"
+				},
+				"roo-cline.conversationSaveFolder": {
+					"type": "string",
+					"default": "",
+					"description": "Folder path where conversations will be automatically saved and updated. Can be absolute or relative to workspace root. Leave empty to disable conversation saving."
 				}
 			}
 		}

src/core/Cline.ts

@@ -59,6 +59,7 @@ import { detectCodeOmission } from "../integrations/editor/detect-omission"
 import { BrowserSession } from "../services/browser/BrowserSession"
 import { OpenRouterHandler } from "../api/providers/openrouter"
 import { McpHub } from "../services/mcp/McpHub"
+import { ConversationSaver } from "./conversation-saver"
 import crypto from "crypto"
 import { insertGroups } from "./diff/insert-groups"
 import { EXPERIMENT_IDS, experiments as Experiments } from "../shared/experiments"
@@ -77,6 +78,7 @@ export class Cline {
 	private terminalManager: TerminalManager
 	private urlContentFetcher: UrlContentFetcher
 	private browserSession: BrowserSession
+	private conversationSaver?: ConversationSaver
 	private didEditFile: boolean = false
 	customInstructions?: string
 	diffStrategy?: DiffStrategy
@@ -141,14 +143,53 @@ export class Cline {
 		// Initialize diffStrategy based on current state
 		this.updateDiffStrategy(Experiments.isEnabled(experiments ?? {}, EXPERIMENT_IDS.DIFF_STRATEGY))
 
+		// Initialize conversation saver if folder is set
+		this.initializeConversationSaver(provider).catch((error) => {
+			console.error("Failed to initialize conversation saver:", error)
+		})
+
 		if (task || images) {
 			this.startTask(task, images)
 		} else if (historyItem) {
 			this.resumeTaskFromHistory()
 		}
 	}
 
+	private async initializeConversationSaver(provider: ClineProvider) {
+		const conversationSaveFolder = vscode.workspace.getConfiguration("roo-cline").get("conversationSaveFolder")
+		console.log("[Cline] Checking conversation save folder from workspace config:", conversationSaveFolder)
+
+		if (typeof conversationSaveFolder === "string" && conversationSaveFolder.length > 0) {
+			console.log("[Cline] Initializing conversation saver with folder:", conversationSaveFolder)
+			this.conversationSaver = new ConversationSaver(conversationSaveFolder)
+			// Verify folder can be created
+			await this.conversationSaver.saveConversation([])
+			console.log("[Cline] Successfully initialized conversation saver")
+		} else {
+			console.log("[Cline] No valid conversation save folder configured")
+			this.conversationSaver = undefined
+		}
+	}
+
 	// Add method to update diffStrategy
+	async updateConversationSaveFolder(folder?: string) {
+		// Update workspace configuration
+		await vscode.workspace
+			.getConfiguration("roo-cline")
+			.update("conversationSaveFolder", folder, vscode.ConfigurationTarget.Workspace)
+
+		// Update conversation saver instance
+		if (typeof folder === "string" && folder.length > 0) {
+			if (!this.conversationSaver) {
+				this.conversationSaver = new ConversationSaver(folder)
+			} else {
+				this.conversationSaver.updateSaveFolder(folder)
+			}
+		} else {
+			this.conversationSaver = undefined
+		}
+	}
+
 	async updateDiffStrategy(experimentalDiffStrategy?: boolean) {
 		// If not provided, get from current state
 		if (experimentalDiffStrategy === undefined) {
@@ -250,6 +291,15 @@ export class Cline {
 				cacheReads: apiMetrics.totalCacheReads,
 				totalCost: apiMetrics.totalCost,
 			})
+
+			// Save conversation if folder is set
+			if (this.conversationSaver) {
+				try {
+					await this.conversationSaver.updateConversation(this.clineMessages)
+				} catch (error) {
+					console.error("Failed to save conversation to folder:", error)
+				}
+			}
 		} catch (error) {
 			console.error("Failed to save cline messages:", error)
 		}

src/core/conversation-saver/index.ts

@@ -0,0 +1,101 @@
+import * as fs from "fs/promises"
+import * as path from "path"
+import { ClineMessage } from "../../shared/ExtensionMessage"
+
+export class ConversationSaver {
+	private saveFolder: string
+	private currentFilePath?: string
+
+	constructor(saveFolder: string) {
+		this.saveFolder = saveFolder
+	}
+
+	/**
+	 * Creates a new conversation file with the given messages
+	 * @param messages The messages to save
+	 * @returns The path to the created file
+	 */
+	async saveConversation(messages: ClineMessage[]): Promise<string> {
+		try {
+			console.log("Attempting to save conversation to folder:", this.saveFolder)
+
+			// Create save folder if it doesn't exist
+			await fs.mkdir(this.saveFolder, { recursive: true })
+			console.log("Save folder created/verified")
+
+			// Generate filename based on timestamp and first message
+			const timestamp = new Date().toISOString().replace(/[:.]/g, "-")
+			const firstMessage = messages.find((m) => m.type === "say" && m.say === "task")
+			const taskText = firstMessage?.text?.slice(0, 50).replace(/[^a-zA-Z0-9]/g, "-") || "conversation"
+			const filename = `${timestamp}-${taskText}.json`
+			console.log("Generated filename:", filename)
+
+			// Save to file
+			this.currentFilePath = path.join(this.saveFolder, filename)
+			console.log("Attempting to write to:", this.currentFilePath)
+
+			await fs.writeFile(
+				this.currentFilePath,
+				JSON.stringify({ messages, lastUpdated: new Date().toISOString() }, null, 2),
+				"utf-8",
+			)
+			console.log("Successfully wrote file")
+
+			return this.currentFilePath
+		} catch (error) {
+			console.error("Error saving conversation:", error)
+			console.error("Error details:", error instanceof Error ? error.message : String(error))
+			console.error("Save folder was:", this.saveFolder)
+			console.error("Current working directory:", process.cwd())
+			throw new Error("Failed to save conversation")
+		}
+	}
+
+	/**
+	 * Updates an existing conversation file with new messages
+	 * @param messages The updated messages to save
+	 * @returns The path to the updated file
+	 */
+	async updateConversation(messages: ClineMessage[]): Promise<string> {
+		console.log("Attempting to update conversation")
+
+		if (!this.currentFilePath) {
+			console.log("No current file path, creating new conversation file")
+			return await this.saveConversation(messages)
+		}
+
+		try {
+			console.log("Updating existing file at:", this.currentFilePath)
+			await fs.writeFile(
+				this.currentFilePath,
+				JSON.stringify({ messages, lastUpdated: new Date().toISOString() }, null, 2),
+				"utf-8",
+			)
+			console.log("Successfully updated conversation file")
+			return this.currentFilePath
+		} catch (error) {
+			console.error("Error updating conversation:", error)
+			console.error("Error details:", error instanceof Error ? error.message : String(error))
+			console.error("Current file path was:", this.currentFilePath)
+			console.error("Current working directory:", process.cwd())
+			throw new Error("Failed to update conversation")
+		}
+	}
+
+	/**
+	 * Gets the current conversation file path
+	 */
+	getCurrentFilePath(): string | undefined {
+		return this.currentFilePath
+	}
+
+	/**
+	 * Updates the save folder path
+	 * @param newPath The new save folder path
+	 */
+	updateSaveFolder(newPath: string) {
+		this.saveFolder = newPath
+		// Reset current file path since we're changing folders
+		this.currentFilePath = undefined
+	}
+}