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

Docs: Update theming example #28614

Merged
merged 2 commits into from
Jul 23, 2024
Merged

Conversation

booc0mtaco
Copy link
Contributor

Update the import statement example to match conventions in storybook 8.2.x and newer

Repository / Pull Request in question: chanzuckerberg/edu-design-system@5299632

Closes #

What I did

After updating to the latest storybook release (8.2.x), I started getting errors when starting local development, and in CI

Snippet:

<i> [webpack-dev-middleware] wait until bundle finished: /__webpack_hmr
ERROR in ./.storybook/Theme.js 1:0-51
Module not found: Error: Can't resolve '@storybook/theming/create' in '/Users/xxx/Development/xxx/.storybook'
 @ ./.storybook/preview.tsx 14:0-28 56:11-16
 @ ./storybook-config-entry.js 9:1567-1647 30:0-33:2 30:1540-33:1

Also, there is a typescript error in my theme file:

Default export of the module has or is using private name 'ThemeVars'. ts(4082)
(property) default: ThemeVars

This theme file follows the directions in the documentation mentioned here. However, after investigating, I found a thread mentioning an alternative import statement that I tried, which worked. Here, I update the code example to use that import path. In code, removing /create from the path fixes the TypeScript Error, and allows the build to pass.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make 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/core team 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>

Update the import statement example to match conventions in storybook 8.2.x and newer
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

  • Updated import path in /docs/_snippets/storybook-theme-example-variables.md to @storybook/theming
  • Resolved build errors by removing /create from the import path
  • Fixed TypeScript error related to ThemeVars

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

@booc0mtaco
Copy link
Contributor Author

@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Jul 23, 2024
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@booc0mtaco, thank you for putting together this pull request and helping us improve the documentation by catching this small issue with our examples. We appreciate it 🙏 !

I've checked, and everything is good on my end.

I'm going to merge this once the checklist clears.

I hope you have a great day.

Stay safe

Copy link

nx-cloud bot commented Jul 23, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 5482a5c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@jonniebigodes jonniebigodes changed the title Update storybook-theme-example-variables.md Docs: Update theming example Jul 23, 2024
@jonniebigodes jonniebigodes merged commit 68abfec into storybookjs:next Jul 23, 2024
10 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants