Svelte: Fix source view always using <wrapper ...>
#31639
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR resolves an issue where the source view was always rendered using a <wrapper ...> element by adding a condition to bypass rendering for Svelte CSF stories.
- Added a condition to check if any tag in the context starts with "svelte-csf".
- Skips core source generation when the story is a Svelte CSF story so that the addon can handle source generation.
|
View your CI Pipeline Execution ↗ for commit 22a5378.
☁️ Nx Cloud last updated this comment at |
There was a problem hiding this comment.
LGTM
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
yannbf
approved these changes
Jun 2, 2025
This was referenced Jun 2, 2025
Merged
valentinpalkovic
pushed a commit
that referenced
this pull request
Jun 5, 2025
…e-code Svelte: Fix source view always using `<wrapper ...>` (cherry picked from commit f2e1865)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes https://bsky.app/profile/hmans.dev/post/3lqfb4z3pf224
What I did
In the core Svelte source generator, we now skip sorce generation if it's a Svelte CSF story, as the addon will do its own source generation in https://github.com/storybookjs/addon-svelte-csf/blob/a475611195a9fe94a0410af6c8bcae9d3c2437b1/src/runtime/emit-code.ts#L23-L44
Previously this was not an issue, as the addon would emit on the following tick, so always after the core had emitted its source code, but potentially #31488 flipped the timing of this.
Svelte CSF has a similar (opposite) skip condition at https://github.com/storybookjs/addon-svelte-csf/blob/a475611195a9fe94a0410af6c8bcae9d3c2437b1/src/runtime/emit-code.ts#L50-L54
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
next, expand the source view, and see the wrong component name: https://630873996e4e3557791c069c-pagxgwozgc.chromatic.com/?path=/docs/example-button--docsThis section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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>Greptile Summary
Fixes source code generation for Svelte CSF stories by preventing duplicate source rendering between core and addon implementations. The change ensures proper source view display without wrapper elements.
skipSourceRenderincode/renderers/svelte/src/docs/sourceDecorator.tsto skip core source generation for Svelte CSF storiessourceDecorator.test.tsto validate source generation behavior