Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Addon-docs: Fix ArgsTable union type handling in Vue/TS #12158

Merged
merged 1 commit into from
Aug 20, 2020
Merged

Addon-docs: Fix ArgsTable union type handling in Vue/TS #12158

merged 1 commit into from
Aug 20, 2020

Conversation

HerrBertling
Copy link

@HerrBertling HerrBertling commented Aug 20, 2020 •
edited by shilman
Loading

Issue: #11944

What I did

In the addon-docs, the vue-docgen-api has an entry elements for union types but the expected entry (with the same content) is value.

This fix sanitizes the data within the specific vue-docgen-api hook extractComponentSectionArray so that the item we throw into extractProp() contains the expected object 😊

How to test

shilman
shilman requested changes Aug 20, 2020
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix. Looks great except for one possible bug that I'm concerned about.

addons/docs/src/lib/docgen/extractDocgenProps.ts Show resolved Hide resolved
shilman
shilman approved these changes Aug 20, 2020
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

False alarm

addons/docs/src/lib/docgen/extractDocgenProps.ts Show resolved Hide resolved
@shilman shilman added this to the 6.0.x milestone Aug 20, 2020
@shilman shilman changed the title fix(addon-docs): correctly parse union types in Vue/TS Addon-docs: Fix union type handling in Vue/TS Aug 20, 2020
@shilman shilman changed the title Addon-docs: Fix union type handling in Vue/TS Addon-docs: Fix ArgsTable union type handling in Vue/TS Aug 20, 2020
@shilman shilman merged commit 7e30368 into storybookjs:next Aug 20, 2020
@shilman shilman mentioned this pull request Aug 20, 2020
Closed
@HerrBertling HerrBertling deleted the fix/11944-docs-union-types-vue branch August 20, 2020 11:36
@HerrBertling HerrBertling mentioned this pull request Aug 20, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shilman shilman shilman approved these changes

Assignees
No one assigned
Labels
addon: docs block: argstable bug vue
Projects
None yet
Milestone
6.0.x
Development

Successfully merging this pull request may close these issues.
2 participants
@HerrBertling @shilman