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

fix(react): handle more scenarios when collecting component props for generating stories #27528

Merged
merged 1 commit into from
Aug 20, 2024

Conversation

leosvelperez
Copy link
Member

Current Behavior

Stories generation for React components only handles components receiving a props argument typed with an Interface.

Expected Behavior

Stories generation for React components should handle receiving the props with any name or as a destructured object and typed with an Interface, a type literal definition, or an inline type literal. In case it's a destructured object, it also supports having no type, in which case the story args will have those properties with type unknown.

Related Issue(s)

Fixes #22053

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
… generating stories
@leosvelperez leosvelperez self-assigned this Aug 20, 2024
@leosvelperez leosvelperez requested review from a team as code owners August 20, 2024 07:46
Copy link

vercel bot commented Aug 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Updated (UTC)
nx-dev ⬜️ Ignored (Inspect) Aug 20, 2024 7:46am

@leosvelperez leosvelperez merged commit fd74969 into master Aug 20, 2024
6 checks passed
@leosvelperez leosvelperez deleted the react/stories-missing-props branch August 20, 2024 12:41
FrozenPandaz pushed a commit that referenced this pull request Aug 21, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
… generating stories (#27528)

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

Stories generation for React components only handles components
receiving a `props` argument typed with an `Interface`.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

Stories generation for React components should handle receiving the
props with any name or as a destructured object and typed with an
`Interface`, a type literal definition, or an inline type literal. In
case it's a destructured object, it also supports having no type, in
which case the story args will have those properties with type
`unknown`.

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #22053

(cherry picked from commit fd74969)
Copy link

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Story generation not working as expected, missing args
2 participants