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

Vite: Fix config typing issue of the typescript property #26046

Merged
merged 1 commit into from
Feb 16, 2024

Conversation

ndelangen
Copy link
Member

Closes #25736

What I did

  • exclude the typescript property from basetype

It seems the inheritence made it incompatible, and it's already extending the TypescriptOptionsBase.

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

  • create a sandbox using react-vite
  • add this to your main.ts file:
    typescript: {
      reactDocgen: 'react-docgen',
    },
    
  • check if there's a type error, hint: if it shows up, it's on the line where the config object is defined, not on the line where the typescript property is written.

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>

@ndelangen ndelangen merged commit 54cb838 into next Feb 16, 2024
62 of 69 checks passed
@ndelangen ndelangen deleted the norbert/fix-vite-mainconfg-type-issue branch February 16, 2024 13:09
@github-actions github-actions bot mentioned this pull request Feb 17, 2024
26 tasks
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.

[Bug]: Storybook 8 - Types of property typescript are incompatible when using react-docgen
2 participants