feat: add maxReadFileLine to PromptVariables and update system prompt logic

Author: d-oit

src/core/prompts/__tests__/system-prompt-variables.test.ts

@@ -0,0 +1,189 @@
+import * as vscode from "vscode"
+import * as os from "os"
+import { ClineProviderStatic, FormatLanguageUtil, PromptVariables } from "./test-types"
+
+// Mock dependencies
+jest.mock("vscode", () => ({
+	env: {
+		language: "en",
+		shell: "/bin/bash",
+	},
+}))
+
+jest.mock("os", () => ({
+	type: jest.fn(),
+}))
+
+// Create mock ClineProvider
+const MockClineProvider = {
+	getInstance: jest.fn(),
+} as unknown as ClineProviderStatic
+
+// Create mock formatLanguage utility
+const formatLanguage = jest.fn() as FormatLanguageUtil
+
+describe("System Prompt Variables", () => {
+	const mockCwd = "/test/workspace"
+	const mockMode = "test-mode"
+	const mockGetState = jest.fn()
+	const mockProvider = {
+		getState: mockGetState,
+	}
+
+	beforeEach(() => {
+		jest.clearAllMocks()
+		jest.resetModules()
+		;(os.type as jest.Mock).mockReturnValue("Linux")
+		;(formatLanguage as jest.Mock).mockReturnValue("en-US")
+		;(MockClineProvider.getInstance as jest.Mock).mockResolvedValue(mockProvider)
+
+		// Set up global variables that would normally be in scope
+		globalThis.cwd = mockCwd
+		globalThis.mode = mockMode
+		globalThis.language = undefined
+	})
+
+	it("should use maxReadFileLine from provider state when available", async () => {
+		// Setup
+		const mockState = { maxReadFileLine: 1000 }
+		mockGetState.mockResolvedValue(mockState)
+
+		// Create test variables
+		const provider = await MockClineProvider.getInstance()
+		const { maxReadFileLine = 500 } = provider ? await provider.getState() : {}
+		const testVariables: PromptVariables = {
+			workspace: mockCwd,
+			mode: mockMode,
+			language: globalThis.language || formatLanguage(vscode.env.language),
+			shell: vscode.env.shell,
+			operatingSystem: os.type(),
+			maxReadFileLine,
+		}
+
+		// Verify
+		expect(testVariables).toEqual({
+			workspace: mockCwd,
+			mode: mockMode,
+			language: "en-US",
+			shell: "/bin/bash",
+			operatingSystem: "Linux",
+			maxReadFileLine: 1000,
+		})
+	})
+
+	it("should default maxReadFileLine to 500 when not in provider state", async () => {
+		// Setup
+		mockGetState.mockResolvedValue({})
+
+		// Create test variables
+		const provider = await MockClineProvider.getInstance()
+		const { maxReadFileLine = 500 } = provider ? await provider.getState() : {}
+		const testVariables: PromptVariables = {
+			workspace: mockCwd,
+			mode: mockMode,
+			language: globalThis.language || formatLanguage(vscode.env.language),
+			shell: vscode.env.shell,
+			operatingSystem: os.type(),
+			maxReadFileLine,
+		}
+
+		// Verify
+		expect(testVariables.maxReadFileLine).toBe(500)
+	})
+
+	it("should default maxReadFileLine to 500 when provider is null", async () => {
+		// Setup
+		;(MockClineProvider.getInstance as jest.Mock).mockResolvedValue(null)
+
+		// Create test variables
+		const provider = await MockClineProvider.getInstance()
+		const { maxReadFileLine = 500 } = provider ? await provider.getState() : {}
+		const testVariables: PromptVariables = {
+			workspace: mockCwd,
+			mode: mockMode,
+			language: globalThis.language || formatLanguage(vscode.env.language),
+			shell: vscode.env.shell,
+			operatingSystem: os.type(),
+			maxReadFileLine,
+		}
+
+		// Verify
+		expect(testVariables.maxReadFileLine).toBe(500)
+	})
+
+	it("should use provided language when available", async () => {
+		// Setup
+		const providedLanguage = "fr"
+		mockGetState.mockResolvedValue({})
+		globalThis.language = providedLanguage
+
+		// Create test variables
+		const provider = await MockClineProvider.getInstance()
+		const { maxReadFileLine = 500 } = provider ? await provider.getState() : {}
+		const testVariables: PromptVariables = {
+			workspace: mockCwd,
+			mode: mockMode,
+			language: globalThis.language || formatLanguage(vscode.env.language),
+			shell: vscode.env.shell,
+			operatingSystem: os.type(),
+			maxReadFileLine,
+		}
+
+		// Verify
+		expect(testVariables.language).toBe(providedLanguage)
+		expect(formatLanguage).not.toHaveBeenCalled()
+	})
+
+	it("should use formatted vscode language when input language is not provided", async () => {
+		// Setup
+		mockGetState.mockResolvedValue({})
+		globalThis.language = undefined
+
+		// Create test variables
+		const provider = await MockClineProvider.getInstance()
+		const { maxReadFileLine = 500 } = provider ? await provider.getState() : {}
+		const testVariables: PromptVariables = {
+			workspace: mockCwd,
+			mode: mockMode,
+			language: globalThis.language || formatLanguage(vscode.env.language),
+			shell: vscode.env.shell,
+			operatingSystem: os.type(),
+			maxReadFileLine,
+		}
+
+		// Verify
+		expect(formatLanguage).toHaveBeenCalledWith("en")
+		expect(testVariables.language).toBe("en-US")
+	})
+
+	it("should correctly populate all variables with mocked inputs", async () => {
+		// Setup
+		mockGetState.mockResolvedValue({ maxReadFileLine: 750 })
+
+		// Create test variables
+		const provider = await MockClineProvider.getInstance()
+		const { maxReadFileLine = 500 } = provider ? await provider.getState() : {}
+		const testVariables: PromptVariables = {
+			workspace: mockCwd,
+			mode: mockMode,
+			language: globalThis.language || formatLanguage(vscode.env.language),
+			shell: vscode.env.shell,
+			operatingSystem: os.type(),
+			maxReadFileLine,
+		}
+
+		// Verify
+		expect(testVariables).toEqual({
+			workspace: mockCwd,
+			mode: mockMode,
+			language: "en-US",
+			shell: "/bin/bash",
+			operatingSystem: "Linux",
+			maxReadFileLine: 750,
+		})
+
+		expect(os.type).toHaveBeenCalled()
+		expect(MockClineProvider.getInstance).toHaveBeenCalled()
+		expect(mockGetState).toHaveBeenCalled()
+	})
+})

src/core/prompts/__tests__/test-types.ts

@@ -0,0 +1,35 @@
+// Test types
+
+// Provider types
+export interface ClineState {
+	maxReadFileLine?: number
+}
+
+export interface ClineProvider {
+	getState(): Promise<ClineState>
+}
+
+export interface ClineProviderStatic {
+	getInstance(): Promise<ClineProvider | null>
+}
+
+// Utility types
+export interface FormatLanguageUtil {
+	(lang: string): string
+}
+
+// Global declarations
+declare global {
+	var cwd: string
+	var mode: string
+	var language: string | undefined
+}
+
+export interface PromptVariables {
+	workspace: string
+	mode: string
+	language: string
+	shell: string
+	operatingSystem: string
+	maxReadFileLine: number
+}

src/core/prompts/sections/custom-system-prompt.ts

@@ -9,6 +9,7 @@ export type PromptVariables = {
 	language?: string
 	shell?: string
 	operatingSystem?: string
+	maxReadFileLine?: number
 }
 
 function interpolatePromptContent(content: string, variables: PromptVariables): string {
@@ -19,7 +20,10 @@ function interpolatePromptContent(content: string, variables: PromptVariables):
 			variables[key as keyof PromptVariables] !== undefined
 		) {
 			const placeholder = new RegExp(`\\{\\{${key}\\}\\}`, "g")
-			interpolatedContent = interpolatedContent.replace(placeholder, variables[key as keyof PromptVariables]!)
+			interpolatedContent = interpolatedContent.replace(
+				placeholder,
+				String(variables[key as keyof PromptVariables]!),
+			)
 		}
 	}
 	return interpolatedContent

src/core/prompts/system.ts

@@ -3,12 +3,12 @@ import {
 	modes,
 	CustomModePrompts,
 	PromptComponent,
-	getRoleDefinition,
 	defaultModeSlug,
 	ModeConfig,
 	getModeBySlug,
 	getGroupName,
 } from "../../shared/modes"
+import { ClineProvider } from "../webview/ClineProvider"
 import { PromptVariables } from "./sections/custom-system-prompt"
 import { DiffStrategy } from "../../shared/tools"
 import { McpHub } from "../../services/mcp/McpHub"
@@ -126,13 +126,15 @@ export const SYSTEM_PROMPT = async (
 		return undefined
 	}
 
-	// Try to load custom system prompt from file
+	const provider = await ClineProvider.getInstance()
+	const { maxReadFileLine = 500 } = provider ? await provider.getState() : {}
 	const variablesForPrompt: PromptVariables = {
 		workspace: cwd,
 		mode: mode,
 		language: language ?? formatLanguage(vscode.env.language),
 		shell: vscode.env.shell,
 		operatingSystem: os.type(),
+		maxReadFileLine,
 	}
 	const fileCustomSystemPrompt = await loadSystemPromptFile(cwd, mode, variablesForPrompt)