Skip to content
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.

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

chore: updated handling of markdown headers #3896

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
80 changes: 68 additions & 12 deletions packages/markdown/src/lib/deserializer/utils/deserializeMd.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -341,11 +341,29 @@ describe('deserializeMd', () => {
expect(deserializeMd(editor, input)).toEqual(output);
});

it('should deserialize headings', () => {
const input = Array.from(
{ length: 6 },
(_, i) => `${'#'.repeat(i + 1)} Heading ${i + 1}`
).join('\n\n');
it('should deserialize line break tags', () => {
const input = 'Line 1<br>Line 2';

const output = (
<fragment>
<hp>
<htext>Line 1</htext>
<htext>{'\n'}</htext>
<htext>Line 2</htext>
</hp>
</fragment>
);

expect(deserializeMd(editor, input)).toEqual(output);
});

it('should deserialize all heading levels (h1-h6)', () => {
const input = `# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6`;

const output = (
<fragment>
Expand All @@ -361,16 +379,54 @@ describe('deserializeMd', () => {
expect(deserializeMd(editor, input)).toEqual(output);
});

it('should deserialize line break tags', () => {
const input = 'Line 1<br>Line 2';
it('should handle headings with multiple spaces', () => {
const input = `# Heading 1
## Heading 2
### Heading 3 `;

const output = (
<fragment>
<hp>
<htext>Line 1</htext>
<htext>{'\n'}</htext>
<htext>Line 2</htext>
</hp>
<hh1>Heading 1</hh1>
<hh2>Heading 2</hh2>
<hh3>Heading 3</hh3>
</fragment>
);

expect(deserializeMd(editor, input)).toEqual(output);
});

it('should handle more than 6 hashes as h6', () => {
const input = `####### Should be h6`;

const output = (
<fragment>
<hh6>Should be h6</hh6>
</fragment>
);

expect(deserializeMd(editor, input)).toEqual(output);
});

it('should handle headings with no space after hash', () => {
const input = `#No space`;

const output = (
<fragment>
<hp>#No space</hp>
</fragment>
);

expect(deserializeMd(editor, input)).toEqual(output);
});

it('should handle escaped hashes', () => {
const input = `\\# Not a heading
\\## Also not a heading`;

const output = (
<fragment>
<hp># Not a heading</hp>
<hp>## Also not a heading</hp>
</fragment>
);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,31 @@ export const remarkDefaultElementRules: RemarkElementRules = {
},
heading: {
transform: (node, options) => {
const depth = Math.max(1, Math.min(6, node.depth ?? 1));

const headingType = {
1: 'h1',
2: 'h2',
3: 'h3',
4: 'h4',
5: 'h5',
6: 'h6',
}[node.depth ?? 1];
}[depth];

const type = options.editor.getType({ key: headingType });

if (!type) {
console.warn(`Heading type ${headingType} not registered in editor`);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we want to warn here. We could default to the latest heading type supported (e.g. h3)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the issue with this is that h3 will be confusing. Its difficult to understand the issue otherwise. I will keep it on p unless you insist.

Goldziher marked this conversation as resolved.
Show resolved Hide resolved

return {
children: remarkTransformElementChildren(node, options),
type: options.editor.getType({ key: 'p' }),
};
}

return {
children: remarkTransformElementChildren(node, options),
type: options.editor.getType({ key: headingType }),
type: type,
};
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ export const remarkTransformElementChildren = (
node: MdastNode,
options: RemarkPluginOptions
): TDescendant[] => {
const { children } = node;
const { children = [] } = node;

if (!children || children.length === 0) {
if (children.length === 0) {
return [{ text: '' }];
}

Expand Down
Loading