Skip to content

Commit 4ff3d65

Browse files
committed
docs: add explanation about vite-plugin-cjs-interop
1 parent e94853b commit 4ff3d65

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

docs/src/routes/guide/index.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ solid-relay relay-runtime
2525
Install development dependencies:
2626

2727
```package-install-dev
28-
relay-compiler @types/relay-runtime vite-plugin-relay-lite
28+
relay-compiler @types/relay-runtime vite-plugin-relay-lite vite-plugin-cjs-interop
2929
```
3030

3131
## Project Setup
@@ -37,10 +37,15 @@ For SolidStart applications, configure your `app.config.ts`:
3737
```typescript
3838
import { defineConfig } from "@solidjs/start/config";
3939
import relay from "vite-plugin-relay-lite";
40+
import { cjsInterop } from "vite-plugin-cjs-interop";
4041

4142
export default defineConfig({
4243
vite: () => ({
43-
plugins: [relay()],
44+
plugins: [
45+
relay(),
46+
// required since Relay only gets published in CJS
47+
cjsInterop({ dependencies: ["relay-runtime"] }),
48+
],
4449
}),
4550
});
4651
```
@@ -53,11 +58,14 @@ For Vite-based applications, configure your `vite.config.ts`:
5358
import { defineConfig } from 'vite';
5459
import solid from 'vite-plugin-solid';
5560
import relay from 'vite-plugin-relay-lite';
61+
import { cjsInterop } from 'vite-plugin-cjs-interop';
5662

5763
export default defineConfig({
5864
plugins: [
5965
solid(),
6066
relay(),
67+
// required since Relay only gets published in CJS
68+
cjsInterop({ dependencies: ["relay-runtime"] }),
6169
],
6270
});
6371
```

0 commit comments

Comments
 (0)