Spaces:
Paused
Paused
| import { displayString } from "../utils.js"; | |
| import { visibleWidth } from "./ansi.js"; | |
| type Align = "left" | "right" | "center"; | |
| export type TableColumn = { | |
| key: string; | |
| header: string; | |
| align?: Align; | |
| minWidth?: number; | |
| maxWidth?: number; | |
| flex?: boolean; | |
| }; | |
| export type RenderTableOptions = { | |
| columns: TableColumn[]; | |
| rows: Array<Record<string, string>>; | |
| width?: number; | |
| padding?: number; | |
| border?: "unicode" | "ascii" | "none"; | |
| }; | |
| function repeat(ch: string, n: number): string { | |
| if (n <= 0) { | |
| return ""; | |
| } | |
| return ch.repeat(n); | |
| } | |
| function padCell(text: string, width: number, align: Align): string { | |
| const w = visibleWidth(text); | |
| if (w >= width) { | |
| return text; | |
| } | |
| const pad = width - w; | |
| if (align === "right") { | |
| return `${repeat(" ", pad)}${text}`; | |
| } | |
| if (align === "center") { | |
| const left = Math.floor(pad / 2); | |
| const right = pad - left; | |
| return `${repeat(" ", left)}${text}${repeat(" ", right)}`; | |
| } | |
| return `${text}${repeat(" ", pad)}`; | |
| } | |
| function wrapLine(text: string, width: number): string[] { | |
| if (width <= 0) { | |
| return [text]; | |
| } | |
| // ANSI-aware wrapping: never split inside ANSI SGR/OSC-8 sequences. | |
| // We don't attempt to re-open styling per line; terminals keep SGR state | |
| // across newlines, so as long as we don't corrupt escape sequences we're safe. | |
| const ESC = "\u001b"; | |
| type Token = { kind: "ansi" | "char"; value: string }; | |
| const tokens: Token[] = []; | |
| for (let i = 0; i < text.length; ) { | |
| if (text[i] === ESC) { | |
| // SGR: ESC [ ... m | |
| if (text[i + 1] === "[") { | |
| let j = i + 2; | |
| while (j < text.length) { | |
| const ch = text[j]; | |
| if (ch === "m") { | |
| break; | |
| } | |
| if (ch && ch >= "0" && ch <= "9") { | |
| j += 1; | |
| continue; | |
| } | |
| if (ch === ";") { | |
| j += 1; | |
| continue; | |
| } | |
| break; | |
| } | |
| if (text[j] === "m") { | |
| tokens.push({ kind: "ansi", value: text.slice(i, j + 1) }); | |
| i = j + 1; | |
| continue; | |
| } | |
| } | |
| // OSC-8 link open/close: ESC ] 8 ; ; ... ST (ST = ESC \) | |
| if (text[i + 1] === "]" && text.slice(i + 2, i + 5) === "8;;") { | |
| const st = text.indexOf(`${ESC}\\`, i + 5); | |
| if (st >= 0) { | |
| tokens.push({ kind: "ansi", value: text.slice(i, st + 2) }); | |
| i = st + 2; | |
| continue; | |
| } | |
| } | |
| } | |
| const cp = text.codePointAt(i); | |
| if (!cp) { | |
| break; | |
| } | |
| const ch = String.fromCodePoint(cp); | |
| tokens.push({ kind: "char", value: ch }); | |
| i += ch.length; | |
| } | |
| const firstCharIndex = tokens.findIndex((t) => t.kind === "char"); | |
| if (firstCharIndex < 0) { | |
| return [text]; | |
| } | |
| let lastCharIndex = -1; | |
| for (let i = tokens.length - 1; i >= 0; i -= 1) { | |
| if (tokens[i]?.kind === "char") { | |
| lastCharIndex = i; | |
| break; | |
| } | |
| } | |
| const prefixAnsi = tokens | |
| .slice(0, firstCharIndex) | |
| .filter((t) => t.kind === "ansi") | |
| .map((t) => t.value) | |
| .join(""); | |
| const suffixAnsi = tokens | |
| .slice(lastCharIndex + 1) | |
| .filter((t) => t.kind === "ansi") | |
| .map((t) => t.value) | |
| .join(""); | |
| const coreTokens = tokens.slice(firstCharIndex, lastCharIndex + 1); | |
| const lines: string[] = []; | |
| const isBreakChar = (ch: string) => | |
| ch === " " || ch === "\t" || ch === "/" || ch === "-" || ch === "_" || ch === "."; | |
| const isSpaceChar = (ch: string) => ch === " " || ch === "\t"; | |
| let skipNextLf = false; | |
| const buf: Token[] = []; | |
| let bufVisible = 0; | |
| let lastBreakIndex: number | null = null; | |
| const bufToString = (slice?: Token[]) => (slice ?? buf).map((t) => t.value).join(""); | |
| const bufVisibleWidth = (slice: Token[]) => | |
| slice.reduce((acc, t) => acc + (t.kind === "char" ? 1 : 0), 0); | |
| const pushLine = (value: string) => { | |
| const cleaned = value.replace(/\s+$/, ""); | |
| if (cleaned.trim().length === 0) { | |
| return; | |
| } | |
| lines.push(cleaned); | |
| }; | |
| const flushAt = (breakAt: number | null) => { | |
| if (buf.length === 0) { | |
| return; | |
| } | |
| if (breakAt == null || breakAt <= 0) { | |
| pushLine(bufToString()); | |
| buf.length = 0; | |
| bufVisible = 0; | |
| lastBreakIndex = null; | |
| return; | |
| } | |
| const left = buf.slice(0, breakAt); | |
| const rest = buf.slice(breakAt); | |
| pushLine(bufToString(left)); | |
| while (rest.length > 0 && rest[0]?.kind === "char" && isSpaceChar(rest[0].value)) { | |
| rest.shift(); | |
| } | |
| buf.length = 0; | |
| buf.push(...rest); | |
| bufVisible = bufVisibleWidth(buf); | |
| lastBreakIndex = null; | |
| }; | |
| for (const token of coreTokens) { | |
| if (token.kind === "ansi") { | |
| buf.push(token); | |
| continue; | |
| } | |
| const ch = token.value; | |
| if (skipNextLf) { | |
| skipNextLf = false; | |
| if (ch === "\n") { | |
| continue; | |
| } | |
| } | |
| if (ch === "\n" || ch === "\r") { | |
| flushAt(buf.length); | |
| if (ch === "\r") { | |
| skipNextLf = true; | |
| } | |
| continue; | |
| } | |
| if (bufVisible + 1 > width && bufVisible > 0) { | |
| flushAt(lastBreakIndex); | |
| } | |
| buf.push(token); | |
| bufVisible += 1; | |
| if (isBreakChar(ch)) { | |
| lastBreakIndex = buf.length; | |
| } | |
| } | |
| flushAt(buf.length); | |
| if (!lines.length) { | |
| return [""]; | |
| } | |
| if (!prefixAnsi && !suffixAnsi) { | |
| return lines; | |
| } | |
| return lines.map((line) => { | |
| if (!line) { | |
| return line; | |
| } | |
| return `${prefixAnsi}${line}${suffixAnsi}`; | |
| }); | |
| } | |
| function normalizeWidth(n: number | undefined): number | undefined { | |
| if (n == null) { | |
| return undefined; | |
| } | |
| if (!Number.isFinite(n) || n <= 0) { | |
| return undefined; | |
| } | |
| return Math.floor(n); | |
| } | |
| export function renderTable(opts: RenderTableOptions): string { | |
| const rows = opts.rows.map((row) => { | |
| const next: Record<string, string> = {}; | |
| for (const [key, value] of Object.entries(row)) { | |
| next[key] = displayString(value); | |
| } | |
| return next; | |
| }); | |
| const border = opts.border ?? "unicode"; | |
| if (border === "none") { | |
| const columns = opts.columns; | |
| const header = columns.map((c) => c.header).join(" | "); | |
| const lines = [header, ...rows.map((r) => columns.map((c) => r[c.key] ?? "").join(" | "))]; | |
| return `${lines.join("\n")}\n`; | |
| } | |
| const padding = Math.max(0, opts.padding ?? 1); | |
| const columns = opts.columns; | |
| const metrics = columns.map((c) => { | |
| const headerW = visibleWidth(c.header); | |
| const cellW = Math.max(0, ...rows.map((r) => visibleWidth(r[c.key] ?? ""))); | |
| return { headerW, cellW }; | |
| }); | |
| const widths = columns.map((c, i) => { | |
| const m = metrics[i]; | |
| const base = Math.max(m?.headerW ?? 0, m?.cellW ?? 0) + padding * 2; | |
| const capped = c.maxWidth ? Math.min(base, c.maxWidth) : base; | |
| return Math.max(c.minWidth ?? 3, capped); | |
| }); | |
| const maxWidth = normalizeWidth(opts.width); | |
| const sepCount = columns.length + 1; | |
| const total = widths.reduce((a, b) => a + b, 0) + sepCount; | |
| const preferredMinWidths = columns.map((c, i) => | |
| Math.max(c.minWidth ?? 3, (metrics[i]?.headerW ?? 0) + padding * 2, 3), | |
| ); | |
| const absoluteMinWidths = columns.map((_c, i) => | |
| Math.max((metrics[i]?.headerW ?? 0) + padding * 2, 3), | |
| ); | |
| if (maxWidth && total > maxWidth) { | |
| let over = total - maxWidth; | |
| const flexOrder = columns | |
| .map((_c, i) => ({ i, w: widths[i] ?? 0 })) | |
| .filter(({ i }) => Boolean(columns[i]?.flex)) | |
| .toSorted((a, b) => b.w - a.w) | |
| .map((x) => x.i); | |
| const nonFlexOrder = columns | |
| .map((_c, i) => ({ i, w: widths[i] ?? 0 })) | |
| .filter(({ i }) => !columns[i]?.flex) | |
| .toSorted((a, b) => b.w - a.w) | |
| .map((x) => x.i); | |
| const shrink = (order: number[], minWidths: number[]) => { | |
| while (over > 0) { | |
| let progressed = false; | |
| for (const i of order) { | |
| if ((widths[i] ?? 0) <= (minWidths[i] ?? 0)) { | |
| continue; | |
| } | |
| widths[i] = (widths[i] ?? 0) - 1; | |
| over -= 1; | |
| progressed = true; | |
| if (over <= 0) { | |
| break; | |
| } | |
| } | |
| if (!progressed) { | |
| break; | |
| } | |
| } | |
| }; | |
| // Prefer shrinking flex columns; only shrink non-flex if necessary. | |
| // If required to fit, allow flex columns to shrink below user minWidth | |
| // down to their absolute minimum (header + padding). | |
| shrink(flexOrder, preferredMinWidths); | |
| shrink(flexOrder, absoluteMinWidths); | |
| shrink(nonFlexOrder, preferredMinWidths); | |
| shrink(nonFlexOrder, absoluteMinWidths); | |
| } | |
| // If we have room and any flex columns, expand them to fill the available width. | |
| // This keeps tables from looking "clipped" and reduces wrapping in wide terminals. | |
| if (maxWidth) { | |
| const sepCount = columns.length + 1; | |
| const currentTotal = widths.reduce((a, b) => a + b, 0) + sepCount; | |
| let extra = maxWidth - currentTotal; | |
| if (extra > 0) { | |
| const flexCols = columns | |
| .map((c, i) => ({ c, i })) | |
| .filter(({ c }) => Boolean(c.flex)) | |
| .map(({ i }) => i); | |
| if (flexCols.length > 0) { | |
| const caps = columns.map((c) => | |
| typeof c.maxWidth === "number" && c.maxWidth > 0 | |
| ? Math.floor(c.maxWidth) | |
| : Number.POSITIVE_INFINITY, | |
| ); | |
| while (extra > 0) { | |
| let progressed = false; | |
| for (const i of flexCols) { | |
| if ((widths[i] ?? 0) >= (caps[i] ?? Number.POSITIVE_INFINITY)) { | |
| continue; | |
| } | |
| widths[i] = (widths[i] ?? 0) + 1; | |
| extra -= 1; | |
| progressed = true; | |
| if (extra <= 0) { | |
| break; | |
| } | |
| } | |
| if (!progressed) { | |
| break; | |
| } | |
| } | |
| } | |
| } | |
| } | |
| const box = | |
| border === "ascii" | |
| ? { | |
| tl: "+", | |
| tr: "+", | |
| bl: "+", | |
| br: "+", | |
| h: "-", | |
| v: "|", | |
| t: "+", | |
| ml: "+", | |
| m: "+", | |
| mr: "+", | |
| b: "+", | |
| } | |
| : { | |
| tl: "┌", | |
| tr: "┐", | |
| bl: "└", | |
| br: "┘", | |
| h: "─", | |
| v: "│", | |
| t: "┬", | |
| ml: "├", | |
| m: "┼", | |
| mr: "┤", | |
| b: "┴", | |
| }; | |
| const hLine = (left: string, mid: string, right: string) => | |
| `${left}${widths.map((w) => repeat(box.h, w)).join(mid)}${right}`; | |
| const contentWidthFor = (i: number) => Math.max(1, widths[i] - padding * 2); | |
| const padStr = repeat(" ", padding); | |
| const renderRow = (record: Record<string, string>, isHeader = false) => { | |
| const cells = columns.map((c) => (isHeader ? c.header : (record[c.key] ?? ""))); | |
| const wrapped = cells.map((cell, i) => wrapLine(cell, contentWidthFor(i))); | |
| const height = Math.max(...wrapped.map((w) => w.length)); | |
| const out: string[] = []; | |
| for (let li = 0; li < height; li += 1) { | |
| const parts = wrapped.map((lines, i) => { | |
| const raw = lines[li] ?? ""; | |
| const aligned = padCell(raw, contentWidthFor(i), columns[i]?.align ?? "left"); | |
| return `${padStr}${aligned}${padStr}`; | |
| }); | |
| out.push(`${box.v}${parts.join(box.v)}${box.v}`); | |
| } | |
| return out; | |
| }; | |
| const lines: string[] = []; | |
| lines.push(hLine(box.tl, box.t, box.tr)); | |
| lines.push(...renderRow({}, true)); | |
| lines.push(hLine(box.ml, box.m, box.mr)); | |
| for (const row of rows) { | |
| lines.push(...renderRow(row, false)); | |
| } | |
| lines.push(hLine(box.bl, box.b, box.br)); | |
| return `${lines.join("\n")}\n`; | |
| } | |