Ensure a consistent schema for gatsby-plugin-documentationjs and add TypeScript support

[devongovett]

This adds a schema definition for gatsby-plugin-documentationjs to ensure that it is consistent no matter what files are actually processed. Currently, with gatsby's automatic schema generation, the schema can be missing fields if they are unused by the code that is being parsed and therefore the query would have to change as the code changes. This ensures that the schema will have all fields available no matter what.

Also, TypeScript support was recently added to documentationjs, so this enables .ts and .tsx files to be processed as well.

[freiksenet]

This is awesome. I'll test it with Gatsby docs website.

[pieh]

This (and other JSON fields in DoctrineType) do change schema that will be generated (which is not a blocker - just wanted to mentioned that we would need to bump major as this will be breaking change)

[freiksenet]

I feel that if shape of those types is defineable, it should be fully typed. JSON type should only be used in cases where shape of data is impossible to define.

[devongovett]

Examples probably can, but I specifically made the ones in DoctrineType JSON because they can be circularly typed, and therefore impossible to query with GraphQL...

[freiksenet]

Thank you!

[gatsbot]

Holy buckets, @devongovett — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. We’ve got Gatsby t-shirts, stickers, hats, scrunchies, and much more. (You can also unlock even more free swag with 5 contributions — wink wink nudge nudge.) See gatsby.dev/swag for details.
2. We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. Accept the invite by visiting https://github.com/orgs/gatsbyjs/invitation. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

[freiksenet]

Published as [email protected] (because of possible breaking change). Thank you @devongovett!

[pieh]

I think we still need to do some work here -

gatsby/packages/gatsby-transformer-documentationjs/package.json

Line 11 in 616fb24

"documentation": "^9.0.0",

probably need to be bumped to ^10.1.0 (to actually support Typescript - according to https://github.com/documentationjs/documentation/blob/master/CHANGELOG.md )

[devongovett]

Oops, yes. 🤦‍♂️ will make another pr