Skip to content
Merged
Changes from all commits
Commits
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
14 changes: 8 additions & 6 deletions tools/egg-bundler/docs/output-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,14 @@ checks (T17).
## Externals

Packages classified as external by `ExternalsResolver` are **not** inlined.
This includes the user's `externals.force` list, root `peerDependencies`,
always-external packages (`egg`, `@swc/helpers`, and `@eggjs/*`), native addons,
and ESM-only packages. They must be installed alongside the bundle — typically
by copying the app's `package.json` next to
`worker.js` and running `npm ci --omit=dev`, or by deploying the bundle
into an image that already has these dependencies on disk.
This includes the user's `externals.force` list, root `peerDependencies`, root
`optionalDependencies`, and native addons/native binaries. They must be
Comment on lines +61 to +62
installed alongside the bundle — typically by copying the app's `package.json`
Comment on lines +61 to +63
next to `worker.js` and running `npm ci --omit=dev`, or by deploying into an
environment where these dependencies are already installed. ESM-only packages,
`egg`, `@swc/helpers`, and `@eggjs/*` packages are bundled by default unless
`ExternalsResolver` externalizes them through `externals.force`, dependency
metadata, or native addon detection.

## Known limitations

Expand Down
Loading