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.

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

Addon-docs: Snapshot testing and bug reporting setup for props tables #9836

Closed
6 tasks done
shilman opened this issue Feb 13, 2020 · 1 comment
Closed
6 tasks done
Assignees
Labels
addon: docs block: props maintenance User-facing maintenance tasks
Milestone

Comments

@shilman
Copy link
Member

shilman commented Feb 13, 2020

After launching props table support in @storybook/addon-docs, we've found an impossibly large number of cases to handle (nearly 100 issues so far), many of which correspond to failures in an underlying library.

To properly support prop tables, we need a proper testing and bug reporting strategy. I propose:

  • Test suites for each supported framework (react, vue, angular, ember, wc)
  • Snapshot the output of the underlying library
  • Snapshot the output of our props extraction
  • Display the resulting prop table in storybook
  • Process for filing issues
  • Sweep of existing issues to add them or de-dupe them

This will also help as we move to react-docgen for typescript prop tables in 6.0. #9837

@shilman
Copy link
Member Author

shilman commented Feb 15, 2020

Whoopee!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.0.0-alpha.13 containing PR #9838 that references this issue. Upgrade today to try it out!

You can find this prerelease on the @next NPM tag.

Closing this issue. Please re-open if you think there's still more to do.

@shilman shilman closed this as completed Feb 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs block: props maintenance User-facing maintenance tasks
Projects
None yet
Development

No branches or pull requests

1 participant