Implemented support for parsing multiple exports #4
Conversation
|
@Aaron-Pool AWESOME!! Thanks so much for putting this together! One comment is that the peer dep for @pocka Would love to get this merged ASAP 🙏🙏🙏 😁 |
|
@shilman Ah, good point on the version number. I'll get that fixed. For the second point though, why a major version bump? It shouldn't break anyone current usage--unless I misunderstand something. It's only adding additional docgen info to exports that were previously getting none. I thought major version bumps were reserved for incompatible API changes? |
Oh, my bad:scream: It should be |
|
@Aaron-Pool major version bump since Certainly the current code here is not compatible with 3.x because |
|
Ok, I went ahead and removed the extra tests about export default just to reduce the noise on the PR. I also updated the peer dependency as requested. |
|
Published in v1.2.0 For the |
|
@pocka Thanks for the merge. And I honestly have no idea how |
|
@Aaron-Pool |
Previously, the loader injects `component.__docgenInfo = ...` to the source code regardless of existence of the `component` variable. This breaks Component files that exports component with default export statement. This commit changes how the loader inject `__docgenInfo` to components. In addition to that, it fixes inconsistent path for `__docgenInfo`. For SFCs, we can use this: ```js import Component from 'component.vue' console.log(Component.__docgenInfo) ``` But for non-SFCs, we need to dig `option` property: ```js import Component from 'component.js' console.log(Component.options.__docgenInfo) ``` This commit remove the inconsistency by attaching `__docgenInfo` to the component directly. You can access `component.__docgenInfo` even for non-SFCs. --- The code of default export replacement is written by @Aaron-Pool. Thanks! Thread: <#4 (comment)> Code: <https://astexplorer.net/#/gist/2dfbbbc37e0f53d31bd6f2a1bedca9c0/latest>
Related issues / Problem
vue-styleguidist/vue-styleguidist#665
What I did
Updated
vue-docgen-apito4.1.1, then converted loader to useparseMultito support multiple exports in a file. Added a test for multiple exports as well.Also, two of your other tests were operating under the assumption that default exports weren't supported by vue-docgen-api, but I think that's not the case. It seems like it just doesn't support
export defaultwhen used withVue.extends({})(which should maybe be a case @elevatebart should add support for, since I think that's a common method to get correct typescript intellisense?). I fixed those tests and also added cases for mixed exports (default and named). Those changes might be outside of the scope of this PR, so I put them in a separate commit and can move them out, if requested.Checklist
- Again, see note about test changes above, I can move that commit out if need be.(I just removed this commit for now, to reduce the noise)@pocka @shilman @elevatebart