{"id":6791,"date":"2020-02-20T04:52:04","date_gmt":"2020-02-19T23:52:04","guid":{"rendered":"https:\/\/ahmadawais.com\/?p=6791"},"modified":"2020-02-21T00:22:22","modified_gmt":"2020-02-20T19:22:22","slug":"gatsby-package-manager","status":"publish","type":"post","link":"https:\/\/ahmadawais.com\/gatsby-package-manager\/","title":{"rendered":"Introducing:
Gatsby Package Manager"},"content":{"rendered":"

I’ve been using Gatsby for a couple of years now. If you know me you know I hate repetition and that most of my open-source software<\/a> revolve around solving a problem that I don’t want to solve again and again.<\/p>\n

That’s why I am launching gatsby-package-manager (gpm)<\/code><\/a> (\ud83c\udf1f the repo<\/a>)<\/p>\n<\/section>\n

\"Gatsby<\/a><\/div>\n
\n

Gatsby Package Manager gpm<\/code><\/a>#<\/a><\/h2>\n

The gpm<\/span><\/span><\/code><\/a> helps you install a Gatsby package with all of its dependencies. It also allows you to read the docs for a package right there in the command line \u2014 without having to browse any sites.<\/p>\n

Yes, that’s it. Currently, the idea is quite simple which I suppose will grow as the Gatsby ecosystem grows and we have more things to deal with.<\/p>\n

\ud83c\udf1f Star Gatsby Package Manager on GitHub<\/a> & follow Awais<\/a> to get updates<\/div>\n

The Problem gpm<\/code> Solves#<\/a><\/h3>\n

You know what npm<\/code> and yarn<\/code> do? They install a package and all of their dependencies for you so that you only have to remember what the package name is and not what their dependencies look like.<\/p>\n

Before gpm<\/code> you had to manually install a Gatsby package along with all the peer dependencies. I for one could never remember all of them.<\/p>\n

#TrueStory<\/strong>:#<\/a><\/h3>\n

\ud83e\udd14 So, it goes like this. I wake up one fine morning. Today, I’m working on a Gatsby site duh<\/em>. I love to write content with MDX.<\/p>\n

\ud83d\ude48 I go ahead and npm install gatsby-plugin-mdx<\/code> but that’s not all I have to install. For the life of me, I can’t remember the peer dependencies needed to be installed.<\/p>\n

\ud83e\uddd0 So, I Google Gatsby Plugin MDX, land on the plugin page<\/a>, scroll\u2026scroll\u2026scroll\u2026table of contents\u2026why MDX\u2026yada\u2026yadda\u2026yadda\u2026 there you are. I then npm install @mdx-js\/mdx @mdx-js\/react<\/code>.<\/p>\n

\u2620\ufe0f That’s not quite how it should work. And then I close the tab and forget to read the first section of the readme.md<\/code> docs \u2014 since I just need a refresher on how to configure this package. I’ve done it before. The entire story repeats itself.<\/p>\n

gpm<\/code> saves the day:#<\/a><\/h3>\n

\ud83e\udd14 I run gpm install gatsby-plugin-mdx<\/code> and the package + the peer dependencies get installed. I also get a link the docs that I can click to read them online or most probably I fetch the docs in the terminal by running gpm docs gatsby-plugin-mdx<\/code>.<\/p>\n

\ud83d\ude0e Easy peasy lemon squeezy.<\/p>\n

\ud83c\udf1f Star Gatsby Package Manager on GitHub<\/a> & follow Awais<\/a> to get updates<\/div>\n<\/section>\n
\n
\n

Installation & Usage#<\/a><\/h2>\n<\/div>\n<\/div>\n
<\/a><\/p>\n

Let’s go through the installation and usage of gpm<\/code> step by step.<\/p>\n

\u276f Install gpm<\/code>#<\/a><\/h3>\n<\/section>\n
\n\"Installing<\/a><\/div>\n
\n

First of all install the gpm<\/code> npm package.<\/p>\n

# Install globally via npm.\r\nnpm install -g gatsby-package-manager\r\n\r\n# OR: Install globally via yarn.\r\nyarn global add gatsby-package-manager\r\n<\/pre>\n
Now you have access to gpm<\/code> or gatsby-package-manager<\/code> in your command line. Go ahead and use gpm<\/code> to install a pacakge.<\/p><\/blockquote>\n
\n
\u276f Install a package#<\/a><\/h3>\n<\/section>\n
\n\"Install<\/a>\n<\/div>\n
\n
Installs a Gatsby package with all of its peer dependencies.<\/p>\n
# 1: Interactive mode.\r\n# Type `gpm` and answer the questions asked.\r\ngpm\r\n\r\n# Alternatively, you can also run it via:\r\ngatsby-package-manager\r\n\r\n# 2: Direct mode.\r\n# Several ways to run the same command.\r\ngpm install \r\ngpm i \r\ngpm install gatsby-plugin-mdx\r\ngpm i gatsby-plugin-mdx\r\n<\/pre>\n
\n
\u276f Docs for a package#<\/a><\/h3>\n<\/section>\n
\n\"Docs<\/a>\n<\/div>\n
\n
Prints the docs, i.e., readme.md<\/code> file of a package in the command line.<\/p>\n
# Several ways to run the same command.\r\ngpm docs \r\ngpm d \r\ngpm docs gatsby-plugin-mdx\r\ngpm d gatsby-plugin-mdx\r\n<\/pre>\n
\n
\u276f Configure npm<\/code> or yarn<\/code>#<\/a><\/h3>\n
The gatsby-package-manager (gpm)<\/code> stores your choice of using npm<\/code> or yarn<\/code> in ~\/.config\/configstore\/gatsby-package-manager.json<\/code> file. This choice can be re-configured by using the option --config<\/code> or -c<\/code> when running gpm<\/code>.<\/p>\n
gpm --config\r\ngpm -c\r\ngpm i gatsby-plugin-mdx -c\r\n<\/pre>\n
\n
\u276f Help documentation#<\/a><\/h3>\n
You can run gpm --help<\/code> or gpm -h<\/code> to access the help documentation.<\/p>\n<\/section>\n
\n
\n
What’s Next?#<\/a><\/h2>\n<\/div>\n<\/div>\n
\n
That’s all for now but I see this as an opportunity for what comes next. I believe with time Gatsby packages, the plugins, and themes, they’ll get a bit more complicated. gpm<\/code> will help make Gatsby package management easy.<\/p>\n
Some things that I could think gpm<\/code> can do in the future:<\/p>\n