React-styleguidist: Upgrade react-docgen to 5.0.0 beta

Created on 6 May 2019  路  17Comments  路  Source: styleguidist/react-styleguidist

A new version has TypeScript support, so no need to extra plugins anymore.

  • [ ] Use tsType similar to flowType.
  • [ ] Update docs, remove all mentions to react-docgen-typescript.

This is a breaking change. Should be based on #1288.

help wanted react-docgen released

All 17 comments

So are we going to merge #1288 first? Or maybe I can just add additional commits to #1288?

Merging will block master for other possible releases, and since both changes are breaking it would be better to continue in the same PR. This would be super cool actually ;-)

ok, I'm on it

@smashercosmo Did you have time to work on that? Need any help? 馃

Started working on it. Haven't finished yet ( I'll try to finish on weekends

@smashercosmo Cool!!

Seems like https://github.com/Jmeyering/react-docgen-annotation-resolver doesn't work with [email protected]. So first we need to submit PR there.

Upd: The problem is that recast was removed in react-docgen v.5

Upd2: Submitted PR to react-docgen-annotation-resolver https://github.com/Jmeyering/react-docgen-annotation-resolver/pull/5

mmm... guys @sapegin @okonet you could just tell me that you were fine having react-docgen-annotation-resolver code in styleguidist repo, because I've spent my time doing exactly the same PR as https://github.com/styleguidist/react-styleguidist/pull/1387, but was waiting for any response from the react-docgen-annotation-resolver repo owner.

@smashercosmo I'm so sorry 馃槩I was going to ask you to push what you have done so far but @okonet was too fast with this PR. Mind reviewing it?

was waiting for any response from the react-docgen-annotation-resolver repo owner

Me too. I've sent them an email asking to transfer the repo to our org if they don't want to maintain it. But for now let's keep a fork.

@smashercosmo that鈥檚 actually exactly the code you wrote. I鈥檇 love you to take the ownership of this package as soon as we have basic monorepo setup for this project. The reason I copied it over is exactly the same you mentioned: I wanted to try integrating it without waiting for the whole review and merge process. You鈥檙e welcome to jump on this branch and help me finilazing it but it looks like it won鈥檛 work without some fixes on React-docgen side. Here is the related issue: https://github.com/reactjs/react-docgen/issues/375

@okonet yeah, ok, I understand things like that happen in OSS. Just was a bit upset, because my not-pushed PR was almost the same as yours (I mean not only the react-docgen-annotation-resolver part :)) But of course I would be happy to help with both getting https://github.com/styleguidist/react-styleguidist/pull/1387 merged and with whatever other styleguidist issues you'd like to resolve. I use styleguidist heavily in my work and definitely want to contribute back.

@smashercosmo don鈥檛 be! I was just eager to try integrating it after chatting with Artem :-). We can continue with your PR but as I mentioned that doesn鈥檛 solve all the issues. Which brings me to the next question: should we skip the annotated components for now?

@okonet well, we can always write our own custom handler for extracting types from styled-components.

I tried and gave up. Do you want to give it a try?

Yeah, I can try)

Are there any updates regarding this?

:tada: This issue has been resolved in version 11.0.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

Was this page helpful?
0 / 5 - 0 ratings

Related issues

mealeyst picture mealeyst  路  3Comments

davidjb picture davidjb  路  3Comments

ZwaarContrast picture ZwaarContrast  路  4Comments

eduardoinnorway picture eduardoinnorway  路  3Comments

magicmark picture magicmark  路  3Comments