Roo-Code/src/integrations/misc/read-lines.ts

/**
 * credits @BorisChumichev
 *
 * https://github.com/BorisChumichev/node-nthline
 *
 * This module extend functionality of reading lines from a file
 * Now you can read a range of lines from a file
 */
import { createReadStream } from "fs"

const outOfRangeError = (filepath: string, n: number) => {
	return new RangeError(`Line with index ${n} does not exist in '${filepath}'. Note that line indexing is zero-based`)
}

/**
 * Reads a range of lines from a file.
 *
 * @param filepath - Path to the file to read
 * @param endLine - Optional. The line number to stop reading at (inclusive). If undefined, reads to the end of file.
 * @param startLine - Optional. The line number to start reading from (inclusive). If undefined, starts from line 0.
 * @returns Promise resolving to a string containing the read lines joined with newlines
 * @throws {RangeError} If line numbers are invalid or out of range
 */
export function readLines(filepath: string, endLine?: number, startLine?: number): Promise<string> {
	return new Promise((resolve, reject) => {
		// Reject if startLine is defined but not a number
		if (startLine !== undefined && typeof startLine !== "number") {
			return reject(new RangeError(`Invalid startLine: ${startLine}. Line numbers must be numbers.`))
		}

		// Force startLine to be an integer and clamp to 0 if negative
		if (startLine !== undefined) {
			startLine = Math.max(0, Math.floor(startLine))
		}

		// Reject if endLine is defined but not a number
		if (endLine !== undefined && typeof endLine !== "number") {
			return reject(new RangeError(`Invalid endLine: ${endLine}. Line numbers must be numbers.`))
		}

		// Force endLine to be an integer
		if (endLine !== undefined) {
			endLine = Math.floor(endLine)
		}

		const effectiveStartLine = startLine === undefined ? 0 : startLine

		// Check startLine and endLine relationship
		if (endLine !== undefined && effectiveStartLine > endLine) {
			return reject(
				new RangeError(`startLine (${effectiveStartLine}) must be less than or equal to endLine (${endLine})`),
			)
		}

		// Set up stream
		const input = createReadStream(filepath)
		let buffer = ""
		let lineCount = 0
		let result = ""

		// Handle errors
		input.on("error", reject)

		// Process data chunks directly
		input.on("data", (chunk) => {
			// Add chunk to buffer
			buffer += chunk.toString()

			let pos = 0
			let nextNewline = buffer.indexOf("\n", pos)

			// Process complete lines in the buffer
			while (nextNewline !== -1) {
				// If we're in the target range, add this line to the result
				if (lineCount >= effectiveStartLine && (endLine === undefined || lineCount <= endLine)) {
					result += buffer.substring(pos, nextNewline + 1) // Include the newline
				}

				// Move position and increment line counter
				pos = nextNewline + 1
				lineCount++

				// If we've reached the end line, we can stop
				if (endLine !== undefined && lineCount > endLine) {
					input.destroy()
					resolve(result)
					return
				}

				// Find next newline
				nextNewline = buffer.indexOf("\n", pos)
			}

			// Trim buffer - keep only the incomplete line
			buffer = buffer.substring(pos)
		})

		// Handle end of file
		input.on("end", () => {
			// Process any remaining data in buffer (last line without newline)
			if (buffer.length > 0) {
				if (lineCount >= effectiveStartLine && (endLine === undefined || lineCount <= endLine)) {
					result += buffer
				}
				lineCount++
			}

			// Check if we found any lines in the requested range
			if (lineCount <= effectiveStartLine) {
				reject(outOfRangeError(filepath, effectiveStartLine))
			} else {
				resolve(result)
			}
		})
	})
}