-
Notifications
You must be signed in to change notification settings - Fork 1k
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(storybook): add args
to auto generate docs
#5979
fix(storybook): add args
to auto generate docs
#5979
Conversation
✅ Deploy Preview for redwoodjs-docs canceled.
|
@virtuoushub nice! You'll have to update the CLI's fixtures to get tests passing:
|
0a9ee2a
to
1b91afc
Compare
```sh yarn workspace @redwoodjs/cli run test -u ``` see: redwoodjs#5979 (comment)
3d9acc9
to
af6bf60
Compare
```sh yarn workspace @redwoodjs/cli run test -u ``` see: redwoodjs#5979 (comment)
```sh yarn workspace @redwoodjs/cli run test -u ``` see: redwoodjs#5979 (comment)
af6bf60
to
86c95cd
Compare
☁️ Nx Cloud ReportCI is running/has finished running commands for commit ff515b1. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch ✅ Successfully ran 14 targets
Sent with 💌 from NxCloud. |
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.
Works!
Note that I almost bikeshed (bikeshed-ed?) and suggested we rename args
to props
, but storybook refers to it consistently as args, so let's follow thier lead.
…ctmode-gen * 'main' of github.com:redwoodjs/redwood: fix(deps): update dependency eslint-plugin-jsx-a11y to v6.6.1 (redwoodjs#6017) chore(deps): update dependency @playwright/test to v1.24.0 (redwoodjs#6019) chore(deps): update dependency @okta/jwt-verifier to v2.6.0 (redwoodjs#6018) fix(storybook): add `args` to auto generate docs (redwoodjs#5979) fix: `yarn rw setup auth clerk` fails in canary (redwoodjs#5998) Provide a possibility to disable flows in dbAuth completely (redwoodjs#5851)
Just accidentally browsing across these changes as i was made aware of this issue before. Just wondered: does this issue happen at all using CSFv3? See https://storybook.js.org/blog/component-story-format-3-0/ With CSFv3, the whole story boils down to even less code:
... that's it, that's the default story :) Wondering whether this behaves correctly even if
so we wouldn't win a lot in the Cell story generators, but still a whole lot in all the others. |
Hi @Philzen - I started going down this path, and yes; I think I got slowed up on the Cells and never finished it. I agree we gain a lot by adopting CSF 3.0 in terms of boilerplate reduction. Will add it to #5269 so we track |
* fix(storybook): add `args` to auto generate docs see: - storybookjs/storybook#8104 (comment) - https://storybook.js.org/docs/react/writing-docs/doc-block-source * test(unit): update snapshots ```sh yarn workspace @redwoodjs/cli run test -u ``` see: redwoodjs/redwood#5979 (comment)
Without this, we don't get the Doc Block / "Show code" feature Storybook provides without having the framework user modify their stories files.
see: