-
-
Notifications
You must be signed in to change notification settings - Fork 237
feat: add storybook #1270
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
base: main
Are you sure you want to change the base?
feat: add storybook #1270
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
❌ 1 Tests Failed:
View the top 1 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
JReinhold
left a comment
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.
my suggestions here could potentially be a longer-term solution to the unsupported parts of nuxt.
f441ce8 to
e726dde
Compare
e726dde to
eff116d
Compare
Improve Storybook setup
1344552 to
4478f7e
Compare
JReinhold
left a comment
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.
great job! I didn't look too much into the stories themselves, but it looked good.
|
|
||
| - **Accessibility tests** - Built-in a11y checks (link to example) | ||
| - **Visual tests** - Compare JPG screenshots (link to example) | ||
| - **Snapshot tests** - Compare HTML output (link to example) |
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.
Based on years of user feedback, I'd strongly advice against HTML snapshot testing. It usually ends up being mindlessly updating the snapshots again and again, without any real use. Visual tests are much better snapshots, as they are easier to review and more granular because the diff is on the pixel level and contains styling too.
| - An edge case per story | ||
| - Do not use `autodocs` | ||
|
|
||
| # How to Use |
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.
this section reads to me like it's just a concise version of the Storybook docs, so I'm not sure it's valuable? The "Place a .stories.ts file next to your component" line is good, because you're establishing a convention. The import type { Meta, StoryObj } from '@nuxtjs/storybook' is also good because I would expect the LLM to trip up there a lot. but the rest might not be necessary?
todo
stories
In modalnotes