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

fix(gatsby-transformer-react-docgen): always create description nodes #14876

Merged
merged 3 commits into from
Jun 18, 2019

Conversation

jquense
Copy link
Contributor

@jquense jquense commented Jun 18, 2019

Description

Gatsby started warning about description being resolved by two fields. In practice what was happening is that sometimes it'd just be the inferred string and other times the node here. This changes ensures that description is always a ComponentDescription node

Related Issues

@jquense jquense requested a review from a team as a code owner June 18, 2019 16:47
Copy link
Contributor

@DSchau DSchau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

Could you:

  1. Provide a description for what this is doing/fixing?
  2. Maybe add a unit test so we keep this fixed?

Thanks Jason!

@jquense
Copy link
Contributor Author

jquense commented Jun 18, 2019

oops sorry, missed the template doing the github editor. I don't quite know how i'd unit test this, the "bug" is more in the interaction between gatsby's schema generation than anything the plugin does does.

@jquense
Copy link
Contributor Author

jquense commented Jun 18, 2019

arg gonna have to actually pull this down sorry

@DSchau DSchau added status: awaiting author response Additional information has been requested from the author status: WIP labels Jun 18, 2019
@jquense
Copy link
Contributor Author

jquense commented Jun 18, 2019

k this should be good, added some kinda of test as well

@DSchau DSchau changed the title fix: always create description nodes Jun 18, 2019
@DSchau DSchau removed status: WIP status: awaiting author response Additional information has been requested from the author labels Jun 18, 2019
Copy link
Contributor

@DSchau DSchau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable. Merging and publishing.

Or "mublishing" cc @wardpeet

@DSchau DSchau merged commit 48a9e10 into master Jun 18, 2019
@DSchau DSchau deleted the always-create-description branch June 18, 2019 21:46
@wardpeet
Copy link
Contributor

Fixed in gatsby-transformer-react-docgen@4.0.3

m-allanson added a commit that referenced this pull request Jun 19, 2019
* master: (41 commits)
  chore(release): Publish
  fix(gatsby): Normalize paths for run queries before caching (#14910)
  chore(release): Publish
  fix(gatsby-cli): add missing node-fetch dependency (#14908)
  feat(blog): Site Showcase Validator blogpost (#14855)
  chore(gatsby-remark-graphviz): add --ignore for test directory (#14906)
  fix(tutorials): rename "advanced" to "additional (#14847)
  fix(starters): update gatsby monorepo (#14886)
  chore(starters): Switch to useStaticQuery (#14857)
  chore(release): Publish
  Add status bar to bottom of screen during develop (#14874)
  chore(release): Publish
  fix(*): fix gatsby-cli dep in source-filesystem & plugin-sharp (#14881)
  docs(www): 25 Workflows - Embedding components in Markdown with MDX (#14543)
  docs(blog): add case study blog post for The Couch / Prima (#14871)
  docs(www): 25 Workflows - Adding CSS and/or Sass (#14779)
  fix(gatsby-transformer-react-docgen): always create description nodes (#14876)
  chore(release): Publish
  chore(gatsby): revert progressbar functionality (#14884)
  Revised "winning over engineering leaders" Docs page (#14830)
  ...
mxxk pushed a commit to mxxk/gatsby that referenced this pull request Jun 21, 2019
…gatsbyjs#14876)

* fix: always create description nodes

* Update on-node-create.js

* fix tests
johno pushed a commit to johno/gatsby that referenced this pull request Jul 17, 2019
…gatsbyjs#14876)

* fix: always create description nodes

* Update on-node-create.js

* fix tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants