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

feat(svelte): filter out event handlers types with on:* when svelte@5 is in use #29599

Draft
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

xeho91
Copy link

@xeho91 xeho91 commented Nov 13, 2024

Closes #29598

What I did

Filter out extracted argTypes for Svelte component which starts with on:. This filter is based on whether svelte v5 is in use.

More details about legacy on:

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-storybook/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>

Greptile Summary

This PR adds filtering logic for Svelte event handlers (on:*) in component documentation when using Svelte v5, where these handlers are deprecated.

  • Added conditional filtering in code/renderers/svelte/src/docs/extractArgTypes.ts to exclude on:* event handlers when not using Svelte v4
  • Introduced IS_SVELTE_V4 flag to control event handler filtering behavior
  • Maintains backward compatibility by preserving event handlers for Svelte v4 components

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

code/renderers/svelte/src/docs/extractArgTypes.ts Outdated Show resolved Hide resolved

if (!IS_SVELTE_V4) {
// NOTE: Filter out event handlers `on:*` as they're deprecated from Svelte v5
return Object.fromEntries(Object.entries(argTypes).filter(([name, _]) => !name.startsWith('on:')));
Copy link
Author

Choose a reason for hiding this comment

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

I also believe it might be possible to optimize performance a bit by using .filter() from es-toolkit

@jonniebigodes
Copy link
Contributor

@xeho91, thanks for taking the time to put together this pull request. We appreciate it 🙏 !

@JReinhold, can you please take a look when you have a moment so that we can get this in?

Thanks in advance

Copy link

nx-cloud bot commented Nov 18, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 1c98af6. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@xeho91
Copy link
Author

xeho91 commented Nov 18, 2024

Hey!

Thanks for the update! Please forgive me for causing any confusion. I'm changing this PR to a draft.

Reason:
I've been making more progress on this case, where I also did some auto-grouping properties. Is related to this thread on Discord. This PR is currently a small piece of this case, and I'd like to put this together with the auto-grouping feature.

@xeho91 xeho91 marked this pull request as draft November 18, 2024 14:26
@jonniebigodes
Copy link
Contributor

@xeho91 no problem, and there is no need to apologize whatsoever. Appreciate you changing it to a draft pull request 🙏 ! Looking forward to seeing this added.

Have a great day.

Stay safe

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.

3 participants