Modularize your Gatsby project with local plugins  📜 📦

In yesterday's unauthorized and rum-fueled treasure hunts in the sharky waters around the Gatsby islands we looked at how to modularize your project with local plugins.

YouTube Photo

I've added timestamps to the description, so you can jump straight to the why or the how if you'd like.

The TLDR version of why: I like a tidy ship

To create a local plugin, add a plugins-folder to your project. Inside create a folder for your plugin with an empty package.json file. The name of your plugin will be the same as the name of this folder.

To use your local plugin, add it to your plugins array the same way you would external plugins.

I recommend using the Gatsby pattern for naming plugins but replace gatsby- with local- to make it super clear when looking at your gatsby-config that it's a local plugin. Otherwise, it's an easy mistake to go look for it on the npm registry.

Local Plugin Example

With the folder structure:

gatsby-project/
├─ src/
│  ├─ <all your regular stuff>
├─ plugins/
│  ├─ local-source-youtube/
│  │  ├─ package.json
│  │  ├─ gatsby-node.js
├─ gatsby-config.js
├─ package.json

you may configure the local plugin like so:

module.exports = {
  plugins: [
    {
      resolve: "local-source-youtube",
      options: {
        youTubeIds: ["Bk1jonYPFD4", "TzJfepDjpzM"],
      },
    },
  ],
};

You may also check out the code in the stream work branch of the new pow-site repo.

 
I hope you found this helpful!
Let me know either way 🙏

 
All the best,
Queen Raae

 
PS: We got done super fast but kept on YOLO streaming. Check the YouTube description for timestamps to all the things.

Stuck on a reef in the sharky waters around the Gatsby islands?

Book a 1-on-1 Gatsby Call with Queen Raae. Friendly advice you can put into action immediately, guaranteed!

Serious about Gatsby? Sign up for emails sent every weekday to help you get the most out of Gatsby!