Skip to content

Vue3: Add docgen-harness feature with withDefaults - #35709

Closed
huang-julien wants to merge 1 commit into
nextfrom
julien/docgenharness_vue_withdefaultsprops
Closed

huang-julien wants to merge 1 commit into
nextfrom
julien/docgenharness_vue_withdefaultsprops

Conversation

@huang-julien

Copy link
Copy Markdown
Contributor

Closes #

What I did

This PRs addsd a fixtures for Vue3 with withDefaults

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

Caution

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-storybook/src/sandbox-templates.ts

  • Declare whether manual QA will be needed for this PR during the next release, through qa:needed or qa:skip

  • 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 publish.yml --field pr=<PR_NUMBER>

@huang-julien
huang-julien requested a review from a team August 3, 2026 08:59
@huang-julien huang-julien added build Internal-facing build tooling & test updates ci:normal Run our default set of CI jobs (choose this for most PRs). qa:skip Pull Requests that do not need any QA. (e.g. documentation) labels Aug 3, 2026
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor
Fails
🚫 The "#### Manual testing" section must be filled in. Please describe how to test the changes you've made, step by step, so that reviewers can confirm your PR works as intended.
🚫 This PR needs an approving review from a Storybook Core or Developer Experience team member before it can be merged.

Generated by 🚫 dangerJS against 1375d1a

@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 60a56144-4930-4b81-a09e-24588ada77d2

📥 Commits

Reviewing files that changed from the base of the PR and between 95ecd80 and 1375d1a.

📒 Files selected for processing (6)
  • code/lib/docgen-harness/src/vue3/__testfixtures__/define-props-with-defaults/DefinePropsWithDefaults.vue
  • code/lib/docgen-harness/src/vue3/__testfixtures__/define-props-with-defaults/argtypes.snapshot
  • code/lib/docgen-harness/src/vue3/__testfixtures__/define-props-with-defaults/cm-argtypes.snapshot
  • code/lib/docgen-harness/src/vue3/__testfixtures__/define-props-with-defaults/cm-snippet-PropsAsWritten.snapshot
  • code/lib/docgen-harness/src/vue3/__testfixtures__/define-props-with-defaults/input.stories.ts
  • code/lib/docgen-harness/src/vue3/__testfixtures__/define-props-with-defaults/snippet-PropsAsWritten.snapshot

Walkthrough

Adds a Vue 3 <script setup> fixture with typed props and defaults. Adds a Storybook story and snapshots for prop metadata and rendered snippets.

Changes

Vue 3 prop defaults fixture

Layer / File(s) Summary
Prop definition and story entry
code/lib/docgen-harness/src/vue3/.../define-props-with-defaults/DefinePropsWithDefaults.vue, code/lib/docgen-harness/src/vue3/.../define-props-with-defaults/input.stories.ts
Defines optional disabled, label, and size props with defaults. Adds the PropsAsWritten story with custom values.
Metadata and snippet snapshots
code/lib/docgen-harness/src/vue3/.../define-props-with-defaults/*.snapshot
Adds argtypes metadata and rendered snippets for the fixture, including default values and size options.

Possibly related PRs

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

Labels

build Internal-facing build tooling & test updates ci:normal Run our default set of CI jobs (choose this for most PRs). qa:skip Pull Requests that do not need any QA. (e.g. documentation)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants