/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { render } from 'ink-testing-library';
import { MarkdownDisplay } from './MarkdownDisplay.js';
describe('MarkdownDisplay', () => {
describe('Table Rendering', () => {
it('should render a simple table', () => {
const tableMarkdown = `
| Name | Age | City |
|------|-----|------|
| John | 25 | NYC |
| Jane | 30 | LA |
`;
const { lastFrame } = render(
,
);
expect(lastFrame()).toContain('Name');
expect(lastFrame()).toContain('Age');
expect(lastFrame()).toContain('City');
expect(lastFrame()).toContain('John');
expect(lastFrame()).toContain('25');
expect(lastFrame()).toContain('NYC');
expect(lastFrame()).toContain('Jane');
expect(lastFrame()).toContain('30');
expect(lastFrame()).toContain('LA');
});
it('should handle tables with varying column widths', () => {
const tableMarkdown = `
| Short | Medium Column | Very Long Column Name |
|-------|---------------|----------------------|
| A | Some text | This is a longer text content |
| B | More content | Another piece of content here |
`;
const { lastFrame } = render(
,
);
expect(lastFrame()).toContain('Short');
expect(lastFrame()).toContain('Medium Column');
expect(lastFrame()).toContain('Very Long Column Name');
});
it('should handle empty cells in tables', () => {
const tableMarkdown = `
| Col1 | Col2 | Col3 |
|------|------|------|
| A | | C |
| | B | |
`;
const { lastFrame } = render(
,
);
expect(lastFrame()).toContain('Col1');
expect(lastFrame()).toContain('Col2');
expect(lastFrame()).toContain('Col3');
expect(lastFrame()).toContain('A');
expect(lastFrame()).toContain('B');
expect(lastFrame()).toContain('C');
});
it('should handle mixed content with tables', () => {
const mixedMarkdown = `
# Header
Some paragraph text before the table.
| Feature | Status | Notes |
|---------|--------|-------|
| Auth | Done | OAuth |
| API | WIP | REST |
Some text after the table.
`;
const { lastFrame } = render(
,
);
expect(lastFrame()).toContain('Header');
expect(lastFrame()).toContain('Some paragraph text before the table.');
expect(lastFrame()).toContain('Feature');
expect(lastFrame()).toContain('Status');
expect(lastFrame()).toContain('Auth');
expect(lastFrame()).toContain('Done');
expect(lastFrame()).toContain('Some text after the table.');
});
it('should handle tables with empty cells at edges', () => {
const tableMarkdown = `
| | Middle | |
|-|--------|-|
| | Value | |
`;
const { lastFrame } = render(
,
);
expect(lastFrame()).toContain('Middle');
expect(lastFrame()).toContain('Value');
// Should maintain column structure even with empty edge cells
});
it('should handle PR reviewer test case 1', () => {
const tableMarkdown = `
| Package | Lines of Code |
|---------|---------------|
| CLI | 18407 |
| Core | 14445 |
`;
const { lastFrame } = render(
,
);
const output = lastFrame();
expect(output).toContain('Package');
expect(output).toContain('Lines of Code');
expect(output).toContain('CLI');
expect(output).toContain('18407');
expect(output).toContain('Core');
expect(output).toContain('14445');
});
it('should handle PR reviewer test case 2 - long table', () => {
const tableMarkdown = `
| Letter | Count |
|--------|-------|
| a | 15 |
| b | 2 |
| c | 26 |
| Total | 283 |
`;
const { lastFrame } = render(
,
);
const output = lastFrame();
expect(output).toContain('Letter');
expect(output).toContain('Count');
expect(output).toContain('a');
expect(output).toContain('15');
expect(output).toContain('Total');
expect(output).toContain('283');
});
it('should not render malformed tables', () => {
const malformedMarkdown = `
| This looks like a table |
But there's no separator line
| So it shouldn't render as table |
`;
const { lastFrame } = render(
,
);
// Should render as regular text, not a table
expect(lastFrame()).toContain('| This looks like a table |');
expect(lastFrame()).toContain("But there's no separator line");
expect(lastFrame()).toContain("| So it shouldn't render as table |");
});
it('should not crash when rendering a very wide table in a narrow terminal', () => {
const wideTable = `
| Col 1 | Col 2 | Col 3 | Col 4 | Col 5 | Col 6 | Col 7 | Col 8 | Col 9 | Col 10 |
|-------|-------|-------|-------|-------|-------|-------|-------|-------|--------|
| ${'a'.repeat(20)} | ${'b'.repeat(20)} | ${'c'.repeat(20)} | ${'d'.repeat(
20,
)} | ${'e'.repeat(20)} | ${'f'.repeat(20)} | ${'g'.repeat(20)} | ${'h'.repeat(
20,
)} | ${'i'.repeat(20)} | ${'j'.repeat(20)} |
`;
const renderNarrow = () =>
render(
,
);
// The important part is that this does not throw an error.
expect(renderNarrow).not.toThrow();
// We can also check that it rendered *something*.
const { lastFrame } = renderNarrow();
expect(lastFrame()).not.toBe('');
});
it('should handle inline markdown in tables', () => {
// Test content from MarkdownDisplay.demo.tsx
const testContent = `
# execSync vs spawn
| Characteristic | \`execSync\` (Old Way) | \`spawn\` (New Way in PR) |
|----------------|------------------------|---------------------------|
| **Execution** | Synchronous (blocks everything) | Asynchronous (non-blocking) |
| **I/O Handling** | Buffers entire output in memory | Streams data in chunks (memory efficient) |
| **Security** | **Vulnerable to shell injection** | **Safe from shell injection** |
| **Use Case** | Simple, quick commands with small, trusted... | Long-running processes, large I/O, and especially for running user-configur... |
`;
const { lastFrame } = render(
,
);
const output = lastFrame();
// Check header
expect(output).toContain('execSync vs spawn');
// Check table headers - handle possible truncation
expect(output).toMatch(/Cha(racteristic)?/); // Match "Cha" or "Characteristic"
expect(output).toContain('execSync');
expect(output).toContain('spawn');
// Check table content - test keywords rather than full sentences
expect(output).toMatch(/Exe(cution)?/); // Match "Exe" or "Execution"
expect(output).toContain('Synchronous');
expect(output).toContain('Asynchronous');
expect(output).toMatch(/I\/O|Handling/); // Match "I/O" or "Handling"
expect(output).toContain('Buffers');
expect(output).toContain('Streams');
expect(output).toMatch(/Sec(urity)?/); // Match "Sec" or "Security"
expect(output).toContain('Vulnerable');
expect(output).toContain('Safe');
expect(output).toMatch(/Use|Case/); // Match "Use" or "Case"
expect(output).toContain('Simple');
expect(output).toContain('Long-running');
});
});
describe('Existing Functionality', () => {
it('should render headers correctly', () => {
const headerMarkdown = `
# H1 Header
## H2 Header
### H3 Header
#### H4 Header
`;
const { lastFrame } = render(
,
);
expect(lastFrame()).toContain('H1 Header');
expect(lastFrame()).toContain('H2 Header');
expect(lastFrame()).toContain('H3 Header');
expect(lastFrame()).toContain('H4 Header');
});
it('should render code blocks correctly', () => {
const codeMarkdown = `
\`\`\`javascript
const x = 42;
console.log(x);
\`\`\`
`;
const { lastFrame } = render(
,
);
expect(lastFrame()).toContain('const x = 42;');
expect(lastFrame()).toContain('console.log(x);');
});
});
});