Skip to content

build(deps): move styled-components to peerDependencies (CUI-37)#1173

Open
JeanMarcMilletScality wants to merge 1 commit into
development/1.0from
improvement/CUI-37-styled-components-peerdep
Open

build(deps): move styled-components to peerDependencies (CUI-37)#1173
JeanMarcMilletScality wants to merge 1 commit into
development/1.0from
improvement/CUI-37-styled-components-peerdep

Conversation

@JeanMarcMilletScality

Copy link
Copy Markdown
Contributor

What

Move styled-components from dependencies to peerDependencies (matching react/react-dom), and add it to devDependencies so core-ui's own build/test/Storybook still resolve it.

Why

As a regular dependency, npm was free to install a nested node_modules/@scality/core-ui/node_modules/styled-components in workspace consumers. That second instance yields two ThemeProvider contexts, so useTheme() returns undefined at test/build time — this broke identity-ui's Jest run (140 failures from Checkbox/theme consumers).

Making it a peer guarantees a single hoisted instance provided by the consumer, exactly as react already works.

No Module Federation impact

The MF singleton version is negotiated from each consumer's rspack shared config (requiredVersion: deps['styled-components'], read from the consumer's own package.json), independent of core-ui's dependency classification. Runtime behavior is unchanged; this only affects install/build/test-time npm resolution.

Why the devDependencies entry is required

Peer deps of the root package are not auto-installed for the package's own dev build. react survives peer-only here only because Storybook/testing-library pull it in transitively — nothing pulls styled-components, so tsc fails without the explicit devDep. Verified: peer-only → build fails across ~40 files; with devDep → clean.

Verification

  • core-ui: npm run build clean, npm test → 43 suites / 428 tests pass.
  • Pilots repointed at this branch (fresh --legacy-peer-deps install, cache-clean) — all confirm a single deduped styled-components@6.4.4, no nested copy:
    • shell-ui: 92/92 pass
    • metalk8s ui: 220 pass / 2 skip / 3 todo
    • identity-ui: 248 pass (2 pre-existing GroupsTab form-logic failures, unrelated — this commit changes only package metadata, not compiled code)

🤖 Generated with Claude Code

styled-components was a regular dependency, which let npm install a nested
node_modules/@scality/core-ui/node_modules/styled-components in workspace
consumers. That second instance yields two ThemeProvider contexts, so
useTheme() returns undefined at test/build time (broke identity-ui Jest).

Move it to peerDependencies to match react/react-dom and guarantee a single
hoisted instance from the consumer. Add it to devDependencies so core-ui's
own tsc build, Jest, and Storybook still resolve it (peer deps of the root
package are not auto-installed; react is only present transitively via
storybook/testing-library).

No Module Federation runtime impact: the singleton version is negotiated
from each consumer's rspack shared config (requiredVersion: deps[...]),
independent of core-ui's dependency classification.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@bert-e

bert-e commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Hello jeanmarcmilletscality,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Available options
name description privileged authored
/after_pull_request Wait for the given pull request id to be merged before continuing with the current one.
/bypass_author_approval Bypass the pull request author's approval
/bypass_build_status Bypass the build and test status
/bypass_commit_size Bypass the check on the size of the changeset TBA
/bypass_incompatible_branch Bypass the check on the source branch prefix
/bypass_jira_check Bypass the Jira issue check
/bypass_peer_approval Bypass the pull request peers' approval
/bypass_leader_approval Bypass the pull request leaders' approval
/approve Instruct Bert-E that the author has approved the pull request. ✍️
/create_pull_requests Allow the creation of integration pull requests.
/create_integration_branches Allow the creation of integration branches.
/no_octopus Prevent Wall-E from doing any octopus merge and use multiple consecutive merge instead
/unanimity Change review acceptance criteria from one reviewer at least to all reviewers
/wait Instruct Bert-E not to run until further notice.
Available commands
name description privileged
/help Print Bert-E's manual in the pull request.
/status Print Bert-E's current status in the pull request TBA
/clear Remove all comments from Bert-E from the history TBA
/retry Re-start a fresh build TBA
/build Re-start a fresh build TBA
/force_reset Delete integration branches & pull requests, and restart merge process from the beginning.
/reset Try to remove integration branches unless there are commits on them which do not appear on the source branch.

Status report is not available.

@bert-e

bert-e commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Waiting for approval

The following approvals are needed before I can proceed with the merge:

  • the author

  • one peer

Peer approvals must include at least 1 approval from the following list:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants