Skip to content

Alterenative install method for installing an xstate integration package without using --force or --legacy-peer-deps #420

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Alterenative install method for installing an xstate integration package without using --force or --legacy-peer-deps #420

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions docs/migration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2498,8 +2498,21 @@ import { createMachine } from 'xstate5';

If you need to use different versions of an integration package, such as `@xstate/react`, you can use a similar strategy as above, but you will need to link to the correct version of XState in the integration package. This can be done by using a script:

```json5
// package.json
"scripts": {
"postinstall": "node scripts/xstate5-react-script.js"
},
// We trick @xstate5/react into having a peer dependency on xstate v4, which bypasses the --legacy-peer-deps error
"overrides": {
"@xstate5/react": {
"xstate": "^4"
}
}
```

```bash
npm i xstate5@npm:xstate@5 @xstate5/react@npm:@xstate/react@4 --force
npm i xstate5@npm:xstate@5 @xstate5/react@npm:@xstate/react@4
```

```js
Expand All @@ -2515,13 +2528,6 @@ fs.ensureSymlinkSync(
);
```

```json5
// package.json
"scripts": {
"postinstall": "node scripts/xstate5-react-script.js"
}
```

Then, you can use the XState v5 compatible version of `@xstate/react` in your code:

```ts
Expand Down