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

Vue: Improve types for array, union and intersection when using vue-docgen-api #26177

Merged
merged 8 commits into from
Feb 26, 2024

Conversation

larsrickert
Copy link
Contributor

@larsrickert larsrickert commented Feb 23, 2024

What I did

  • add tests for extracting arg types for "vue-docgen-api"
  • fix(vue-component-meta): correctly convert union types with complex schema (e.g. MyNestedProps | MyIgnoredNestedProps)
  • fix(vue-component-meta): correctly convert union type with primitive types (e.g. string | number)
  • removed unused test mock data
  • refactor: separate arg extraction for vue-docgen-api and vue-component-meta to have full type support / safety for each plugin
  • vue-docgen-api: improve type docs for array, union and intersection types
  • vue-docgen-api: add event data types
  • vue-docgen-api: add slot bindings/props
  • vue-docgen-api: add missing asterisk for required props

props
events
slots

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@larsrickert larsrickert added vue3 feature request ci:daily Run the CI jobs that normally run in the daily job. labels Feb 23, 2024
@larsrickert larsrickert changed the title [DRAFT] feat(vue): improve displayed types for array, union and intersection Vue: Improve docgen for array, union and intersection Feb 23, 2024
@larsrickert larsrickert marked this pull request as ready for review February 23, 2024 23:17
@larsrickert larsrickert changed the title Vue: Improve docgen for array, union and intersection Vue: Improve types for array, union and intersection when using vue-docgen-api Feb 24, 2024
@kasperpeulen kasperpeulen added ci:normal and removed ci:daily Run the CI jobs that normally run in the daily job. labels Feb 26, 2024
Copy link
Contributor

@kasperpeulen kasperpeulen left a comment

Choose a reason for hiding this comment

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

LGTM

@kasperpeulen kasperpeulen merged commit 53649e9 into next Feb 26, 2024
116 of 126 checks passed
@kasperpeulen kasperpeulen deleted the larsrickert/vue-component-meta branch February 26, 2024 08:12
@github-actions github-actions bot mentioned this pull request Feb 26, 2024
30 tasks
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.

2 participants