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

Theming: Fix self-referencing type #27155

Merged
merged 3 commits into from
May 27, 2024
Merged

Theming: Fix self-referencing type #27155

merged 3 commits into from
May 27, 2024

Conversation

SimenB
Copy link
Contributor

@SimenB SimenB commented May 15, 2024

Closes #

What I did

Renamed the imported value so it doesn't clash. The bundling causes the import to be removed, and leads to a self reference.

image

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 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>

Copy link

nx-cloud bot commented May 15, 2024

☁️ Nx Cloud Report

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

@shilman shilman added bug patch:yes Bugfix & documentation PR that need to be picked to main branch typescript labels May 25, 2024
@shilman shilman changed the title fix: rename imported type to avoid clashes Theming: Fix type self-referencing May 25, 2024
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Thanks @SimenB ! This looks reasonable to me

@shilman shilman changed the title Theming: Fix type self-referencing Theming: Fix self-referencing type May 25, 2024
@shilman shilman merged commit 47d4d3f into storybookjs:next May 27, 2024
50 of 51 checks passed
@github-actions github-actions bot mentioned this pull request May 27, 2024
9 tasks
storybook-bot pushed a commit that referenced this pull request May 27, 2024
Theming: Fix self-referencing type
(cherry picked from commit 47d4d3f)
@github-actions github-actions bot mentioned this pull request May 27, 2024
7 tasks
@SimenB SimenB deleted the patch-1 branch May 27, 2024 22:07
storybook-bot pushed a commit that referenced this pull request May 28, 2024
Theming: Fix self-referencing type
(cherry picked from commit 47d4d3f)
storybook-bot pushed a commit that referenced this pull request May 29, 2024
Theming: Fix self-referencing type
(cherry picked from commit 47d4d3f)
storybook-bot pushed a commit that referenced this pull request May 29, 2024
Theming: Fix self-referencing type
(cherry picked from commit 47d4d3f)
storybook-bot pushed a commit that referenced this pull request May 29, 2024
Theming: Fix self-referencing type
(cherry picked from commit 47d4d3f)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 30, 2024
@oleksandr-danylchenko
Copy link

oleksandr-danylchenko commented May 31, 2024

‼️ Unfortunately, after this change, custom overrides for the @emotion/react Theme stopped working properly ‼️

I have the following override:

type CombinedTheme = MuiTheme & CompanyTheme;
declare module '@emotion/react' {
	// eslint-disable-next-line @typescript-eslint/no-empty-interface
	export interface Theme extends CombinedTheme {}
}

Which worked completely fine for the following custom theme definition:

import type { Theme } from '@emotion/react';

export const getCombinedTheme = (themeName: ThemeName): Theme => ({
	...companyMuiTheme,
	...themes[themeName]
});

But after switching to the 8.1.5 storybook version - it immediately broke and started complaining about missing properties on the Theme object:

 error TS2740: Type '{ name: ThemeName; }; ... 43 more ...; applyStyles: ApplyStyles<...>; }' is missing the following properties from type 'Theme': color, background, animation, easing, and 10 more.

@oleksandr-danylchenko
Copy link

oleksandr-danylchenko commented Sep 11, 2024

UPD: The issue I mentioned seems to be resolved in some newer versions. After upgrading from the 8.1.4 I don't experience any Theme mismatches anymore 🙌🏻

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.

3 participants