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.

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

[docs] Further describe where gatsby-* files should belong in a gatsby plugin #13782

Closed
lannonbr opened this issue May 1, 2019 · 5 comments
Closed
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@lannonbr
Copy link
Contributor

lannonbr commented May 1, 2019

Description

When @robert197 was creating a Gatsby plugin, he got caught up on where to place the gatsby-node.js file and it wasn't working for him. I helped debug his issue and it was that he didn't compile the code with babel from the src/ directory up to the root directory of his plugin.

The only place I found this noted to do this is in the last paragraph here: https://www.gatsbyjs.org/docs/creating-a-local-plugin/

It would be good to further document what files should belong in a plugin structure as well as expand upon transpiling the code with babel as many Gatsby plugins are done.

@lannonbr lannonbr added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label May 1, 2019
@gatsbot
Copy link

gatsbot bot commented May 22, 2019

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contributefor more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

@gatsbot gatsbot bot added the stale? Issue that may be closed soon due to the original author not responding any more. label May 22, 2019
@lannonbr lannonbr added not stale and removed stale? Issue that may be closed soon due to the original author not responding any more. labels May 28, 2019
@marcysutton
Copy link
Contributor

This file exists now (the information was already there, just buried in another doc): https://www.gatsbyjs.org/docs/files-gatsby-looks-for-in-a-plugin/

The main action item I see here is to document transpiling of plugin code–but there are two things to note with that:

  1. the transpilation plugin doesn't talk about how to operate on source code, only packages
  2. Gatsby should probably just do that for you. @gatsbyjs/core any input on timing for when Gatsby will handle transpilation of packages automatically?

@sidharthachatterjee
Copy link
Contributor

We do transpile all code in plugin packages since #15284

@robert197 Could you link to a reproduction because this sounds like a potential bug

@marcysutton
Copy link
Contributor

This was opened before the transpilation of packages by default, so it might be a non-issue now!

@marcysutton
Copy link
Contributor

I'm to close this issue as I believe it's resolved, but feel free to open if needed. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

5 participants