Skip to content

Generate Ids when there are none in local development #4304

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 2 commits into from
Feb 7, 2022
Merged

Generate Ids when there are none in local development #4304

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a75b0e4
Generate Ids when there are no headings
Feb 6, 2022
e41614f
Tweak code
gaearon Feb 7, 2022
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
42 changes: 18 additions & 24 deletions beta/plugins/remark-header-custom-ids.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,32 +32,26 @@ module.exports = ({
visit(tree, 'heading', (node) => {
const children = node.children;
let tail = children[children.length - 1];

// A bit weird: this is to support MDX 2 comments in expressions,
Copy link
Member

Choose a reason for hiding this comment

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

This was a valuable comment so we shouldn't nix it.

// while we’re still on MDX 1, which doesn’t support them.
if (!tail || tail.type !== 'text' || tail.value !== '/}') {
return;
// Generate slugs on the fly (even if not specified in markdown)
// so that it's possible to copy anchor links in newly written content.
let id = slugs.slug(toString(node), maintainCase);
// However, for committed docs, we'll extract slug from the headers.
if (tail && tail.type === 'text' && tail.value === '/}') {
tail = children[children.length - 2];
if (tail && tail.type === 'emphasis') {
// Use custom ID instead.
id = toString(tail);
// Until we're on MDX 2, we need to "cut off" the comment syntax.
tail = children[children.length - 3];
if (tail && tail.type === 'text' && tail.value.endsWith('{/')) {
// Remove the emphasis and trailing `/}`
children.splice(children.length - 2, 2);
// Remove the `{/`
tail.value = tail.value.replace(/[ \t]*\{\/$/, '');
}
}
}

tail = children[children.length - 2];

if (!tail && tail.type !== 'emphasis') {
Copy link
Member

Choose a reason for hiding this comment

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

This was a mistake in the original code btw. It should've used || because otherwise the second check would crash whenever tail is null or undefined.

return;
}

const id = toString(tail);

tail = children[children.length - 3];

if (!tail || tail.type !== 'text' || !tail.value.endsWith('{/')) {
return;
}

// Remove the emphasis and trailing `/}`
children.splice(children.length - 2, 2);
// Remove the `{/`
tail.value = tail.value.replace(/[ \t]*\{\/$/, '');

const data = patch(node, 'data', {});

patch(data, 'id', id);
Expand Down