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

Bugfix : summary: undefined type issue #27202

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

angad-sethi
Copy link

@angad-sethi angad-sethi commented May 20, 2024

Closes #27129

What I did

I've updated the type for ArgType.table.type.summary to be string | undefined so as to enable exactOptionalPropertyTypes: true in tsconfig.json

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 pull request has been released as version 0.0.0-pr-27202-sha-9b58ef19. Try it out in a new sandbox by running npx [email protected] sandbox or in an existing project with npx [email protected] upgrade.

More information
Published version 0.0.0-pr-27202-sha-9b58ef19
Triggered by @valentinpalkovic
Repository angad-sethi/storybook
Branch undefined-support-for-argtype
Commit 9b58ef19
Datetime Wed May 22 08:52:08 UTC 2024 (1716367928)
Workflow run 9188289147

To request a new release of this pull request, mention the @storybookjs/core team.

core team members can create a new canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=27202

@Hyzual
Copy link

Hyzual commented May 21, 2024

I've cloned your repository, how can I test this from a project using storybook ? I guess I need to replace the version used by the local repo I cloned, but I've never done that. Could you share some pointers ? :)

@valentinpalkovic
Copy link
Contributor

@Hyzual I have created a canary release. You can try it out by upgrading Storybook to it:

npx [email protected] upgrade

Copy link

nx-cloud bot commented May 22, 2024

☁️ Nx Cloud Report

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

Copy link

@Hyzual Hyzual left a comment

Choose a reason for hiding this comment

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

The TypeScript error is still present. We have found that we had to modify an interface named InputType from the @storybook/types package to add string | undefined for the TypeScript error to be fixed. I tried looking for it in the code but did not find it 😓. If you know where it is and could change it, I would be grateful!

@shilman
Copy link
Member

shilman commented May 25, 2024

@angad-sethi Perhaps here https://github.com/ComponentDriven/csf/blob/81a58c947078157f58cc1f45f1fd0c04c2bd1771/src/story.ts#L159

@Hyzual
Copy link

Hyzual commented Jun 11, 2024

@shilman I've opened a pull request at ComponentDriven/csf#94. Thanks a lot for the pointers!

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]: summary: undefined type issue
5 participants