8000 CLI: Fix framework for preview imports by valentinpalkovic · Pull Request #31101 · storybookjs/storybook · GitHub
[go: up one dir, main page]

Skip to content

CLI: Fix framework for preview imports #31101

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

Merged
merged 4 commits into from
Apr 14, 2025

Conversation

valentinpalkovic
Copy link
Contributor
@valentinpalkovic valentinpalkovic commented Apr 11, 2025

Closes #

What I did

I have fixed the generation of preview.<ts|js> files, which were still referencing the renderer, instead of the framework package.

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, 8000 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-storybook/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>

Greptile Summary

This PR refactors how Storybook handles framework-specific preview configurations in the project setup process.

  • Changed baseGenerator.ts to pass frameworkPackage instead of rendererId to the configurePreview function
  • Updated ConfigurePreviewOptions interface in configure.ts to use frameworkPackage parameter instead of rendererId
  • Simplified the preview file generation logic to import Preview types directly from framework packages
  • Aligns with Storybook's framework-centric architecture by ensuring preview configurations are properly associated with their respective frameworks
  • Maintains consistency in how Storybook handles framework-specific configurations across the codebase

Greptile AI: This change improves type safety and architectural consistency by using the correct import source for framework-specific preview configurations.

… frameworkPackage for improved flexibility in framework handling.
@valentinpalkovic valentinpalkovic self-assigned this Apr 11, 2025
@valentinpalkovic valentinpalkovic changed the title Core: Refactor baseGenerator to use framework for preview imports Cli: Refactor baseGenerator to use framework for preview imports Apr 11, 2025
@valentinpalkovic valentinpalkovic changed the title Cli: Refactor baseGenerator to use framework for preview imports CLI: Refactor baseGenerator to use framework for preview imports Apr 11, 2025
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.

LGTM

2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Copy link
nx-cloud bot commented Apr 11, 2025

View your CI Pipeline Execution ↗ for commit 53acd98.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 34s View ↗

☁️ Nx Cloud last updated this comment at 2025-04-14 13:34:25 UTC

@valentinpalkovic valentinpalkovic merged commit 11f88d2 into next Apr 14, 2025
46 of 57 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/fix-framework-reference-in-preview branch April 14, 2025 14:58
@github-actions github-actions bot mentioned this pull request Apr 14, 2025
10 tasks
@shilman shilman changed the title CLI: Refactor baseGenerator to use framework for preview imports CLI: Fix framework for preview imports Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0