fix(scm): 🐛 address commit message settings review feedback

Author: Mirrowel

packages/types/src/global-settings.ts

@@ -23,6 +23,7 @@ import { languagesSchema } from "./vscode.js"
  */
 export const DEFAULT_WRITE_DELAY_MS = 1000
 
+/** Schema for optional Git context included with generated commit message prompts. */
 export const commitMessageGitContextSchema = z.object({
 	diffContextLines: z.number().int().min(0).max(20).optional(),
 	includeDiffStats: z.boolean().optional(),
@@ -37,6 +38,7 @@ export const commitMessageGitContextSchema = z.object({
 
 export type CommitMessageGitContextSettings = z.infer<typeof commitMessageGitContextSchema>
 
+/** Default Git context options for commit message generation. */
 export const defaultCommitMessageGitContextSettings: Required<CommitMessageGitContextSettings> = {
 	diffContextLines: 3,
 	includeDiffStats: true,
@@ -49,23 +51,30 @@ export const defaultCommitMessageGitContextSettings: Required<CommitMessageGitCo
 	recentCommitDiffCount: 1,
 }
 
+/** Default attribution template appended to generated commit messages when enabled. */
 export const DEFAULT_COMMIT_MESSAGE_ATTRIBUTION_TEMPLATE = "Assisted-by: ${agentName}:${providerModel} [${toolName}]"
 
+/** Schema for the optional attribution footer appended to generated commit messages. */
 export const commitMessageAttributionSchema = z.object({
 	enabled: z.boolean().optional(),
 	template: z.string().optional(),
 })
 
 export type CommitMessageAttributionSettings = z.infer<typeof commitMessageAttributionSchema>
 
+/** Default attribution settings for commit message generation. */
 export const defaultCommitMessageAttributionSettings: Required<CommitMessageAttributionSettings> = {
 	enabled: false,
 	template: DEFAULT_COMMIT_MESSAGE_ATTRIBUTION_TEMPLATE,
 }
 
+/** Maximum number of named commit-message profiles users can store. */
 export const MAX_COMMIT_MESSAGE_PROFILES = 5
+
+/** Stable id used by the synthesized default commit-message profile. */
 export const DEFAULT_COMMIT_MESSAGE_PROFILE_ID = "default"
 
+/** Schema for one named commit-message generation profile. */
 export const commitMessageProfileSchema = z.object({
 	id: z.string().optional(),
 	name: z.string().optional(),
@@ -75,6 +84,7 @@ export const commitMessageProfileSchema = z.object({
 	attribution: commitMessageAttributionSchema.optional(),
 })
 
+/** Schema for persisted commit-message profile settings. */
 export const commitMessageProfilesSchema = z.object({
 	activeProfileId: z.string().optional(),
 	profiles: z.array(commitMessageProfileSchema).max(MAX_COMMIT_MESSAGE_PROFILES).optional(),
@@ -83,6 +93,7 @@ export const commitMessageProfilesSchema = z.object({
 export type CommitMessageProfileSettings = z.infer<typeof commitMessageProfileSchema>
 export type CommitMessageProfilesSettings = z.infer<typeof commitMessageProfilesSchema>
 
+/** Fully-normalized commit-message profile used by runtime code and UI controls. */
 export type NormalizedCommitMessageProfile = Omit<
 	CommitMessageProfileSettings,
 	"id" | "name" | "gitContext" | "attribution"
@@ -94,17 +105,25 @@ export type NormalizedCommitMessageProfile = Omit<
 }
 
 export interface NormalizedCommitMessageProfiles {
+	/** Id of the profile currently selected for generation. */
 	activeProfileId: string
+	/** Normalized profiles available for generation. */
 	profiles: NormalizedCommitMessageProfile[]
 }
 
+/** Legacy single-profile settings used when named profiles are not stored yet. */
 export interface CommitMessageProfileFallbackSettings {
+	/** Optional custom prompt from the legacy support prompt setting. */
 	prompt?: string
+	/** Optional API configuration id from the legacy single-profile setting. */
 	apiConfigId?: string
+	/** Optional Git context settings from the legacy single-profile setting. */
 	gitContext?: CommitMessageGitContextSettings
+	/** Optional attribution settings from the legacy single-profile setting. */
 	attribution?: CommitMessageAttributionSettings
 }
 
+/** Normalizes Git context settings and clamps numeric options to supported bounds. */
 export function normalizeCommitMessageGitContextSettings(
 	settings?: CommitMessageGitContextSettings,
 ): Required<CommitMessageGitContextSettings> {
@@ -132,6 +151,7 @@ export function normalizeCommitMessageGitContextSettings(
 	}
 }
 
+/** Normalizes attribution settings and restores the default template when needed. */
 export function normalizeCommitMessageAttributionSettings(
 	settings?: CommitMessageAttributionSettings,
 ): Required<CommitMessageAttributionSettings> {
@@ -142,6 +162,7 @@ export function normalizeCommitMessageAttributionSettings(
 	}
 }
 
+/** Normalizes persisted profiles or creates a default profile from fallback settings. */
 export function normalizeCommitMessageProfiles(
 	settings?: CommitMessageProfilesSettings,
 	fallback: CommitMessageProfileFallbackSettings = {},
@@ -179,6 +200,7 @@ export function normalizeCommitMessageProfiles(
 	}
 }
 
+/** Returns the active normalized commit-message profile. */
 export function getActiveCommitMessageProfile(
 	settings?: CommitMessageProfilesSettings,
 	fallback?: CommitMessageProfileFallbackSettings,
@@ -187,10 +209,12 @@ export function getActiveCommitMessageProfile(
 	return normalized.profiles.find((profile) => profile.id === normalized.activeProfileId) ?? normalized.profiles[0]!
 }
 
+/** Creates a locally unique id for a new commit-message profile. */
 export function createCommitMessageProfileId(): string {
 	return `profile-${Date.now().toString(36)}-${Math.random().toString(36).slice(2, 8)}`
 }
 
+/** Creates the next available display name for a new commit-message profile. */
 export function createCommitMessageProfileName(profiles: Array<{ name?: string }>): string {
 	for (let index = profiles.length + 1; index <= MAX_COMMIT_MESSAGE_PROFILES + 1; index++) {
 		const candidate = `Profile ${index}`

src/i18n/locales/hi/common.json

@@ -53,7 +53,7 @@ describe("commit message profile settings", () => {
 		expect(settings.activeProfileId).toBe("profile-1")
 	})
 
-	it("merges default Git context settings for each profile", () => {
+	it("clamps recent commit diff count while merging default Git context settings", () => {
 		const contextProxy = createContextProxy({
 			commitMessageProfiles: {
 				activeProfileId: "detailed",

src/services/commit-message/__tests__/profileSettings.spec.ts

@@ -10,13 +10,19 @@ const ATTRIBUTION_TOOL_NAME = "Zoo Code"
 const UNKNOWN_VALUE = "unknown"
 
 export interface CommitMessageAttributionTemplateValues {
+	/** Name of the AI agent that assisted with the commit message. */
 	agentName: string
+	/** Name of the tool that produced the commit message. */
 	toolName: string
+	/** Provider key used for generation. */
 	provider: string
+	/** Model identifier used for generation. */
 	model: string
+	/** Combined provider/model value for compact templates. */
 	providerModel: string
 }
 
+/** Creates the attribution footer for a generated commit message when enabled. */
 export function createCommitMessageAttribution(
 	settings: CommitMessageAttributionSettings | undefined,
 	apiConfiguration: ProviderSettings,
@@ -38,6 +44,7 @@ export function createCommitMessageAttribution(
 	})
 }
 
+/** Replaces supported attribution placeholders with concrete generation metadata. */
 export function applyCommitMessageAttributionTemplate(
 	template: string,
 	values: CommitMessageAttributionTemplateValues,
@@ -48,6 +55,7 @@ export function applyCommitMessageAttributionTemplate(
 	)
 }
 
+/** Appends attribution once, preserving messages that already include the same footer. */
 export function appendCommitMessageAttribution(message: string, attribution: string): string {
 	const cleanedMessage = message.trim()
 	const cleanedAttribution = attribution.trim()

src/services/commit-message/attribution.ts

@@ -1,4 +1,4 @@
-import { normalizeCommitMessageGitContextSettings, type CommitMessageGitContextSettings } from "@roo-code/types"
+import { type CommitMessageGitContextSettings } from "@roo-code/types"
 
 import type { GitContextCollectorOptions } from "../git-context"
 import { getActiveCommitMessageProfileSettings } from "./profileSettings"

src/services/commit-message/gitContextSettings.ts

@@ -10,10 +10,13 @@ export function registerCommitMessageProvider(
 	const commitProvider = new CommitMessageProvider(context, outputChannel)
 	context.subscriptions.push(commitProvider)
 
-	commitProvider.activate().catch((error) => {
-		outputChannel.appendLine(t("common:commitMessage.activationFailed", { error: error.message }))
-		console.error("Commit message provider activation failed:", error)
-	})
-
-	outputChannel.appendLine(t("common:commitMessage.providerRegistered"))
+	commitProvider
+		.activate()
+		.then(() => {
+			outputChannel.appendLine(t("common:commitMessage.providerRegistered"))
+		})
+		.catch((error) => {
+			outputChannel.appendLine(t("common:commitMessage.activationFailed", { error: error.message }))
+			console.error("Commit message provider activation failed:", error)
+		})
 }

src/services/commit-message/index.ts

@@ -11,9 +11,11 @@ import {
 import { ContextProxy } from "../../core/config/ContextProxy"
 
 export interface CommitMessageProfileContextProxy {
+	/** Reads persisted extension setting values by key. */
 	getValue(key: any): unknown
 }
 
+/** Reads all commit-message profiles, normalized with legacy single-profile fallbacks. */
 export function getCommitMessageProfileSettings(
 	contextProxy: CommitMessageProfileContextProxy = ContextProxy.instance,
 ): NormalizedCommitMessageProfiles {
@@ -23,6 +25,7 @@ export function getCommitMessageProfileSettings(
 	)
 }
 
+/** Reads the active commit-message profile for generator/provider runtime decisions. */
 export function getActiveCommitMessageProfileSettings(
 	contextProxy: CommitMessageProfileContextProxy = ContextProxy.instance,
 ): NormalizedCommitMessageProfile {
@@ -32,12 +35,14 @@ export function getActiveCommitMessageProfileSettings(
 	)
 }
 
+/** Reads the raw persisted commit-message profiles object if present. */
 function readCommitMessageProfiles(
 	contextProxy: CommitMessageProfileContextProxy,
 ): CommitMessageProfilesSettings | undefined {
 	return contextProxy.getValue("commitMessageProfiles") as CommitMessageProfilesSettings | undefined
 }
 
+/** Reads legacy single-profile settings used to synthesize the default profile. */
 function readSingleProfileFallback(contextProxy: CommitMessageProfileContextProxy) {
 	const customSupportPrompts = (contextProxy.getValue("customSupportPrompts") || {}) as Record<
 		string,

src/services/commit-message/profileSettings.ts

@@ -251,7 +251,11 @@ describe("CommitMessagePromptSettings", () => {
 			/>,
 		)
 
-		fireEvent.click(screen.getAllByRole("checkbox")[3])
+		fireEvent.click(
+			screen.getByRole("checkbox", {
+				name: /supportPrompts\.commitMessage\.gitContext\.includeRecentCommitBodies/i,
+			}),
+		)
 
 		expect(setCommitMessageProfiles).toHaveBeenCalledWith({
 			activeProfileId: "release",