Skip to content
Swizec Teller - a geek with a hatswizec.com

Livecoding 51: I did it! My first PR to a big OSS project \o/

This is a Livecoding Recap – an almost-weekly post about interesting things discovered while livecoding. Usually shorter than 500 words. Often with pictures. Livecoding happens almost every Sunday at 2pm PDT on multiple channels. You should follow My Youtube channel to catch me live.

I did it! The gatsby-transform-remark bug I've been working on for a month yields to my assault o/

Not because it's that difficult of a bug. Oh no. Because I was doing dumb things and jumping into a large project like Gatsby is hard.

Previous attempts failed first because I couldn't get my dev environment to work and then because I made a newbie mistake with yarn.lock and got frustrated. πŸ˜…

πŸ‘‰ https://swizec.com/blog/livecoding-recap-48-why-contributing-to-big-opensource-projects/swizec/7848 πŸ‘‰ https://swizec.com/blog/livecoding-recap-50-how-newbie-mistakes-kill-flow/swizec/7901

The bug was more of a feature, really. When Remark generates a table of contents out of your markdown headers, it uses relative links. Like this πŸ‘‡

# Heading
## Subheading 1
## Subheading 2
### Subsubheading
## Subheading 3

That turns into an HTML list with #heading, #subheading-1 (etc) links. Nesting at all.

- Heading (#heading)
- Subheading 1 (#subheading-1)
- Subheading 2 (#subheading-2)
- Subsubheading (#subsubheading)
- Subheading 3 (#subheading-3)

Imagine all of that is HTML with <ul> and <li> and <a> tags. Laying it out like this is easier to read.

This works great when you're only putting tables of contents on each individual page. Render a markdown document, put a TOC on top. Perfect.

But it stops working if you want to make a main table of contents for all your documents. All those relative links stop working. Subheading is on an actual path now.

The fix was to prepend slugs to every URL that mdast-util-toc generates. Best place to do that was deep inside gatsby-transform-remark, in a file called extend-node-type.js.

As far as I can tell, that file is the whole of the markdown transformer. It takes a markdown GraphQL node (flat text at this point) and extends it into something Gatsby can read to make a React-based HTML page.

Our fix went into the aptly named getTableOfContents function.

const addSlugToUrl = function (node) {
if (node.url) {
node.url = withPrefix(`${markdownNode.fields.slug}${node.url}`);
}
if (node.children) {
node.children = node.children.map((node) => addSlugToUrl(node));
}
return node;
};
tocAst.map = addSlugToUrl(tocAst.map);

This happens after all the processing that turns a markdown file into an abstract syntax tree (AST). Basic recursion πŸ‘‡

  • get node
  • if node has url, change it
  • if node has children, call addSlugToUrl to each

Done 😁

Looks simple now that it works, but it sure took a while. Large codebases are fun like that.

Now just gotta figure out how to get absolute absolute paths working. You know, when you're not deploying your site to / but to /something/. Something to do with the --prefix-paths flag when compiling.

Thanks to @lukeed05 for rubber ducking, and thanks to @kylemathews for answering questions when I got stuck. ❀️

Did you enjoy this article?

Published on November 9th, 2017 in Livecoding, Technical

Learned something new?
Want to become a high value JavaScript expert?

Here's how it works πŸ‘‡

Leave your email and I'll send you an Interactive Modern JavaScript Cheatsheet πŸ“–right away. After that you'll get thoughtfully written emails every week about React, JavaScript, and your career. Lessons learned over my 20 years in the industry working with companies ranging from tiny startups to Fortune5 behemoths.

Start with an interactive cheatsheet πŸ“–

Then get thoughtful letters πŸ’Œ on mindsets, tactics, and technical skills for your career.

"Man, love your simple writing! Yours is the only email I open from marketers and only blog that I give a fuck to read & scroll till the end. And wow always take away lessons with me. Inspiring! And very relatable. πŸ‘Œ"

~ Ashish Kumar

Join over 10,000 engineers just like you already improving their careers with my letters, workshops, courses, and talks. ✌️

Have a burning question that you think I can answer?Β I don't have all of the answers, but I have some! Hit me up on twitter or book a 30min ama for in-depth help.

Ready to Stop copy pasting D3 examples and create data visualizations of your own? Β Learn how to build scalable dataviz components your whole team can understand with React for Data Visualization

Curious about Serverless and the modern backend? Check out Serverless Handbook, modern backend for the frontend engineer.

Ready to learn how it all fits together and build a modern webapp from scratch? Learn how to launch a webapp and make your first πŸ’° on the side with ServerlessReact.Dev

Want to brush up on your modern JavaScript syntax?Β Check out my interactive cheatsheet: es6cheatsheet.com

By the way, just in case no one has told you it yet today: I love and appreciate you for who you are ❀️