File size: 10,063 Bytes
9332ccf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import React, { useMemo } from 'react';
import {
Text,
Box,
StyledLine,
toStyledCharacters,
wordBreakStyledChars,
wrapStyledChars,
widestLineFromStyledChars,
styledCharsWidth,
styledLineToString,
} from 'ink';
import { theme } from '../semantic-colors.js';
import { parseMarkdownToANSI } from './markdownParsingUtils.js';
import { stripUnsafeCharacters } from './textUtils.js';
interface TableRendererProps {
headers: string[];
rows: string[][];
terminalWidth: number;
}
const MIN_COLUMN_WIDTH = 5;
const COLUMN_PADDING = 2;
const TABLE_MARGIN = 2;
/**
* Parses markdown to StyledLine by first converting to ANSI.
* This ensures character counts are accurate (markdown markers are removed
* and styles are applied to the character's internal style object).
*/
const parseMarkdownToStyledLine = (
text: string,
defaultColor?: string,
): StyledLine => {
const ansi = parseMarkdownToANSI(text, defaultColor);
return toStyledCharacters(ansi);
};
const calculateWidths = (styledLine: StyledLine) => {
const contentWidth = styledCharsWidth(styledLine);
const words: StyledLine[] = wordBreakStyledChars(styledLine);
const maxWordWidth = widestLineFromStyledChars(words);
return { contentWidth, maxWordWidth };
};
// Used to reduce redundant parsing and cache the widths for each line
interface ProcessedLine {
text: string;
width: number;
}
/**
* Custom table renderer for markdown tables
* We implement our own instead of using ink-table due to module compatibility issues
*/
export const TableRenderer: React.FC<TableRendererProps> = ({
headers,
rows,
terminalWidth,
}) => {
const styledHeaders = useMemo<StyledLine[]>(
() =>
headers.map((header) =>
parseMarkdownToStyledLine(
stripUnsafeCharacters(header),
theme.text.link,
),
),
[headers],
);
const styledRows = useMemo<StyledLine[][]>(
() =>
rows.map((row) =>
row.map((cell) =>
parseMarkdownToStyledLine(
stripUnsafeCharacters(cell),
theme.text.primary,
),
),
),
[rows],
);
const { wrappedHeaders, wrappedRows, adjustedWidths } = useMemo(() => {
const numColumns = styledRows.reduce(
(max, row) => Math.max(max, row.length),
styledHeaders.length,
);
// --- Define Constraints per Column ---
const constraints = Array.from({ length: numColumns }).map(
(_, colIndex) => {
const headerStyledLine = styledHeaders[colIndex] || StyledLine.empty(0);
let { contentWidth: maxContentWidth, maxWordWidth } =
calculateWidths(headerStyledLine);
styledRows.forEach((row) => {
const cellStyledLine = row[colIndex] || StyledLine.empty(0);
const { contentWidth: cellWidth, maxWordWidth: cellWordWidth } =
calculateWidths(cellStyledLine);
maxContentWidth = Math.max(maxContentWidth, cellWidth);
maxWordWidth = Math.max(maxWordWidth, cellWordWidth);
});
const minWidth = maxWordWidth;
const maxWidth = Math.max(minWidth, maxContentWidth);
return { minWidth, maxWidth };
},
);
// --- Calculate Available Space ---
// Fixed overhead: borders (n+1) + padding (2n)
const fixedOverhead = numColumns + 1 + numColumns * COLUMN_PADDING;
const availableWidth = Math.max(
0,
terminalWidth - fixedOverhead - TABLE_MARGIN,
);
// --- Allocation Algorithm ---
const totalMinWidth = constraints.reduce((sum, c) => sum + c.minWidth, 0);
let finalContentWidths: number[];
if (totalMinWidth > availableWidth) {
// We must scale all the columns except the ones that are very short(<=5 characters)
const shortColumns = constraints.filter(
(c) => c.maxWidth <= MIN_COLUMN_WIDTH,
);
const totalShortColumnWidth = shortColumns.reduce(
(sum, c) => sum + c.minWidth,
0,
);
const finalTotalShortColumnWidth =
totalShortColumnWidth >= availableWidth ? 0 : totalShortColumnWidth;
const scale =
(availableWidth - finalTotalShortColumnWidth) /
(totalMinWidth - finalTotalShortColumnWidth) || 0;
finalContentWidths = constraints.map((c) => {
if (c.maxWidth <= MIN_COLUMN_WIDTH && finalTotalShortColumnWidth > 0) {
return c.minWidth;
}
return Math.floor(c.minWidth * scale);
});
} else {
const surplus = availableWidth - totalMinWidth;
const totalGrowthNeed = constraints.reduce(
(sum, c) => sum + (c.maxWidth - c.minWidth),
0,
);
if (totalGrowthNeed === 0) {
finalContentWidths = constraints.map((c) => c.minWidth);
} else {
finalContentWidths = constraints.map((c) => {
const growthNeed = c.maxWidth - c.minWidth;
const share = growthNeed / totalGrowthNeed;
const extra = Math.floor(surplus * share);
return Math.min(c.maxWidth, c.minWidth + extra);
});
}
}
// --- Pre-wrap and Optimize Widths ---
const actualColumnWidths: number[] = [];
for (let i = 0; i < numColumns; i++) {
actualColumnWidths.push(0);
}
const wrapAndProcessRow = (row: StyledLine[]) => {
const rowResult: ProcessedLine[][] = [];
// Ensure we iterate up to numColumns, filling with empty cells if needed
for (let colIndex = 0; colIndex < numColumns; colIndex++) {
const cellStyledLine = row[colIndex] || StyledLine.empty(0);
const allocatedWidth = finalContentWidths[colIndex];
const contentWidth = Math.max(1, allocatedWidth);
const wrappedStyledLines = wrapStyledChars(
cellStyledLine,
contentWidth,
);
const maxLineWidth = widestLineFromStyledChars(wrappedStyledLines);
actualColumnWidths[colIndex] = Math.max(
actualColumnWidths[colIndex],
maxLineWidth,
);
const lines = wrappedStyledLines.map((line) => ({
text: styledLineToString(line),
width: styledCharsWidth(line),
}));
rowResult.push(lines);
}
return rowResult;
};
const wrappedHeaders = wrapAndProcessRow(styledHeaders);
const wrappedRows = styledRows.map((row) => wrapAndProcessRow(row));
// Use the TIGHTEST widths that fit the wrapped content + padding
const adjustedWidths = actualColumnWidths.map((w) => w + COLUMN_PADDING);
return { wrappedHeaders, wrappedRows, adjustedWidths };
}, [styledHeaders, styledRows, terminalWidth]);
// Helper function to render a cell with proper width
const renderCell = (
content: ProcessedLine,
width: number,
isHeader = false,
): React.ReactNode => {
const contentWidth = Math.max(0, width - COLUMN_PADDING);
// Use pre-calculated width to avoid re-parsing
const displayWidth = content.width;
const paddingNeeded = Math.max(0, contentWidth - displayWidth);
return (
<Text>
{isHeader ? (
<Text bold color={theme.text.link}>
{content.text}
</Text>
) : (
<Text>{content.text}</Text>
)}
{' '.repeat(paddingNeeded)}
</Text>
);
};
// Helper function to render border
const renderBorder = (type: 'top' | 'middle' | 'bottom'): React.ReactNode => {
const chars = {
top: { left: 'β', middle: 'β¬', right: 'β', horizontal: 'β' },
middle: { left: 'β', middle: 'βΌ', right: 'β€', horizontal: 'β' },
bottom: { left: 'β', middle: 'β΄', right: 'β', horizontal: 'β' },
};
const char = chars[type];
const borderParts = adjustedWidths.map((w) =>
char.horizontal.repeat(Math.max(0, w || 0)),
);
const border = char.left + borderParts.join(char.middle) + char.right;
return <Text color={theme.border.default}>{border}</Text>;
};
// Helper function to render a single visual line of a row
const renderVisualRow = (
cells: ProcessedLine[],
isHeader = false,
): React.ReactNode => {
const renderedCells = cells.map((cell, index) => {
const width = adjustedWidths[index] || 0;
return renderCell(cell, width, isHeader);
});
return (
<Box flexDirection="row">
<Text color={theme.border.default}>β</Text>
{renderedCells.map((cell, index) => (
<React.Fragment key={index}>
<Box paddingX={1}>{cell}</Box>
{index < renderedCells.length - 1 && (
<Text color={theme.border.default}>β</Text>
)}
</React.Fragment>
))}
<Text color={theme.border.default}>β</Text>
</Box>
);
};
// Handles the wrapping logic for a logical data row
const renderDataRow = (
wrappedCells: ProcessedLine[][],
rowIndex?: number,
isHeader = false,
): React.ReactNode => {
const key = rowIndex === -1 ? 'header' : `${rowIndex}`;
const maxHeight = Math.max(...wrappedCells.map((lines) => lines.length), 1);
const visualRows: React.ReactNode[] = [];
for (let i = 0; i < maxHeight; i++) {
const visualRowCells = wrappedCells.map(
(lines) => lines[i] || { text: '', width: 0 },
);
visualRows.push(
<React.Fragment key={`${key}-${i}`}>
{renderVisualRow(visualRowCells, isHeader)}
</React.Fragment>,
);
}
return <React.Fragment key={rowIndex}>{visualRows}</React.Fragment>;
};
return (
<Box flexDirection="column">
{/* Top border */}
{renderBorder('top')}
{/*
Header row
Keep the rowIndex as -1 to differentiate from data rows
*/}
{renderDataRow(wrappedHeaders, -1, true)}
{/* Middle border */}
{renderBorder('middle')}
{/* Data rows */}
{wrappedRows.map((row, index) => renderDataRow(row, index))}
{/* Bottom border */}
{renderBorder('bottom')}
</Box>
);
};
|