Add line numbers when reading files and writing files

Author: mrubens

src/core/Cline.ts

@@ -12,7 +12,7 @@ import { ApiHandler, buildApiHandler } from "../api"
 import { ApiStream } from "../api/transform/stream"
 import { DiffViewProvider } from "../integrations/editor/DiffViewProvider"
 import { findToolName, formatContentBlockToMarkdown } from "../integrations/misc/export-markdown"
-import { extractTextFromFile } from "../integrations/misc/extract-text"
+import { extractTextFromFile, addLineNumbers } from "../integrations/misc/extract-text"
 import { TerminalManager } from "../integrations/terminal/TerminalManager"
 import { UrlContentFetcher } from "../services/browser/UrlContentFetcher"
 import { listFiles } from "../services/glob/list-files"
@@ -1133,8 +1133,8 @@ export class Cline {
 									)
 									pushToolResult(
 										`The user made the following updates to your content:\n\n${userEdits}\n\n` +
-											`The updated content, which includes both your original modifications and the user's edits, has been successfully saved to ${relPath.toPosix()}. Here is the full, updated content of the file:\n\n` +
-											`<final_file_content path="${relPath.toPosix()}">\n${finalContent}\n</final_file_content>\n\n` +
+											`The updated content, which includes both your original modifications and the user's edits, has been successfully saved to ${relPath.toPosix()}. Here is the full, updated content of the file, including line numbers:\n\n` +
+											`<final_file_content path="${relPath.toPosix()}">\n${addLineNumbers(finalContent || '')}\n</final_file_content>\n\n` +
 											`Please note:\n` +
 											`1. You do not need to re-write the file with these changes, as they have already been applied.\n` +
 											`2. Proceed with the task using this updated file content as the new baseline.\n` +
@@ -1245,8 +1245,8 @@ export class Cline {
 									)
 									pushToolResult(
 										`The user made the following updates to your content:\n\n${userEdits}\n\n` +
-											`The updated content, which includes both your original modifications and the user's edits, has been successfully saved to ${relPath.toPosix()}. Here is the full, updated content of the file:\n\n` +
-											`<final_file_content path="${relPath.toPosix()}">\n${finalContent}\n</final_file_content>\n\n` +
+											`The updated content, which includes both your original modifications and the user's edits, has been successfully saved to ${relPath.toPosix()}. Here is the full, updated content of the file, including line numbers:\n\n` +
+											`<final_file_content path="${relPath.toPosix()}">\n${addLineNumbers(finalContent || '')}\n</final_file_content>\n\n` +
 											`Please note:\n` +
 											`1. You do not need to re-write the file with these changes, as they have already been applied.\n` +
 											`2. Proceed with the task using this updated file content as the new baseline.\n` +
@@ -2263,3 +2263,4 @@ export class Cline {
 		return `<environment_details>\n${details.trim()}\n</environment_details>`
 	}
 }
+

src/core/prompts/system.ts

@@ -46,7 +46,7 @@ Usage:
 </execute_command>
 
 ## read_file
-Description: Request to read the contents of a file at the specified path. Use this when you need to examine the contents of an existing file you do not know the contents of, for example to analyze code, review text files, or extract information from configuration files. Automatically extracts raw text from PDF and DOCX files. May not be suitable for other types of binary files, as it returns the raw content as a string.
+Description: Request to read the contents of a file at the specified path. Use this when you need to examine the contents of an existing file you do not know the contents of, for example to analyze code, review text files, or extract information from configuration files. The output includes line numbers prefixed to each line (e.g. "1 | const x = 1"), making it easier to reference specific lines when creating diffs or discussing code. Automatically extracts raw text from PDF and DOCX files. May not be suitable for other types of binary files, as it returns the raw content as a string.
 Parameters:
 - path: (required) The path of the file to read (relative to the current working directory ${cwd.toPosix()})
 Usage:
@@ -361,3 +361,4 @@ The following additional instructions are provided by the user, and should be fo
 ${joinedInstructions}`
 		: ""
 }
+

src/core/webview/__tests__/ClineProvider.test.ts

@@ -76,6 +76,15 @@ jest.mock('../../Cline', () => {
     }
 })
 
+// Mock extract-text
+jest.mock('../../../integrations/misc/extract-text', () => ({
+    extractTextFromFile: jest.fn().mockImplementation(async (filePath: string) => {
+        const content = 'const x = 1;\nconst y = 2;\nconst z = 3;'
+        const lines = content.split('\n')
+        return lines.map((line, index) => `${index + 1} | ${line}`).join('\n')
+    })
+}))
+
 // Spy on console.error and console.log to suppress expected messages
 beforeAll(() => {
     jest.spyOn(console, 'error').mockImplementation(() => {})
@@ -258,4 +267,10 @@ describe('ClineProvider', () => {
         expect(mockContext.globalState.update).toHaveBeenCalledWith('soundEnabled', false)
         expect(mockPostMessage).toHaveBeenCalled()
     })
+
+    test('file content includes line numbers', async () => {
+        const { extractTextFromFile } = require('../../../integrations/misc/extract-text')
+        const result = await extractTextFromFile('test.js')
+        expect(result).toBe('1 | const x = 1;\n2 | const y = 2;\n3 | const z = 3;')
+    })
 })

src/integrations/misc/extract-text.ts

@@ -22,7 +22,7 @@ export async function extractTextFromFile(filePath: string): Promise<string> {
 		default:
 			const isBinary = await isBinaryFile(filePath).catch(() => false)
 			if (!isBinary) {
-				return await fs.readFile(filePath, "utf8")
+				return addLineNumbers(await fs.readFile(filePath, "utf8"))
 			} else {
 				throw new Error(`Cannot read text for file type: ${fileExtension}`)
 			}
@@ -32,12 +32,12 @@ export async function extractTextFromFile(filePath: string): Promise<string> {
 async function extractTextFromPDF(filePath: string): Promise<string> {
 	const dataBuffer = await fs.readFile(filePath)
 	const data = await pdf(dataBuffer)
-	return data.text
+	return addLineNumbers(data.text)
 }
 
 async function extractTextFromDOCX(filePath: string): Promise<string> {
 	const result = await mammoth.extractRawText({ path: filePath })
-	return result.value
+	return addLineNumbers(result.value)
 }
 
 async function extractTextFromIPYNB(filePath: string): Promise<string> {
@@ -51,5 +51,17 @@ async function extractTextFromIPYNB(filePath: string): Promise<string> {
 		}
 	}
 
-	return extractedText
+	return addLineNumbers(extractedText)
 }
+
+export function addLineNumbers(content: string): string {
+	const lines = content.split('\n')
+	const maxLineNumberWidth = String(lines.length).length
+	return lines
+		.map((line, index) => {
+			const lineNumber = String(index + 1).padStart(maxLineNumberWidth, ' ')
+			return `${lineNumber} | ${line}`
+		}).join('\n')
+}
+
+