blob: f87c1e3379154cc8c686b558ebc0f44f42c1a1eb (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
---
name: Configuring a monorepo using workspaces
---
Bun's package manager supports npm `"workspaces"`. This allows you to split a codebase into multiple distinct "packages" that live in the same repository, can depend on each other, and (when possible) share a `node_modules` directory.
---
The root `package.json` should not contain any `"dependencies"`, `"devDependencies"`, etc. Each individual package should be self-contained and declare its own dependencies. Similarly, it's conventional to declare `"private": true` to avoid accidentally publishing the root package to `npm`.
```json#package.json
{
"name": "my-monorepo",
"private": true,
"workspaces": [
"packages/*"
]
}
```
---
It's common to place all packages in a `packages` directory. The `"workspaces"` field in package.json supports glob patterns, so you can use `packages/*` to indicate that each subdirectory of `packages` should be considered separate _package_ (also known as a workspace).
```txt
.
├── package.json
├── node_modules
└── packages
├── stuff-a
│ └── package.json
└── stuff-b
└── package.json
```
---
To add one workspace as a dependency of another, modify its `package.json`. Here we're adding `stuff-a` as a dependency of `stuff-b`.
```json#packages/stuff-b/package.json
{
"name": "stuff-b",
"dependencies": {
+ "stuff-a": "*"
}
}
```
---
Once added, run `bun install` from the project root to install dependencies for all workspaces.
```sh
$ bun install
```
---
To add npm dependencies to a particular workspace, just `cd` to the appropriate directory and run `bun add` commands as you would normally. Bun will detect that you are in a workspace and hoist the dependency as needed.
```sh
$ cd packages/stuff-a
$ bun add zod
```
---
See [Docs > Package manager](/docs/cli/install) for complete documentation of Bun's package manager.
|
