refactor: deprecate vite optimize command (#19348)

vitejs · Feb 5, 2025 · 6e0e3c0 · 6e0e3c0
1 parent 7c2a794
commit 6e0e3c0
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/docs/guide/cli.md b/docs/guide/cli.md
@@ -79,6 +79,8 @@ vite build [root]
 
 Pre-bundle dependencies.
 
+**Deprecated**: the pre-bundle process runs automatically and does not need to be called.
+
 #### Usage
 
 ```bash

diff --git a/packages/vite/src/node/cli.ts b/packages/vite/src/node/cli.ts
@@ -333,7 +333,10 @@ cli
 
 // optimize
 cli
-  .command('optimize [root]', 'pre-bundle dependencies')
+  .command(
+    'optimize [root]',
+    'pre-bundle dependencies (deprecated, the pre-bundle process runs automatically and does not need to be called)',
+  )
   .option(
     '--force',
     `[boolean] force the optimizer to ignore the cache and re-bundle`,

diff --git a/packages/vite/src/node/optimizer/index.ts b/packages/vite/src/node/optimizer/index.ts
@@ -246,6 +246,8 @@ export interface DepOptimizationMetadata {
 /**
  * Scan and optimize dependencies within a project.
  * Used by Vite CLI when running `vite optimize`.
+ *
+ * @deprecated the optimization process runs automatically and does not need to be called
  */
 
 export async function optimizeDeps(
@@ -255,6 +257,12 @@ export async function optimizeDeps(
 ): Promise<DepOptimizationMetadata> {
   const log = asCommand ? config.logger.info : debug
 
+  config.logger.warn(
+    colors.yellow(
+      'manually calling optimizeDeps is deprecated. This is done automatically and does not need to be called manually.',
+    ),
+  )
+
   const environment = new ScanEnvironment('client', config)
   await environment.init()
-Original file line number
+Diff line change
@@ Expand Up / @@ -79,6 +79,8 @@ vite build [root] @@
     Pre-bundle dependencies.
+    **Deprecated**: the pre-bundle process runs automatically and does not need to be called.
     #### Usage
     ```bash
@@ Expand Down @@