From 2a96ef82e524f9ef2b85d9b8212652ba144d6d33 Mon Sep 17 00:00:00 2001 From: Antoine Rey Date: Mon, 16 May 2022 20:23:34 +0200 Subject: [PATCH] Doc: Add dot-syntax documentation --- packages/vite-node/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/vite-node/README.md b/packages/vite-node/README.md index e2e3708e8f22..bcafb080b1f7 100644 --- a/packages/vite-node/README.md +++ b/packages/vite-node/README.md @@ -27,6 +27,16 @@ Options: npx vite-node -h ``` +### ViteNodeServer options + +[All `ViteNodeServer` options](https://github.com/vitest-dev/vitest/blob/main/packages/vite-node/src/types.ts#L61-L78) are supported by the CLI. They may be defined through the dot syntax, as shown below: + +```bash +npx vite-node --server-options.deps.inline="module-name" --server-options.deps.external="/module-regexp/" index.ts +``` + +Note that for options supporting RegExps, strings passed to the CLI must start _and_ end with a `/`; + ## Programmatic Usage In Vite Node, the server and runner (client) are separated, so you can integrate them in different contexts (workers, cross-process, or remote) if needed. The demo below shows a simple example of having both (server and runner) running in the same context