fix: rename the option in the cli config

sheremet-va · Nov 27, 2024 · 65578af · 65578af
1 parent d453876
commit 65578af
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 20 deletions.
diff --git a/docs/guide/cli.md b/docs/guide/cli.md
@@ -14,24 +14,25 @@ vite [root]
 
 #### Options
 
-| Options                  |                                                                                                                    |
-| ------------------------ | ------------------------------------------------------------------------------------------------------------------ |
-| `--host [host]`          | Specify hostname (`string`)                                                                                        |
-| `--port <port>`          | Specify port (`number`)                                                                                            |
-| `--open [path]`          | Open browser on startup (`boolean \| string`)                                                                      |
-| `--cors`                 | Enable CORS (`boolean`)                                                                                            |
-| `--strictPort`           | Exit if specified port is already in use (`boolean`)                                                               |
-| `--force`                | Force the optimizer to ignore the cache and re-bundle (`boolean`)                                                  |
-| `-c, --config <file>`    | Use specified config file (`string`)                                                                               |
-| `--base <path>`          | Public base path (default: `/`) (`string`)                                                                         |
-| `-l, --logLevel <level>` | info \| warn \| error \| silent (`string`)                                                                         |
-| `--clearScreen`          | Allow/disable clear screen when logging (`boolean`)                                                                |
-| `--profile`              | Start built-in Node.js inspector (check [Performance bottlenecks](/guide/troubleshooting#performance-bottlenecks)) |
-| `-d, --debug [feat]`     | Show debug logs (`string \| boolean`)                                                                              |
-| `-f, --filter <filter>`  | Filter debug logs (`string`)                                                                                       |
-| `-m, --mode <mode>`      | Set env mode (`string`)                                                                                            |
-| `-h, --help`             | Display available CLI options                                                                                      |
-| `-v, --version`          | Display version number                                                                                             |
+| Options                   |                                                                                                                    |
+| ------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| `--host [host]`           | Specify hostname (`string`)                                                                                        |
+| `--port <port>`           | Specify port (`number`)                                                                                            |
+| `--open [path]`           | Open browser on startup (`boolean \| string`)                                                                      |
+| `--cors`                  | Enable CORS (`boolean`)                                                                                            |
+| `--strictPort`            | Exit if specified port is already in use (`boolean`)                                                               |
+| `--force`                 | Force the optimizer to ignore the cache and re-bundle (`boolean`)                                                  |
+| `-c, --config <file>`     | Use specified config file (`string`)                                                                               |
+| `--base <path>`           | Public base path (default: `/`) (`string`)                                                                         |
+| `-l, --logLevel <level>`  | info \| warn \| error \| silent (`string`)                                                                         |
+| `--clearScreen`           | Allow/disable clear screen when logging (`boolean`)                                                                |
+| `--configLoader <loader>` | Use `bundle` to bundle the config with esbuild or `runner` to process it on the fly (default: `bundle`)            |
+| `--profile`               | Start built-in Node.js inspector (check [Performance bottlenecks](/guide/troubleshooting#performance-bottlenecks)) |
+| `-d, --debug [feat]`      | Show debug logs (`string \| boolean`)                                                                              |
+| `-f, --filter <filter>`   | Filter debug logs (`string`)                                                                                       |
+| `-m, --mode <mode>`       | Set env mode (`string`)                                                                                            |
+| `-h, --help`              | Display available CLI options                                                                                      |
+| `-v, --version`           | Display version number                                                                                             |
 
 ## Build
 

diff --git a/packages/vite/src/node/cli.ts b/packages/vite/src/node/cli.ts
@@ -154,8 +154,8 @@ cli
   .option('-l, --logLevel <level>', `[string] info | warn | error | silent`)
   .option('--clearScreen', `[boolean] allow/disable clear screen when logging`)
   .option(
-    '--bundleConfig',
-    `[boolean] should the config be bundled or evaluated with a module runner when importing`,
+    '--configLoader <loader>',
+    `[string] use 'bundle' to bundle the config with esbuild or 'runner' to process it on the fly (default: bundle)`,
   )
   .option('-d, --debug [feat]', `[string | boolean] show debug logs`)
   .option('-f, --filter <filter>', `[string] filter debug logs`)