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

Svelte: use SvelteComponent instead of deprecated SvelteComponentTyped #25725

Closed
wants to merge 12 commits into from
Closed

Svelte: use SvelteComponent instead of deprecated SvelteComponentTyped #25725

wants to merge 12 commits into from

Conversation

mrazauskas
Copy link

What I did

Replaced deprecated SvelteComponentTyped with the SvelteComponent type. SvelteComponentTyped is deprecated since Svelte 4 (see the migration guide) and it is recommended to use the SvelteComponent type instead.

The @storybook/svelte package marks Svelte 4 as lowest supported version, so it feels reasonable to migrate. Reference:

"peerDependencies": {
"svelte": "^4.0.0 || ^5.0.0-next.16"
},

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

The change is in type test file. If I got it right, svelte-check is used to type check the file. Running svelte-check does not report errors.

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>

@JReinhold JReinhold self-assigned this Jan 29, 2024
@JReinhold JReinhold added maintenance User-facing maintenance tasks typescript svelte ci:daily Run the CI jobs that normally run in the daily job. labels Jan 29, 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

Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

I see quite a lot of more instances of SvelteComponentTyped, I don't think this change makes sense without changing all of it - especially because right now it's only changed in tests.

image

@mrazauskas
Copy link
Author

Right. I missed that. All instances are changed now.

@mrazauskas
Copy link
Author

mrazauskas commented Jan 31, 2024

Hm.. Is this breaking now? Definitely the change is larger than I thought initially.

@JReinhold JReinhold changed the title refactor: use SvelteComponent instead of deprecated SvelteComponentTyped Svelte: use SvelteComponent instead of deprecated SvelteComponentTyped Jan 31, 2024
@kasperpeulen
Copy link
Contributor

Shall we look at this together @JReinhold ?

@mrazauskas
Copy link
Author

Never mind (;

@mrazauskas mrazauskas closed this Feb 19, 2024
@mrazauskas mrazauskas deleted the use-SvelteComponent-type branch February 19, 2024 09:02
@kasperpeulen
Copy link
Contributor

Thanks for your PR!

Sorry for not merging it sooner, we made a new PR here:
#26113

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:daily Run the CI jobs that normally run in the daily job. maintenance User-facing maintenance tasks svelte typescript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants