feat(gatsby-transformer-react-docgen): allow parsing typescript files #11265
Conversation
| @@ -10,6 +10,19 @@ const digest = str => | |||
| const propsId = (parentId, name) => `${parentId}--ComponentProp-${name}` | |||
| const descId = parentId => `${parentId}--ComponentDescription` | |||
|
|
|||
| function canParse(node) { | |||
| return ( | |||
| node && | |||
There was a problem hiding this comment.
I don't think this check is really needed!
| node && |
There was a problem hiding this comment.
(although it will be with one of the tests I added, e.g. null node 😩, so that'll have to be fixed when/if this is updated)
There was a problem hiding this comment.
ya it more out of an abundance of caution i can remove if you like?
There was a problem hiding this comment.
It's probably OK. Let's just merge this, thank you!
| node && | ||
| (node.internal.mediaType === `application/javascript` || | ||
| // Typescript doesn't really have a mime type and .ts files are a media file :/ | ||
| node.internal.mediaType === `application/typescript` || |
There was a problem hiding this comment.
Is there a reason we need all of these checks? I would've thought there's one condition we could reliably use, i.e.
return (
node.internal.mediaType === `application/javascript` ||
node.internal.mediaType === `application/typescript`
)There was a problem hiding this comment.
The above actually won't work, since mime types has no typescript mime, I added it in case the input node was from another source plugin that does use the likely mime type.
In the case of File nodes we have to check the extension to distinguish the type :/
DSchau
changed the title
|
Published as |
|
🎉 |
|
@jquense I'm getting the following error when attempting to parse a TS file: error There was a problem parsing component metadata for file: "layout.tsx"
8 | interface LayoutProps {
9 | children?: React.ReactNode
> 10 | foo: string
| ^
11 | }
12 |
13 | /**
SyntaxError: Unexpected token (10:2)
- index.js:3834 Object.raise
[gatsby-ts-docgen]/[@babel]/parser/lib/index.js:3834:17
- index.js:5142 Object.unexpected
[gatsby-ts-docgen]/[@babel]/parser/lib/index.js:5142:16
- index.js:1542 Object.flowObjectTypeSemicolon
[gatsby-ts-docgen]/[@babel]/parser/lib/index.js:1542:12
...Seems to be related to the |
|
@thchia yeah at the moment full ts support isn't there, this adds the ability to even see .ts/.tsx files. We still need better upstream react-docgen support, e.g. reactjs/react-docgen#320 |
|
@jquense would adding https://github.com/styleguidist/react-docgen-typescript be of any help? I'm playing around now trying to switch parsers based on the file type. |
|
I'd really like to not deal with that, and instead just snag the proptypes handler from there and use it with the original react-docgen. |
|
Do you mean not deal with adding an extra dependency? Because it looks like the snaggable bits form the bulk of the code anyway. Either way I'm with you on not having multiple parser instances. |
|
it's a few things, not having the extra dep but also not having to deal with inconsistencies and differences between the two tools. |
Typescript has no mime type :/