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: Fix type aliases and enum types from Angular Compodoc JSON #12665

Merged
merged 10 commits into from Dec 1, 2020
Merged

Conversation

lachieh
Copy link
Contributor

@lachieh lachieh commented Oct 5, 2020

Issue: #12531

What I did

Added functionality to resolved type aliases and extract enum types from the compodoc generated json file

How to test

  • Is this testable with Jest or Chromatic screenshots?
    Added test cases for named enum types

  • Does this need a new example in the kitchen sink apps?
    Yes, there is a new Enum example component

  • Does this need an update to the documentation?
    Possibly. I was not able to get the base Enum type with auto-incrementing number values to work correctly. It will generate the select input, though switching between the values does not update the component.

@lachieh lachieh changed the title Resolve type aliases and extract enum types from Compodoc JSON Addon-docs: Resolve type aliases and extract enum types from Compodoc JSON Oct 6, 2020
@lachieh
Copy link
Contributor Author

lachieh commented Oct 7, 2020

I've added test cases to cover the new Types.

@shilman If possible, can you add the hacktoberfest-accepted label (i) to this PR?

@lachieh lachieh changed the title Addon-docs: Resolve type aliases and extract enum types from Compodoc JSON Addon-docs: [Angular] Resolve type aliases and extract enum types from Compodoc JSON Oct 7, 2020
@lachieh
Copy link
Contributor Author

lachieh commented Oct 7, 2020

Should I update the documentation for this? I'm trying to think if the detail should go in the docs for addon-controls, addon-docs or both.

@shilman shilman modified the milestones: 6.1 docs, 6.2 docs Nov 24, 2020
@shilman shilman changed the title Addon-docs: [Angular] Resolve type aliases and extract enum types from Compodoc JSON Addon-docs: Fix type aliases and enum types from Angular Compodoc JSON Dec 1, 2020
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.

LGTM @lachieh! Thanks for your patience on this!

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.

LGTM @lachieh! Thanks for your patience on this!

@shilman shilman merged commit 209dafb into storybookjs:next Dec 1, 2020
@lachieh
Copy link
Contributor Author

lachieh commented Dec 1, 2020

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants