/** * General string utility functions and classes for safe string accumulation */ /** * Escapes special regex characters in a string so it can be used as a literal * pattern in a RegExp constructor. */ export function escapeRegExp(str: string): string { return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') } /** * Uppercases the first character of a string, leaving the rest unchanged. * Unlike lodash `capitalize`, this does NOT lowercase the remaining characters. * * @example capitalize('fooBar') → 'FooBar' * @example capitalize('hello world') → 'Hello world' */ export function capitalize(str: string): string { return str.charAt(0).toUpperCase() + str.slice(1) } /** * Returns the singular or plural form of a word based on count. * Replaces the inline `word${n === 1 ? '' : 's'}` idiom. * * @example plural(1, 'file') → 'file' * @example plural(3, 'file') → 'files' * @example plural(2, 'entry', 'entries') → 'entries' */ export function plural( n: number, word: string, pluralWord = word + 's', ): string { return n === 1 ? word : pluralWord } /** * Returns the first line of a string without allocating a split array. * Used for shebang detection in diff rendering. */ export function firstLineOf(s: string): string { const nl = s.indexOf('\n') return nl === -1 ? s : s.slice(0, nl) } /** * Counts occurrences of `char` in `str` using indexOf jumps instead of * per-character iteration. Structurally typed so Buffer works too * (Buffer.indexOf accepts string needles). */ export function countCharInString( str: { indexOf(search: string, start?: number): number }, char: string, start = 0, ): number { let count = 0 let i = str.indexOf(char, start) while (i !== -1) { count++ i = str.indexOf(char, i + 1) } return count } /** * Normalize full-width (zenkaku) digits to half-width digits. * Useful for accepting input from Japanese/CJK IMEs. */ export function normalizeFullWidthDigits(input: string): string { return input.replace(/[0-9]/g, ch => String.fromCharCode(ch.charCodeAt(0) - 0xfee0), ) } /** * Normalize full-width (zenkaku) space to half-width space. * Useful for accepting input from Japanese/CJK IMEs (U+3000 → U+0020). */ export function normalizeFullWidthSpace(input: string): string { return input.replace(/\u3000/g, ' ') } // Keep in-memory accumulation modest to avoid blowing up RSS. // Overflow beyond this limit is spilled to disk by ShellCommand. const MAX_STRING_LENGTH = 2 ** 25 /** * Safely joins an array of strings with a delimiter, truncating if the result exceeds maxSize. * * @param lines Array of strings to join * @param delimiter Delimiter to use between strings (default: ',') * @param maxSize Maximum size of the resulting string * @returns The joined string, truncated if necessary */ export function safeJoinLines( lines: string[], delimiter: string = ',', maxSize: number = MAX_STRING_LENGTH, ): string { const truncationMarker = '...[truncated]' let result = '' for (const line of lines) { const delimiterToAdd = result ? delimiter : '' const fullAddition = delimiterToAdd + line if (result.length + fullAddition.length <= maxSize) { // The full line fits result += fullAddition } else { // Need to truncate const remainingSpace = maxSize - result.length - delimiterToAdd.length - truncationMarker.length if (remainingSpace > 0) { // Add delimiter and as much of the line as will fit result += delimiterToAdd + line.slice(0, remainingSpace) + truncationMarker } else { // No room for any of this line, just add truncation marker result += truncationMarker } return result } } return result } /** * A string accumulator that safely handles large outputs by truncating from the end * when a size limit is exceeded. This prevents RangeError crashes while preserving * the beginning of the output. */ export class EndTruncatingAccumulator { private content: string = '' private isTruncated = false private totalBytesReceived = 0 /** * Creates a new EndTruncatingAccumulator * @param maxSize Maximum size in characters before truncation occurs */ constructor(private readonly maxSize: number = MAX_STRING_LENGTH) {} /** * Appends data to the accumulator. If the total size exceeds maxSize, * the end is truncated to maintain the size limit. * @param data The string data to append */ append(data: string | Buffer): void { const str = typeof data === 'string' ? data : data.toString() this.totalBytesReceived += str.length // If already at capacity and truncated, don't modify content if (this.isTruncated && this.content.length >= this.maxSize) { return } // Check if adding the string would exceed the limit if (this.content.length + str.length > this.maxSize) { // Only append what we can fit const remainingSpace = this.maxSize - this.content.length if (remainingSpace > 0) { this.content += str.slice(0, remainingSpace) } this.isTruncated = true } else { this.content += str } } /** * Returns the accumulated string, with truncation marker if truncated */ toString(): string { if (!this.isTruncated) { return this.content } const truncatedBytes = this.totalBytesReceived - this.maxSize const truncatedKB = Math.round(truncatedBytes / 1024) return this.content + `\n... [output truncated - ${truncatedKB}KB removed]` } /** * Clears all accumulated data */ clear(): void { this.content = '' this.isTruncated = false this.totalBytesReceived = 0 } /** * Returns the current size of accumulated data */ get length(): number { return this.content.length } /** * Returns whether truncation has occurred */ get truncated(): boolean { return this.isTruncated } /** * Returns total bytes received (before truncation) */ get totalBytes(): number { return this.totalBytesReceived } } /** * Truncates text to a maximum number of lines, adding an ellipsis if truncated. * * @param text The text to truncate * @param maxLines Maximum number of lines to keep * @returns The truncated text with ellipsis if truncated */ export function truncateToLines(text: string, maxLines: number): string { const lines = text.split('\n') if (lines.length <= maxLines) { return text } return lines.slice(0, maxLines).join('\n') + '…' }