DocsPage not populated from JSDoc comments #103
Comments
IanVS
pushed a commit
that referenced
this issue
Feb 3, 2022
Related to #103 #2 #79 This PR adds doc-gen via react-docgen-typescript. | | Before | After| | --- | --- | --- | | Sidebar |  |  | Docs |  |  I haven't noticed any significant impact to speed. 🎉 It's hooked up to the storybook config so it should act as a drop-in for the webpack functionality for typescript types.
|
Note that https://github.com/eirslett/storybook-builder-vite/releases/tag/v0.1.15 includes a fix that will make this work correctly for typescript projects. Keeping this open until we support non-typescript as well, though. |
IanVS
added a commit
that referenced
this issue
Apr 3, 2022
Fixes #103 Closes #190 Fixes #2 This takes a slightly different approach from #190. Instead of using a babel transform, this creates a vite plugin, similar to the vue-docgen plugin, but based on the babel-plugin-react-docgen. This gives us the chance to rely directly on react-docgen, without needing another package in between, and it avoids being accidentally overwritten if users replace our @vitejs/plugin-react with their own config. This new vite plugin is not configurable like the babel plugin is, but I'm not certain those configurations are necessary in the first place. If we hear from users that it's something they need, we can find a way to make them customizable, but I prefer to avoid extra options if possible. This version does not create a global list of all the docs, like the babel plugin does (`DOC_GEN_COLLECTION_NAME`). I looked through the storybook source, and it doesn't seem like anything still relies on it, so I think it's just a legacy detail for now that we can probably avoid supporting. I've updated the react example to demonstrate the use of the plugin, so feel free to check this out there.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I believe this is a known issue, but I didn't see an issue opened for it specificially.
Normally, any JSDoc written for the component or the props will appear in the docs page, but this does not occur with the vite builder. I believe this is due to
react-docgenrunning in the default webpack builder. There are efforts underway to decouple them, as mentioned in #46 (comment).The text was updated successfully, but these errors were encountered: