feat(scm): add commit message generator service

Author: Mirrowel

packages/types/src/global-settings.ts

@@ -23,6 +23,32 @@ import { languagesSchema } from "./vscode.js"
  */
 export const DEFAULT_WRITE_DELAY_MS = 1000
 
+export const commitMessageGitContextSchema = z.object({
+	diffContextLines: z.number().int().min(0).max(20).optional(),
+	includeDiffStats: z.boolean().optional(),
+	includeCurrentBranch: z.boolean().optional(),
+	includeRecentCommits: z.boolean().optional(),
+	recentCommitCount: z.number().int().min(1).max(20).optional(),
+	includeRecentCommitBodies: z.boolean().optional(),
+	includeRecentCommitStats: z.boolean().optional(),
+	includeRecentCommitDiffs: z.boolean().optional(),
+	recentCommitDiffCount: z.number().int().min(1).max(5).optional(),
+})
+
+export type CommitMessageGitContextSettings = z.infer<typeof commitMessageGitContextSchema>
+
+export const defaultCommitMessageGitContextSettings: Required<CommitMessageGitContextSettings> = {
+	diffContextLines: 3,
+	includeDiffStats: true,
+	includeCurrentBranch: true,
+	includeRecentCommits: true,
+	recentCommitCount: 5,
+	includeRecentCommitBodies: false,
+	includeRecentCommitStats: false,
+	includeRecentCommitDiffs: false,
+	recentCommitDiffCount: 1,
+}
+
 /**
  * Terminal output preview size options for persisted command output.
  *
@@ -232,6 +258,9 @@ export const globalSettingsSchema = z.object({
 	 * Tools in this list will be excluded from prompt generation and rejected at execution time.
 	 */
 	disabledTools: z.array(toolNamesSchema).optional(),
+
+	commitMessageApiConfigId: z.string().optional(),
+	commitMessageGitContext: commitMessageGitContextSchema.optional(),
 })
 
 export type GlobalSettings = z.infer<typeof globalSettingsSchema>

packages/types/src/telemetry.ts

@@ -74,6 +74,8 @@ export enum TelemetryEventName {
 	TELEMETRY_SETTINGS_CHANGED = "Telemetry Settings Changed",
 	MODEL_CACHE_EMPTY_RESPONSE = "Model Cache Empty Response",
 	READ_FILE_LEGACY_FORMAT_USED = "Read File Legacy Format Used",
+
+	COMMIT_MSG_GENERATED = "Commit Message Generated",
 }
 
 /**
@@ -206,6 +208,7 @@ export const rooCodeTelemetryEventSchema = z.discriminatedUnion("type", [
 			TelemetryEventName.MODE_SETTINGS_CHANGED,
 			TelemetryEventName.CUSTOM_MODE_CREATED,
 			TelemetryEventName.READ_FILE_LEGACY_FORMAT_USED,
+			TelemetryEventName.COMMIT_MSG_GENERATED,
 		]),
 		properties: telemetryPropertiesSchema,
 	}),

src/services/commit-message/CommitMessageGenerator.ts

@@ -0,0 +1,199 @@
+import { ContextProxy } from "../../core/config/ContextProxy"
+import { ProviderSettingsManager } from "../../core/config/ProviderSettingsManager"
+import { singleCompletionHandler as defaultSingleCompletionHandler } from "../../utils/single-completion-handler"
+import { supportPrompt } from "../../shared/support-prompt"
+import { addCustomInstructions as defaultAddCustomInstructions } from "../../core/prompts/sections/custom-instructions"
+import { TelemetryService } from "@roo-code/telemetry"
+import { TelemetryEventName, type ProviderSettings } from "@roo-code/types"
+
+import { GenerateMessageParams, PromptOptions, ProgressUpdate } from "./types/core"
+
+export interface CommitMessageContextProxy {
+	isInitialized: boolean
+	getProviderSettings(): ProviderSettings
+	getValue(key: any): unknown
+}
+
+export interface CommitMessageGeneratorDependencies {
+	getContextProxy?: () => CommitMessageContextProxy
+	completePrompt?: (apiConfiguration: ProviderSettings, promptText: string) => Promise<string>
+	addCustomInstructions?: typeof defaultAddCustomInstructions
+	captureGenerated?: () => void
+	logger?: Pick<Console, "warn">
+}
+
+export class CommitMessageGenerator {
+	private readonly providerSettingsManager: ProviderSettingsManager
+	private readonly dependencies: Required<CommitMessageGeneratorDependencies>
+	private previousGitContext: string | null = null
+	private previousCommitMessage: string | null = null
+
+	constructor(
+		providerSettingsManager: ProviderSettingsManager,
+		dependencies: CommitMessageGeneratorDependencies = {},
+	) {
+		this.providerSettingsManager = providerSettingsManager
+		this.dependencies = {
+			getContextProxy: dependencies.getContextProxy ?? (() => ContextProxy.instance),
+			completePrompt: dependencies.completePrompt ?? defaultSingleCompletionHandler,
+			addCustomInstructions: dependencies.addCustomInstructions ?? defaultAddCustomInstructions,
+			captureGenerated:
+				dependencies.captureGenerated ??
+				(() => TelemetryService.instance.captureEvent(TelemetryEventName.COMMIT_MSG_GENERATED)),
+			logger: dependencies.logger ?? console,
+		}
+	}
+
+	async generateMessage(params: GenerateMessageParams): Promise<string> {
+		const { gitContext, onProgress } = params
+
+		try {
+			onProgress?.({
+				message: "Generating commit message...",
+				percentage: 75,
+			})
+
+			const generatedMessage = await this.callAIForCommitMessage(gitContext, params.workspacePath, onProgress)
+
+			this.previousGitContext = gitContext
+			this.previousCommitMessage = generatedMessage
+
+			this.dependencies.captureGenerated()
+
+			onProgress?.({
+				message: "Commit message generated successfully",
+				percentage: 100,
+			})
+
+			return generatedMessage
+		} catch (error) {
+			const errorMessage = error instanceof Error ? error.message : "Unknown error occurred"
+			throw new Error(`Failed to generate commit message: ${errorMessage}`)
+		}
+	}
+
+	async buildPrompt(gitContext: string, options: PromptOptions, workspacePath: string): Promise<string> {
+		const { customSupportPrompts = {}, previousContext, previousMessage } = options
+
+		const customInstructions = await this.dependencies.addCustomInstructions("", "", workspacePath, "commit", {
+			language: "en",
+		})
+
+		const shouldGenerateDifferentMessage =
+			(previousContext === gitContext || this.previousGitContext === gitContext) &&
+			(previousMessage !== null || this.previousCommitMessage !== null)
+
+		const targetPreviousMessage = previousMessage || this.previousCommitMessage
+
+		if (shouldGenerateDifferentMessage && targetPreviousMessage) {
+			const differentMessagePrefix = `# CRITICAL INSTRUCTION: GENERATE A COMPLETELY DIFFERENT COMMIT MESSAGE
+The user has requested a new commit message for the same changes.
+The previous message was: "${targetPreviousMessage}"
+YOU MUST create a message that is COMPLETELY DIFFERENT by:
+- Using entirely different wording and phrasing
+- Focusing on different aspects of the changes
+- Using a different structure or format if appropriate
+- Possibly using a different type or scope if justifiable
+This is the MOST IMPORTANT requirement for this task.
+
+`
+			const baseTemplate = supportPrompt.get(customSupportPrompts, "COMMIT_MESSAGE")
+			const modifiedTemplate =
+				differentMessagePrefix +
+				baseTemplate +
+				`
+
+FINAL REMINDER: Your message MUST be COMPLETELY DIFFERENT from the previous message: "${targetPreviousMessage}". This is a critical requirement.`
+
+			return supportPrompt.create(
+				"COMMIT_MESSAGE",
+				{
+					gitContext,
+					customInstructions: customInstructions || "",
+				},
+				{
+					...customSupportPrompts,
+					COMMIT_MESSAGE: modifiedTemplate,
+				},
+			)
+		} else {
+			return supportPrompt.create(
+				"COMMIT_MESSAGE",
+				{
+					gitContext,
+					customInstructions: customInstructions || "",
+				},
+				customSupportPrompts,
+			)
+		}
+	}
+
+	private async callAIForCommitMessage(
+		gitContextString: string,
+		workspacePath: string,
+		onProgress?: (progress: ProgressUpdate) => void,
+	): Promise<string> {
+		const contextProxy = this.dependencies.getContextProxy()
+		if (!contextProxy.isInitialized) {
+			throw new Error("ContextProxy not initialized. Please try again after the extension has fully loaded.")
+		}
+		const apiConfiguration = contextProxy.getProviderSettings()
+		const commitMessageApiConfigId = contextProxy.getValue("commitMessageApiConfigId") as string | undefined
+		const listApiConfigMeta = (contextProxy.getValue("listApiConfigMeta") || []) as Array<{ id: string }>
+		const customSupportPrompts = (contextProxy.getValue("customSupportPrompts") || {}) as Record<
+			string,
+			string | undefined
+		>
+
+		let configToUse: ProviderSettings = apiConfiguration
+
+		if (commitMessageApiConfigId && listApiConfigMeta.find(({ id }) => id === commitMessageApiConfigId)) {
+			try {
+				await this.providerSettingsManager.initialize()
+				const { name: _, ...providerSettings } = await this.providerSettingsManager.getProfile({
+					id: commitMessageApiConfigId,
+				})
+
+				if (providerSettings.apiProvider) {
+					configToUse = providerSettings
+				}
+			} catch (error) {
+				this.dependencies.logger.warn(
+					`Failed to load commit message API profile ${commitMessageApiConfigId}; falling back to current API configuration`,
+					error,
+				)
+			}
+		}
+
+		const filteredPrompts = Object.fromEntries(
+			Object.entries(customSupportPrompts).filter(([_, value]) => value !== undefined),
+		) as Record<string, string>
+
+		const prompt = await this.buildPrompt(
+			gitContextString,
+			{ customSupportPrompts: filteredPrompts },
+			workspacePath,
+		)
+
+		onProgress?.({
+			message: "Calling AI service...",
+			increment: 10,
+		})
+
+		const response = await this.dependencies.completePrompt(configToUse, prompt)
+
+		onProgress?.({
+			message: "Processing AI response...",
+			increment: 10,
+		})
+
+		return this.extractCommitMessage(response)
+	}
+
+	private extractCommitMessage(response: string): string {
+		const cleaned = response.trim()
+		const withoutCodeBlocks = cleaned.replace(/```[a-z]*\n|```/g, "")
+		const withoutQuotes = withoutCodeBlocks.replace(/^["'`]|["'`]$/g, "")
+		return withoutQuotes.trim()
+	}
+}

src/services/commit-message/__tests__/CommitMessageGeneration.integration.spec.ts

@@ -0,0 +1,80 @@
+import * as os from "os"
+import * as path from "path"
+import { execFile } from "child_process"
+import { promisify } from "util"
+import { promises as fs } from "fs"
+import type { ProviderSettings } from "@roo-code/types"
+
+import { GitContextCollector } from "../../git-context"
+import { CommitMessageGenerator } from "../CommitMessageGenerator"
+
+const execFileAsync = promisify(execFile)
+
+async function runGit(cwd: string, args: string[]) {
+	await execFileAsync("git", args, { cwd })
+}
+
+describe("commit message generation flow", () => {
+	const defaultConfig: ProviderSettings = { apiProvider: "openai", openAiApiKey: "default-key" }
+	const providerSettingsManager = {
+		initialize: vi.fn(),
+		getProfile: vi.fn(),
+	}
+	const contextProxy = {
+		isInitialized: true,
+		getProviderSettings: vi.fn(() => defaultConfig),
+		getValue: vi.fn((key: string) => {
+			switch (key) {
+				case "listApiConfigMeta":
+					return []
+				case "customSupportPrompts":
+					return {}
+				default:
+					return undefined
+			}
+		}),
+	}
+
+	beforeEach(() => {
+		vi.clearAllMocks()
+	})
+
+	it("passes collected git context with untracked file diff to the LLM", async () => {
+		const tempRoot = await fs.mkdtemp(path.join(os.tmpdir(), "zoo-commit-generation-"))
+		try {
+			await runGit(tempRoot, ["init"])
+			const filePath = path.join(tempRoot, "src", "new.ts")
+			await fs.mkdir(path.dirname(filePath), { recursive: true })
+			await fs.writeFile(filePath, "export const value = 1\n")
+
+			const gitContext = await new GitContextCollector(tempRoot).collect({
+				staged: false,
+				includeBranch: false,
+				recentCommits: { include: false },
+			})
+			const completePrompt = vi.fn().mockResolvedValue("feat(src): add new module")
+			const generator = new CommitMessageGenerator(providerSettingsManager as any, {
+				getContextProxy: () => contextProxy,
+				completePrompt,
+				addCustomInstructions: vi.fn().mockResolvedValue(""),
+				captureGenerated: vi.fn(),
+			})
+
+			const message = await generator.generateMessage({
+				workspacePath: tempRoot,
+				selectedFiles: gitContext.changes.map((change) => change.filePath),
+				gitContext: gitContext.context,
+			})
+
+			expect(message).toBe("feat(src): add new module")
+			expect(gitContext.context).toContain("diff --git a/src/new.ts b/src/new.ts")
+			expect(gitContext.context).toContain("+export const value = 1")
+			expect(completePrompt).toHaveBeenCalledWith(
+				defaultConfig,
+				expect.stringContaining("+export const value = 1"),
+			)
+		} finally {
+			await fs.rm(tempRoot, { recursive: true, force: true })
+		}
+	})
+})