eggheadio-projects / design-systems-with-react-and-typescript-in-storybook

9 stars 7 forks source link

Review: Design Systems with React and Typescript in Storybook #1

Open Creeland opened 5 years ago

Creeland commented 5 years ago

Design Systems with React and Typescript in Storybook

Review details
### ⏲️ 16 Minutes ### 🛠 Setup - Navigate to [review.egghead.io](https://review.egghead.io/) - Start a new review - Add course slug - Add Dependencies - Make a copy of this [Template](https://goo.gl/NANbTB) for review notes ### 📖 The Review - Watch the video - Note how code functions in video - Check the comments - Test the code - Note how code functions - Update dependencies - Test the code - Note how code functions - Compare to video and pre-updated code - Note any errors in the review app and doc - Do not hesitate to ask any question at any time! ### 🏆 Finished - Navigate to the content-team slack channel - Share your review document - Share a snippet of the review app json output - Add the review to your invoice ### 💻 Copying the JSON - hover over "items" - click the clipboard icon ![image of copying](https://cl.ly/a8e082a72a1b/%255B30d2a1fdc29fdf4fea98725e10d63389%255D_Image%2525202019-01-10%252520at%25252012.56.16%252520PM.png)
zacjones93 commented 5 years ago

Lesson 6 and on throw this error:

"Error message: Passing stories directly into withInfo() is deprecated, instead use addDecorator(withInfo) and pass options with the 'info' parameter. Followed by: TypeError: Cannot read property 'parameters' of undefined. Tried reformatting to addDecorator in global config, as well as directed locally to individual stories. Link to migration guide: https://github.com/storybooks/storybook/tree/5.0.0/addons/info. Nothing worked. Need instructor or heavier guns in on this one. If this issue is fixed, lessons 6-9 should work properly with updated dependencies.

zacjones93 commented 5 years ago

Here's the recommended approach to fixing the error: https://github.com/storybookjs/storybook/tree/next/addons/info

zacjones93 commented 5 years ago

The comments on lesson 06 point in the right direction. The tone isn't great but this comment is spot on:

Haha I love that you completely skip over how the withInfo completely destroys the work done with addWithJSX, 
you may want to update this video and show some more info about how to add it globally now that it is deprecated and how to ensure 
it doesn't have issues with other things

https://egghead.io/lessons/react-apply-style-to-a-react-storybook-with-the-info-addon-to-turn-stories-into-documentation

swyxio commented 5 years ago

hi! feel free to tag me on this in future!

swyxio commented 5 years ago

taking a look at this now!

zacjones93 commented 5 years ago

@sw-yx Will do in the future! We wanted to attempt a fix before pinging you 😄