Conversation
JReinhold
added
svelte
ci:daily
…r-show-slotdecorator-as-source
JReinhold
requested review from
kasperpeulen,
valentinpalkovic and
yannbf
as code owners
valentinpalkovic
approved these changes
Nov 10, 2023
JReinhold
commented
Nov 10, 2023
Comment on lines
+42
to
+52
| test('Decorators are excluded from generated source code', async ({ page }) => { | ||
| const sbPage = new SbPage(page); | ||
|
|
||
| await sbPage.navigateToStory('stories/renderers/svelte/slot-decorators', 'docs'); | ||
| const root = sbPage.previewRoot(); | ||
| const showCodeButton = (await root.locator('button', { hasText: 'Show Code' }).all())[0]; | ||
| await showCodeButton.click(); | ||
| const sourceCode = root.locator('pre.prismjs'); | ||
| const expectedSource = '<ButtonJavaScript primary/>'; | ||
| await expect(sourceCode.textContent()).resolves.toContain(expectedSource); | ||
| }); |
Contributor
Author
There was a problem hiding this comment.
I'm hoping to write framework-agnostic versions of this test soon, because I sense that this is an area where we're often seeing regressions.
tmeasday
approved these changes
Nov 12, 2023
Member
tmeasday
left a comment
tmeasday
left a comment
There was a problem hiding this comment.
LGTM.
The only reason not to do it by default is that it is a bit weird that we end up executing the story twice; and folks that aren't using decorators or don't care about source might not want us to do that for .. reasons.
shilman
deleted the
21477-bug-svelte-stories-that-use-a-decorator-show-slotdecorator-as-source
branch
30 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 #21477
What I did
Defaulted the Svelte source decorator to always exclude decorators from the source generation.
We have a similar pattern in React, HTML and Web components, however for them
excludeDecoratorsis configurable. I didn't think that was necessary here, since including decorators leads to a broken result, so I don't know why you would want that.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
/?path=/docs/stories-renderers-svelte-slot-decorators--docs<ButtonJavaScript primary/>and not<SlotDecorator primary/>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/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>