-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
Types: Update type signatures of objects and functions #28503
Conversation
Our bundler tsup sometimes doesn't seem to create type definition imports properly for inferred types. Instead of importing types from `storybook/internal/*` or `@storybook/core/*`, it would import types from `core/dist/*`. Explicitly defining types for the return type of functions or for objects will resolve this issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR Summary
code/frameworks/nextjs/src/portable-stories.ts
: Updated type signatures to explicitly define return types.code/renderers/react/src/docs/extractArgTypes.ts
: Explicitly defined return type ofextractArgTypes
asStrictArgTypes | null
.code/renderers/react/src/entry-preview-docs.ts
: Updated type signatures to explicitly define return types for functions and objects.code/renderers/svelte/src/docs/extractArgTypes.ts
: UpdatedextractArgTypes
return type toStrictArgTypes | null
.code/renderers/vue3/src/docs/extractArgTypes.ts
: Explicitly defined return type ofextractArgTypes
asStrictArgTypes | null
.
11 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 8be78f2. 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 targetSent with 💌 from NxCloud. |
…e-creation Types: Update type signatures of objects and functions (cherry picked from commit 6598f73)
…e-creation Types: Update type signatures of objects and functions (cherry picked from commit 6598f73)
Closes #28500
What I did
Our bundler
tsup
sometimes doesn't seem to create type definition imports properly for inferred types. Instead of importing types fromstorybook/internal/*
or@storybook/core/*
, it would import types fromcore/dist/*
. Explicitly defining types for the return type of functions or for objects will resolve this issue.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This 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:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/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>