Fix useArgs generic typing issue #25070 #32110
Open
+81
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Enhanced preview-api useArgs with readonly tuple and 'as const' for better type inference - Added useDocsArgs to docs blocks to prevent naming conflicts - Maintained backward compatibility with deprecated useArgs in docs Fixes: storybookjs#25070
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
- Add missing useArgs export to blocks index - Simplify deprecated useArgs to delegate to useDocsArgs - Ensure consistent function signatures
Package BenchmarksCommit: No significant changes detected, all good. 👏 |
|
View your CI Pipeline Execution ↗ for commit 548e78a
☁️ Nx Cloud last updated this comment at |
|
@valentinpalkovic any update on this PR? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #25070
What I did
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:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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 fixes a TypeScript generic typing issue with the
useArgshook that was broken when upgrading from Storybook version 7.4.6 to 7.6.2. The core problem was that TypeScript wasn't properly inferring the tuple type foruseArgs<TGeneric>, causing the generic type parameter to be lost.The fix involves two key changes:
Enhanced the preview-api
useArgshook: Modified the return type from a regular array to a readonly tuple with 'as const' assertion. This ensures TypeScript treats the return value as a specific tuple type rather than a general array type, preserving generic type information.Added
useDocsArgsto docs blocks: Created a new function to prevent naming conflicts between the docs-specificuseArgs(non-generic, tied to docs context) and the genericuseArgsfrom preview-api. The original docsuseArgsis deprecated but maintained for backward compatibility.The changes integrate well with the existing codebase - the preview-api hook maintains its core functionality while improving type safety, and the docs blocks solution prevents conflicts without breaking existing implementations that depend on the docs-specific version.
Confidence score: 4/5