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.

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

Jump to bottom

Generate Ids when there are none in local development #4304

Merged
merged 2 commits into from
Feb 7, 2022
Merged

Generate Ids when there are none in local development #4304

Changes from 1 commit
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
54 changes: 36 additions & 18 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 @@ -31,33 +31,51 @@ module.exports = ({
return function transformer(tree) {
visit(tree, 'heading', (node) => {
const children = node.children;
const rawHeader = toString(node);
const match = /^.+(\s*\{.*\}\s*)$/u.exec(rawHeader);
/**
* we check if there is a heading and custom id with regex.
* If there is a match then we set the id to be the match[1] which is the custom id
Copy link
Member

@gaearon gaearon Feb 7, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

These comments are repeating the code. It's better if we use the comments for things that aren't clear from the code (like why does the code do things we want it to do rather than what it does).

* else we have to generate id
*/
let id =
match && match.length === 2
? match[1]
: slugs.slug(rawHeader, maintainCase);

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;
}
/**
* If there was a match then we might want to return when they dont have proper heading ids
* Else we generate ids
*/
if (match) {
if (!tail || tail.type !== 'text' || tail.value !== '/}') {
return;
Copy link
Member

Choose a reason for hiding this comment

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

These early exits didn't seem right. We want to assign ID from a slug regardless of whether we succeeded to modify the tail.

}

tail = children[children.length - 2];
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;
}
if (!tail && tail.type !== 'emphasis') {
return;
}

const id = toString(tail);
id = toString(tail);

tail = children[children.length - 3];
tail = children[children.length - 3];

if (!tail || tail.type !== 'text' || !tail.value.endsWith('{/')) {
return;
if (!tail || tail.type !== 'text' || !tail.value.endsWith('{/')) {
return;
}
/**
* We have to splice the children only if they contain heading ids
*/
// Remove the emphasis and trailing `/}`
children.splice(children.length - 2, 2);
// Remove the `{/`
tail.value = tail.value.replace(/[ \t]*\{\/$/, '');
}

// 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