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

Preset: Add common preset overrides mechanism #23915

Merged
merged 2 commits into from
Aug 23, 2023

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Aug 22, 2023

Closes #23914

What I did

This PR adds a common-override-presets file in core-common which will get executed early on, before presets from packages like react-webpack5, and with that we can make sure that framework.options always exist, for instance (which is what is done in this PR). This can be useful for other scenarios as well in the future.
This will fix the infamous cannot read properties of undefined reading 'builder' on all frameworks, including community ones (rspack etc)

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

  1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
  2. Comment out framework.options in main.js:
const config: StorybookConfig = {
  framework: {
      name:'@storybook/react-vite',
      // options: {} <-- comment this!
  }
}
  1. See things work

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>

@yannbf yannbf added bug multiframework ci:daily Run the CI jobs that normally run in the daily job. labels Aug 22, 2023
@yannbf yannbf requested a review from ndelangen August 22, 2023 14:27
@yannbf yannbf force-pushed the yann/add-framework-preset-to-every-framework branch from a920f57 to 5441ba0 Compare August 22, 2023 16:24
@yannbf yannbf force-pushed the yann/add-framework-preset-to-every-framework branch from 5441ba0 to ad2d439 Compare August 22, 2023 16:48
@yannbf yannbf changed the title Preset: Add framework preset with default options to every framework Preset: Add common preset overrides mechanism Aug 22, 2023
@yannbf yannbf self-assigned this Aug 23, 2023
@yannbf yannbf merged commit 6889787 into next Aug 23, 2023
14 checks passed
@yannbf yannbf deleted the yann/add-framework-preset-to-every-framework branch August 23, 2023 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:daily Run the CI jobs that normally run in the daily job. core
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Error: Cannot read properties of undefined (reading 'builder')
2 participants