Skip to content

docs: add --node-externals build command to the config page #439

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

Merged
merged 1 commit into from
Jun 9, 2024
Merged

docs: add --node-externals build command to the config page #439

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
6 changes: 4 additions & 2 deletions docs/pages/config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
### Build Arguments

There is a single build argument that you can pass to the `open-next build` command:
There is two build arguments that you can pass to the `open-next build` command:

- `--config-path` - This is the path to the configuration file that you want to use. By default, it will look for `open-next.config.ts` in the current working directory. This needs to be relative to the current working directory.
- `--node-externals` - You can configure externals for the esbuild compilation of the `open-next.config.ts` file (i.e `--node-externals @aws-sdk/*,open-next/dist/queue/*`)

### Configuration File

Expand All @@ -13,4 +15,4 @@ If you want to take a look at some simple configuration examples, you can check

For more advanced use cases, you can check [how to implement custom overrides](/config/custom_overrides).

If you want to look at a full example, you can check [the full example](/config/full_example).
If you want to look at a full example, you can check [the full example](/config/full_example).
Loading