feat: add git status to environment details

daniel-lxs · daniel-lxs · commit 3600b64638ca · 2025-11-17T10:50:50.000-05:00
- Add getGitStatus() function that returns raw git status output
- Truncate git status to 20 lines to prevent context bloat
- Only show section headers (Visible Files, Open Tabs) when content exists
- Add comprehensive tests for git status functionality
- All tests passing (43 git tests, 15 environment tests)
diff --git a/src/core/environment/__tests__/getEnvironmentDetails.spec.ts b/src/core/environment/__tests__/getEnvironmentDetails.spec.ts
@@ -143,8 +143,7 @@ describe("getEnvironmentDetails", () => {
 
 		expect(result).toContain("<environment_details>")
 		expect(result).toContain("</environment_details>")
-		expect(result).toContain("# VSCode Visible Files")
-		expect(result).toContain("# VSCode Open Tabs")
+		// Visible Files and Open Tabs headers only appear when there's content
 		expect(result).toContain("# Current Time")
 		expect(result).toContain("# Current Cost")
 		expect(result).toContain("# Current Mode")
diff --git a/src/core/environment/getEnvironmentDetails.ts b/src/core/environment/getEnvironmentDetails.ts
@@ -17,6 +17,7 @@ import { TerminalRegistry } from "../../integrations/terminal/TerminalRegistry"
 import { Terminal } from "../../integrations/terminal/Terminal"
 import { arePathsEqual } from "../../utils/path"
 import { formatResponse } from "../prompts/responses"
+import { getGitStatus } from "../../utils/git"
 
 import { Task } from "../task/Task"
 import { formatReminderSection } from "./reminder"
@@ -34,8 +35,6 @@ export async function getEnvironmentDetails(cline: Task, includeFileDetails: boo
 
 	// It could be useful for cline to know if the user went from one or no
 	// file to another between messages, so we always include this context.
-	details += "\n\n# VSCode Visible Files"
-
 	const visibleFilePaths = vscode.window.visibleTextEditors
 		?.map((editor) => editor.document?.uri?.fsPath)
 		.filter(Boolean)
@@ -48,12 +47,10 @@ export async function getEnvironmentDetails(cline: Task, includeFileDetails: boo
 		: visibleFilePaths.map((p) => p.toPosix()).join("\n")
 
 	if (allowedVisibleFiles) {
+		details += "\n\n# VSCode Visible Files"
 		details += `\n${allowedVisibleFiles}`
-	} else {
-		details += "\n(No visible files)"
 	}
 
-	details += "\n\n# VSCode Open Tabs"
 	const { maxOpenTabsContext } = state ?? {}
 	const maxTabs = maxOpenTabsContext ?? 20
 	const openTabPaths = vscode.window.tabGroups.all
@@ -70,9 +67,8 @@ export async function getEnvironmentDetails(cline: Task, includeFileDetails: boo
 		: openTabPaths.map((p) => p.toPosix()).join("\n")
 
 	if (allowedOpenTabs) {
+		details += "\n\n# VSCode Open Tabs"
 		details += `\n${allowedOpenTabs}`
-	} else {
-		details += "\n(No open tabs)"
 	}
 
 	// Get task-specific and background terminals.
@@ -205,6 +201,12 @@ export async function getEnvironmentDetails(cline: Task, includeFileDetails: boo
 		details += `\n\n# Current Time\nCurrent time in ISO 8601 UTC format: ${now.toISOString()}\nUser time zone: ${timeZone}, UTC${timeZoneOffsetStr}`
 	}
 
+	// Add git status information
+	const gitStatus = await getGitStatus(cline.cwd)
+	if (gitStatus) {
+		details += `\n\n# Git Status\n${gitStatus}`
+	}
+
 	// Add context tokens information (if enabled).
 	if (includeCurrentCost) {
 		const { totalCost } = getApiMetrics(cline.clineMessages)
diff --git a/src/utils/__tests__/git.spec.ts b/src/utils/__tests__/git.spec.ts
@@ -12,6 +12,7 @@ import {
 	extractRepositoryName,
 	getWorkspaceGitInfo,
 	convertGitUrlToHttps,
+	getGitStatus,
 } from "../git"
 import { truncateOutput } from "../../integrations/misc/extract-text"
 
@@ -834,3 +835,131 @@ describe("getWorkspaceGitInfo", () => {
 		expect(readFileSpy).toHaveBeenCalled()
 	})
 })
+
+describe("getGitStatus", () => {
+	const cwd = "/test/path"
+
+	beforeEach(() => {
+		vitest.clearAllMocks()
+	})
+
+	it("should return git status output", async () => {
+		const mockOutput = `## main...origin/main [ahead 2, behind 1]
+M  src/staged-file.ts
+ M src/unstaged-file.ts
+MM src/both-modified.ts
+?? src/untracked-file.ts`
+
+		const responses = new Map([
+			["git --version", { stdout: "git version 2.39.2", stderr: "" }],
+			["git rev-parse --git-dir", { stdout: ".git", stderr: "" }],
+			["git status --porcelain=v1 --branch", { stdout: mockOutput, stderr: "" }],
+		])
+
+		vitest.mocked(exec).mockImplementation((command: string, options: any, callback: any) => {
+			for (const [cmd, response] of responses) {
+				if (command === cmd) {
+					callback(null, response)
+					return {} as any
+				}
+			}
+			callback(new Error("Unexpected command"))
+			return {} as any
+		})
+
+		const result = await getGitStatus(cwd)
+
+		expect(result).toBe(mockOutput)
+	})
+
+	it("should return null when git is not installed", async () => {
+		vitest.mocked(exec).mockImplementation((command: string, options: any, callback: any) => {
+			if (command === "git --version") {
+				callback(new Error("git not found"))
+				return {} as any
+			}
+			callback(new Error("Unexpected command"))
+			return {} as any
+		})
+
+		const result = await getGitStatus(cwd)
+		expect(result).toBeNull()
+	})
+
+	it("should return null when not in a git repository", async () => {
+		const responses = new Map([
+			["git --version", { stdout: "git version 2.39.2", stderr: "" }],
+			["git rev-parse --git-dir", null],
+		])
+
+		vitest.mocked(exec).mockImplementation((command: string, options: any, callback: any) => {
+			const response = responses.get(command)
+			if (response === null) {
+				callback(new Error("not a git repository"))
+				return {} as any
+			} else if (response) {
+				callback(null, response)
+				return {} as any
+			}
+			callback(new Error("Unexpected command"))
+			return {} as any
+		})
+
+		const result = await getGitStatus(cwd)
+		expect(result).toBeNull()
+	})
+
+	it("should truncate output to 20 lines", async () => {
+		const lines = Array.from({ length: 30 }, (_, i) => {
+			if (i === 0) return "## main"
+			return `M  file${i}.ts`
+		})
+		const mockOutput = lines.join("\n")
+
+		const responses = new Map([
+			["git --version", { stdout: "git version 2.39.2", stderr: "" }],
+			["git rev-parse --git-dir", { stdout: ".git", stderr: "" }],
+			["git status --porcelain=v1 --branch", { stdout: mockOutput, stderr: "" }],
+		])
+
+		vitest.mocked(exec).mockImplementation((command: string, options: any, callback: any) => {
+			for (const [cmd, response] of responses) {
+				if (command === cmd) {
+					callback(null, response)
+					return {} as any
+				}
+			}
+			callback(new Error("Unexpected command"))
+			return {} as any
+		})
+
+		const result = await getGitStatus(cwd)
+
+		expect(result).toContain("## main")
+		expect(result).toContain("M  file1.ts")
+		expect(result).toContain("... 10 more lines")
+		expect(result).not.toContain("file25.ts")
+	})
+
+	it("should return null when status is empty", async () => {
+		const responses = new Map([
+			["git --version", { stdout: "git version 2.39.2", stderr: "" }],
+			["git rev-parse --git-dir", { stdout: ".git", stderr: "" }],
+			["git status --porcelain=v1 --branch", { stdout: "", stderr: "" }],
+		])
+
+		vitest.mocked(exec).mockImplementation((command: string, options: any, callback: any) => {
+			for (const [cmd, response] of responses) {
+				if (command === cmd) {
+					callback(null, response)
+					return {} as any
+				}
+			}
+			callback(new Error("Unexpected command"))
+			return {} as any
+		})
+
+		const result = await getGitStatus(cwd)
+		expect(result).toBeNull()
+	})
+})
diff --git a/src/utils/git.ts b/src/utils/git.ts
@@ -355,3 +355,47 @@ export async function getWorkingState(cwd: string): Promise<string> {
 		return `Failed to get working state: ${error instanceof Error ? error.message : String(error)}`
 	}
 }
+
+const GIT_STATUS_LINE_LIMIT = 20
+
+/**
+ * Gets git status output with line limit
+ * @param cwd The working directory to check git status in
+ * @returns Git status string or null if not a git repository
+ */
+export async function getGitStatus(cwd: string): Promise<string | null> {
+	try {
+		const isInstalled = await checkGitInstalled()
+		if (!isInstalled) {
+			return null
+		}
+
+		const isRepo = await checkGitRepo(cwd)
+		if (!isRepo) {
+			return null
+		}
+
+		// Use porcelain v1 format with branch info
+		const { stdout } = await execAsync("git status --porcelain=v1 --branch", { cwd })
+
+		if (!stdout.trim()) {
+			return null
+		}
+
+		// Truncate to line limit
+		const lines = stdout.trim().split("\n")
+		const limitedLines = lines.slice(0, GIT_STATUS_LINE_LIMIT)
+
+		let output = limitedLines.join("\n")
+
+		// Add truncation notice if needed
+		if (lines.length > GIT_STATUS_LINE_LIMIT) {
+			output += `\n... ${lines.length - GIT_STATUS_LINE_LIMIT} more lines`
+		}
+
+		return output
+	} catch (error) {
+		console.error("Error getting git status:", error)
+		return null
+	}
+}
