Next/refactor #51
Next/refactor #51
Conversation
Output docs under actual component name--not a different displayName. Output component docs based on react-docgen resolvers (multiple components supported).
…react-docgen handlers. Ignore macos directory files when testing.
|
@CLL80 thanks so much for this PR and converting over to using the Recast AST walker. Let me dig through this PR a bit more and run some tests on my Storybook instances. |
|
No problem. Let me know if I can clarify anything. Recast is used to get the actual name of the component where props are defined, and only because the actualNameHandler is heavily based on react-docgen's default displayNameHandler—a dependency of this plugin which already uses recast. I'm sure we could do this without it but am not sure this is necessary. This is to correct an error that you may have seen and I know has caused some pain among the users of this plugin—docs may be output under an incorrect name if there is more than one component export—it would take the name of the last component in the file—whether or not the docs actually pertained to this. |
|
@binomialstew can you do me a huge favor and rebase your branch? i just rebased and merged my other stuff. thanks! edit: actually, don't worry about this. I brought over your changes to #54 and I'm adding a few more tests from this and the storybook issue tracker. |
There is a lot of redundancy between this plugin and react-docgen. This PR relies on react-docgen as much as possible to eliminate this redundancy. For example, we don't need to check the AST visitor types because react-docgen handles the doc generation based on the existing components. This PR also adds support for multiple component docs export from the same file. It also addresses an issue where the generated docs would be stored under an incorrect name (the last component defined in the file) even when they were defined on another component.