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: Fix automatic argTypes inference coming up empty with [email protected] #30784

Merged
merged 2 commits into from
Mar 11, 2025

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Mar 10, 2025

Follow-up to #30783

What I did

sveltejs/language-tools#2667 changed the internal name of the render-function, which we use to infer prop types from Svelte components. It also exposes the name of the render-function as a variable now, that we can use, however it's all still marked as internal, so I'm not sure how much safety it actually gives us.

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

Updates Svelte component prop type inference by upgrading svelte2tsx to version 0.7.35 and modifies the render function identification method in the docgen generator.

  • Updated code/frameworks/svelte-vite/package.json to use svelte2tsx ^0.7.35
  • Modified code/frameworks/svelte-vite/src/plugins/generateDocgen.ts to use internalHelpers.renderName instead of hardcoded 'render'
  • Note: Solution relies on internal svelte2tsx APIs which may be unstable

@JReinhold JReinhold requested a review from kasperpeulen March 10, 2025 13:05
@JReinhold JReinhold self-assigned this Mar 10, 2025
@JReinhold JReinhold added bug svelte ci:daily Run the CI jobs that normally run in the daily job. labels Mar 10, 2025
@JReinhold JReinhold marked this pull request as ready for review March 10, 2025 13:06
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.

LGTM

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

@JReinhold JReinhold added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Mar 10, 2025
Copy link

nx-cloud bot commented Mar 10, 2025

View your CI Pipeline Execution ↗ for commit 81285e4.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 55s View ↗

☁️ Nx Cloud last updated this comment at 2025-03-11 07:48:40 UTC

@dummdidumm
Copy link

dummdidumm commented Mar 10, 2025

You should be fine to use the internal helper, if we change the signature of one of the helpers or remove one, that would require a major (aka. 0.next-minor.0) for us as well since other Svelte intellisense packages rely on it and would break then. So it could change but you would not break from it (since you have to first bump to the new major).

@kasperpeulen kasperpeulen added ci:merged Run the CI jobs that normally run when merged. and removed ci:daily Run the CI jobs that normally run in the daily job. labels Mar 10, 2025
@JReinhold
Copy link
Contributor Author

@kasperpeulen self-merging

@JReinhold JReinhold merged commit ba3e904 into next Mar 11, 2025
60 of 67 checks passed
@JReinhold JReinhold deleted the jeppe/fix-svelte2tsx branch March 11, 2025 13:44
kasperpeulen pushed a commit that referenced this pull request Mar 11, 2025
Svelte: Fix automatic argTypes inference coming up empty with `[email protected]`
(cherry picked from commit ba3e904)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:merged Run the CI jobs that normally run when merged. patch:yes Bugfix & documentation PR that need to be picked to main branch svelte
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants