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

Types: Update type signatures of objects and functions #28503

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

valentinpalkovic
Copy link
Contributor

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 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.

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

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.
@valentinpalkovic valentinpalkovic self-assigned this Jul 10, 2024
@valentinpalkovic valentinpalkovic added bug typescript patch:yes Bugfix & documentation PR that need to be picked to main branch labels Jul 10, 2024
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.

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 of extractArgTypes as StrictArgTypes | 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: Updated extractArgTypes return type to StrictArgTypes | null.
  • code/renderers/vue3/src/docs/extractArgTypes.ts: Explicitly defined return type of extractArgTypes as StrictArgTypes | null.

11 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link

nx-cloud bot commented Jul 10, 2024

☁️ Nx Cloud Report

CI 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 target

Sent with 💌 from NxCloud.

@valentinpalkovic valentinpalkovic merged commit 6598f73 into next Jul 10, 2024
64 of 77 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/fix-core-dist-type-creation branch July 10, 2024 10:13
@github-actions github-actions bot mentioned this pull request Jul 10, 2024
33 tasks
storybook-bot pushed a commit that referenced this pull request Jul 10, 2024
…e-creation

Types: Update type signatures of objects and functions
(cherry picked from commit 6598f73)
@github-actions github-actions bot mentioned this pull request Jul 10, 2024
4 tasks
storybook-bot pushed a commit that referenced this pull request Jul 10, 2024
…e-creation

Types: Update type signatures of objects and functions
(cherry picked from commit 6598f73)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch typescript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Type error in @storybook/react 8.2.0
2 participants