Skip to content

fix: pipes in tables #1205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 8, 2025
Merged

fix: pipes in tables #1205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d81496f
fix: pipes in tables
kellyjosephprice Oct 8, 2025
e9da889
chore: cleanup
kellyjosephprice Oct 8, 2025
6ea8ab8
fix: skip escaped pipes
kellyjosephprice Oct 8, 2025
8f8b5e1
chore: obsolete snapshot
kellyjosephprice Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions __tests__/compilers/tables.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@ import { visit, EXIT } from 'unist-util-visit';

import { mdast, mdx } from '../../index';

import {
jsxTableWithInlineCodeWithPipe,
tableWithInlineCodeWithPipe,
tableWithInlineCodeWithEscapedPipe,
tableWithPipe,
} from './tables/fixtures';

describe('table compiler', () => {
it('writes to markdown syntax', () => {
const markdown = `
Expand Down Expand Up @@ -338,4 +345,65 @@ describe('table compiler', () => {
mdx(ast);
}).not.toThrow();
});

describe('escaping pipes', () => {
it('compiles tables with pipes in inline code', () => {
expect(mdx(tableWithInlineCodeWithPipe)).toMatchInlineSnapshot(`
"| | |
| :----------- | :- |
| \`foo \\| bar\` | |
"
`);
});

it('compiles tables with escaped pipes in inline code', () => {
expect(mdx(tableWithInlineCodeWithEscapedPipe)).toMatchInlineSnapshot(`
"| | |
| :----------- | :- |
| \`foo \\| bar\` | |
"
`);
});

it('compiles tables with pipes', () => {
expect(mdx(tableWithPipe)).toMatchInlineSnapshot(`
"| | |
| :--------- | :- |
| foo \\| bar | |
"
`);
});

it('compiles jsx tables with pipes in inline code', () => {
expect(mdx(jsxTableWithInlineCodeWithPipe)).toMatchInlineSnapshot(`
"<Table align={["left","left"]}>
<thead>
<tr>
<th style={{ textAlign: "left" }}>
force
jsx
</th>

<th style={{ textAlign: "left" }}>

</th>
</tr>
</thead>

<tbody>
<tr>
<td style={{ textAlign: "left" }}>
\`foo | bar\`
</td>

<td style={{ textAlign: "left" }}>

</td>
</tr>
</tbody>
</Table>
"
`);
});
});
});
311 changes: 311 additions & 0 deletions __tests__/compilers/tables/fixtures.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,311 @@
export const tableWithInlineCodeWithPipe = {
type: 'root',
children: [
{
type: 'table',
children: [
{
type: 'tableRow',
children: [
{
type: 'tableHead',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
{
type: 'tableHead',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
],
},
{
type: 'tableRow',
children: [
{
type: 'tableCell',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '`foo | bar`',
},
],
},
],
},
{
type: 'tableCell',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
],
},
],
align: ['left', 'left'],
},
],
};

export const tableWithInlineCodeWithEscapedPipe = {
type: 'root',
children: [
{
type: 'table',
children: [
{
type: 'tableRow',
children: [
{
type: 'tableHead',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
{
type: 'tableHead',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
],
},
{
type: 'tableRow',
children: [
{
type: 'tableCell',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '`foo \\| bar`',
},
],
},
],
},
{
type: 'tableCell',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
],
},
],
align: ['left', 'left'],
},
],
};

export const tableWithPipe = {
type: 'root',
children: [
{
type: 'table',
children: [
{
type: 'tableRow',
children: [
{
type: 'tableHead',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
{
type: 'tableHead',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
],
},
{
type: 'tableRow',
children: [
{
type: 'tableCell',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: 'foo | bar',
},
],
},
],
},
{
type: 'tableCell',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
],
},
],
align: ['left', 'left'],
},
],
};

export const jsxTableWithInlineCodeWithPipe = {
type: 'root',
children: [
{
type: 'table',
children: [
{
type: 'tableRow',
children: [
{
type: 'tableHead',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: 'force\njsx',
},
],
},
],
},
{
type: 'tableHead',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
],
},
{
type: 'tableRow',
children: [
{
type: 'tableCell',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '`foo | bar`',
},
],
},
],
},
{
type: 'tableCell',
children: [
{
type: 'paragraph',
children: [
{
type: 'plain',
value: '',
},
],
},
],
},
],
},
],
align: ['left', 'left'],
},
],
};
Loading