No helper functions about gatsby-source-git

[stevetweeddale]

Hi @Behinder! When writing support requests to strangers, please try to sound friendly 😄

Here's what the readme actually says:

[gatsby-source-git] sucks the files into the graph as File nodes, as if you'd configured gatsby-source-filesystem on that directory. As such, all the transformer plugins that operate on files should work exactly as they do with gatsby-source-filesystem

Which isn't the same thing as saying "this plugin is a drop-in replacement for gatsby-source-filesystem and shares every aspect of its API" (which would indeed be an overstatement). As @CanRau mentioned, this is a source plugin, so its job is to get nodes into the graph. Specifically, it puts nodes that look just like the ones created by gatsby-source-filesystem.

Now gatsby-source-filesystem then also includes the createFilePath helper as a convenience for later on in the process, as often people want to create a pretty URL from a filesystem path when programmatically creating pages from graph nodes. I didn't bundle a copy of that function in this plugin because it's nothing to do with sourcing, and I don't want to maintain a fork of something that's already in the main gatsby repo. If you need that helper, then include it like so:

const { createFilePath } = require(`gatsby-source-filesystem`)

Hope that clears things up for you!

[Behinder]

It is difficult to “sound” in writing 😊 thanks for that explanation, it would help if such explanations be put into documentation as it is often confusing to see just code example and I usually lost interest in plugins I cannot understand 😁 Gatsby-source-filesystem is also source plugin so it was valid assumption git plugin is meant to replace it to fetching content from different source than local. But never mind , to not sound unfriendly I try to not sound at all and stop commenting :)

…

On Thursday, 12 March 2020, Stephen Tweeddale ***@***.***> wrote: Hi @Behinder <https://github.com/Behinder>! When writing support requests to strangers, please try to sound friendly 😄 Here's what the readme actually says: [gatsby-source-git] sucks the files into the graph as File nodes, as if you'd configured gatsby-source-filesystem on that directory. As such, all the transformer plugins that operate on files should work exactly as they do with gatsby-source-filesystem Which isn't the same thing as saying "this plugin is a drop-in replacement for gatsby-source-filesystem and shares every aspect of its API" (which would indeed be an overstatement). As @CanRau <https://github.com/CanRau> mentioned, this is a source plugin, so its job is to get nodes into the graph. Specifically, it puts nodes that look just like the ones created by gatsby-source-filesystem. Now gatsby-source-filesystem then also includes the createFilePath helper as a convenience for later on in the process, as often people want to create a pretty URL from a filesystem path when programmatically creating pages from graph nodes. I didn't bundle a copy of that function in this plugin because it's nothing to do with sourcing, and I don't want to maintain a fork of something that's already in the main gatsby repo. If you need that helper, then include it like so: const { createFilePath } = require(`gatsby-source-filesystem`) Hope that clears things up for you! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#13 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAEQPFXFGX5SAIXVWQZTN4LRHDXV7ANCNFSM4LF37XWA> .

[stevetweeddale]

I've updated the readme to hopefully reduce the likelihood of the same confusion going forwards. Thanks everyone!

[CanRau]

I guess it's same in sourcing, not necessarily in creating as it's a source plugin. The filesystem one provides this helper for convenience. 🤔

Not everyone is using createFilePath at least I'm not and if I needed it I can get it from gatsby-source-filesystem.

[Behinder]

So what declaration should I put in Gatsby-node.js? Just require(‘Gatsby-source-git’) ?? This is confusing for me as I don’t see code example, just example of GraphQL query but I have to build nodes both from git and from local file system.

…

On Wednesday, 11 March 2020, Can Rau ***@***.***> wrote: I guess it's same in sourcing, not necessarily in creating as it's a source plugin. The filesystem one provides this helper for convenience. 🤔 Not everyone is using createFilePath at least I'm not and if I needed it I can get it from gatsby-source-filesystem. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#13 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAEQPFVDSW2VXO557YJ37PDRHADOLANCNFSM4LF37XWA> .

[CanRau]

You create the pages like with most other source plugins, following the example in https://www.gatsbyjs.org/tutorial/part-seven/ and https://www.gatsbyjs.org/docs/creating-and-modifying-pages/#creating-pages-in-gatsby-nodejs
You change the query from MarkdownRemark to that of the source plugin.