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

Types: Fix typing for main.framework/builder fields #27088

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented May 10, 2024

Closes #23232

What I did

I have fixed an issue where the framework and builder fields couldn't be properly set in mono repo or yarn PnP environments, where users have to provide a full path to the node package instead of just passing in the package's name.

The following config definition is now allowed type-wise:

import type { StorybookConfig } from "@storybook/react-vite";
...

const config: StorybookConfig = {
  framework: {
    name: path.dirname(require.resolve(path.join("@storybook/react-vite", "package.json"))),
    options: {},
  },

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!

  1. Run a nextjs sandbox
  2. Define the framework field as a random string. This should be valid
  3. Make sure that @storybook/nextjs gets autocompleted by the IDE during typing

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>

@valentinpalkovic valentinpalkovic force-pushed the valentin/provide-relaxed-types-for-framework-builder-fields branch from 12c553f to 0f4d2c3 Compare May 10, 2024 12:32
@valentinpalkovic valentinpalkovic self-assigned this May 10, 2024
Copy link

nx-cloud bot commented May 10, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit fdd0256. 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.

@valentinpalkovic valentinpalkovic changed the title Fix typing for main.framework/builder fields Types: Fix typing for main.framework/builder fields May 10, 2024
Copy link
Member

@yannbf yannbf left a comment

Choose a reason for hiding this comment

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

LGTM!

@yannbf yannbf marked this pull request as ready for review May 10, 2024 13:10
@valentinpalkovic valentinpalkovic added the patch:yes Bugfix & documentation PR that need to be picked to main branch label May 14, 2024
@valentinpalkovic valentinpalkovic merged commit 1ae28db into next May 14, 2024
61 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/provide-relaxed-types-for-framework-builder-fields branch May 14, 2024 14:50
storybook-bot pushed a commit that referenced this pull request May 14, 2024
…ypes-for-framework-builder-fields

Types: Fix typing for main.framework/builder fields
(cherry picked from commit 1ae28db)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
…ypes-for-framework-builder-fields

Types: Fix typing for main.framework/builder fields
(cherry picked from commit 1ae28db)
storybook-bot pushed a commit that referenced this pull request May 14, 2024
…ypes-for-framework-builder-fields

Types: Fix typing for main.framework/builder fields
(cherry picked from commit 1ae28db)
storybook-bot pushed a commit that referenced this pull request May 15, 2024
…ypes-for-framework-builder-fields

Types: Fix typing for main.framework/builder fields
(cherry picked from commit 1ae28db)
storybook-bot pushed a commit that referenced this pull request May 15, 2024
…ypes-for-framework-builder-fields

Types: Fix typing for main.framework/builder fields
(cherry picked from commit 1ae28db)
storybook-bot pushed a commit that referenced this pull request May 15, 2024
…ypes-for-framework-builder-fields

Types: Fix typing for main.framework/builder fields
(cherry picked from commit 1ae28db)
@github-actions github-actions bot mentioned this pull request May 15, 2024
9 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch typescript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: React+Vite+TS PnP breaks type in .storybook/main.ts > config.framework.name
2 participants