storybookjs/storybook

[Bug]: Automigration addReact fails with `package.json` overrides

Open

#21,271 opened on Feb 27, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
bugclihelp wantedsev:S3

Description

Describe the bug

Error:
npm ERR! code EOVERRIDE
npm ERR! Override for react@* conflicts with direct dependency
npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/xxx/.npm/_logs/2023-02-23T13_19_13_353Z-debug-0.log

Summary: The package.json has a overrides field, which defines react:

"overrides": {
	"react": "^18.0.0"
}

This hinders the addReact automigration to run and the sb upgrade script aborts. The error also leads for sb init to fail, because React is installed automatically without asking the user.

To Reproduce

https://github.com/bitwarden/clients per @valentinpalkovic

System

No response

Additional context

No response

Contributor guide

Tech stack
javascripttypescriptreactnodejs
Domain
developer experiencetooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of npm package.jsonUnderstanding of npm overrides
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the automigration code that adds React dependency, likely in the Storybook CLI's addReact function. Reproduce the error using the repository linked in the issue. The fix likely involves checking for existing 'overrides' field in package.json and either merging or skipping the automigration if a conflict arises. Look for the relevant source files in the monorepo, such as in the 'cli' or 'automigrate' directories.
[Bug]: Automigration addReact fails with `package.json` overrides · storybookjs/storybook#21271 | Good First Issue