feat: add clearScreen option

docs/config/index.md

@@ -201,6 +201,13 @@ export default ({ command, mode }) => {
 
   Adjust console output verbosity. Default is `'info'`.
 
+### clearScreen
+
+- **Type:** `boolean`
+- **Default:** `true`
+
+  Set to `false` to prevent Vite from clearing the terminal screen when logging certain messages. Via command line, use `--clearScreen false`.
+
 ## Server Options
 
 ### server.host
@@ -234,8 +241,9 @@ export default ({ command, mode }) => {
 - **Type:** `boolean | string`
 
   Automatically open the app in the browser on server start. When the value is a string, it will be used as the URL's pathname.
-  
+
   **Example:**
+
   ```js
   export default {
     server: {

packages/vite/src/node/cli.ts

@@ -22,6 +22,7 @@ interface GlobalCLIOptions {
   m?: string
   logLevel?: LogLevel
   l?: LogLevel
+  clearScreen?: boolean
 }
 
 /**
@@ -42,13 +43,15 @@ function cleanOptions(options: GlobalCLIOptions) {
   delete ret.m
   delete ret.logLevel
   delete ret.l
+  delete ret.clearScreen
   return ret
 }
 
 cli
   .option('-c, --config <file>', `[string] use specified config file`)
   .option('-r, --root <path>', `[string] use specified root directory`)
   .option('-l, --logLevel <level>', `[string] silent | error | warn | all`)
+  .option('--clearScreen', `[boolean] allow/disable clear screen when logging`)
   .option('-d, --debug [feat]', `[string | boolean] show debug logs`)
   .option('-f, --filter <filter>', `[string] filter debug logs`)
 
@@ -77,12 +80,14 @@ cli
         mode: options.mode,
         configFile: options.config,
         logLevel: options.logLevel,
+        clearScreen: options.clearScreen,
         server: cleanOptions(options) as ServerOptions
       })
       await server.listen()
     } catch (e) {
-      const logError = createLogger(options.logLevel).error
-      logError(chalk.red(`error when starting dev server:\n${e.stack}`))
+      createLogger(options.logLevel).error(
+        chalk.red(`error when starting dev server:\n${e.stack}`)
+      )
       process.exit(1)
     }
   })
@@ -125,11 +130,13 @@ cli
         mode: options.mode,
         configFile: options.config,
         logLevel: options.logLevel,
+        clearScreen: options.clearScreen,
         build: cleanOptions(options) as BuildOptions
       })
     } catch (e) {
-      const logError = createLogger(options.logLevel).error
-      logError(chalk.red(`error during build:\n${e.stack}`))
+      createLogger(options.logLevel).error(
+        chalk.red(`error during build:\n${e.stack}`)
+      )
       process.exit(1)
     }
   })
@@ -156,8 +163,9 @@ cli
         )
         await optimizeDeps(config, options.force, true)
       } catch (e) {
-        const logError = createLogger(options.logLevel).error
-        logError(chalk.red(`error when optimizing deps:\n${e.stack}`))
+        createLogger(options.logLevel).error(
+          chalk.red(`error when optimizing deps:\n${e.stack}`)
+        )
         process.exit(1)
       }
     }

packages/vite/src/node/config.ts

@@ -98,6 +98,10 @@ export interface UserConfig {
    * Default: 'info'
    */
   logLevel?: LogLevel
+  /**
+   * Default: true
+   */
+  clearScreen?: boolean
 }
 
 export interface InlineConfig extends UserConfig {
@@ -237,7 +241,7 @@ export async function resolveConfig(
     assetsInclude(file: string) {
       return DEFAULT_ASSETS_RE.test(file) || assetsFilter(file)
     },
-    logger: createLogger(config.logLevel)
+    logger: createLogger(config.logLevel, config.clearScreen)
   }
 
   resolved.plugins = await resolvePlugins(

packages/vite/src/node/logger.ts

@@ -35,8 +35,12 @@ function clearScreen() {
   readline.clearScreenDown(process.stdout)
 }
 
-export function createLogger(level: LogLevel = 'info'): Logger {
+export function createLogger(
+  level: LogLevel = 'info',
+  allowClearScreen = true
+): Logger {
   const thresh = LogLevels[level]
+  const clear = allowClearScreen ? clearScreen : () => {}
 
   function output(type: LogType, msg: string, options: LogOptions = {}) {
     if (thresh >= LogLevels[type]) {
@@ -49,23 +53,21 @@ export function createLogger(level: LogLevel = 'info'): Logger {
               : type === 'warn'
               ? chalk.yellow.bold(`[vite]`)
               : chalk.red.bold(`[vite]`)
-          return `${chalk.dim(
-            new Date().toLocaleTimeString()
-          )} ${tag} ${msg}`
+          return `${chalk.dim(new Date().toLocaleTimeString())} ${tag} ${msg}`
         } else {
           return msg
         }
       }
       if (type === lastType && msg === lastMsg) {
         sameCount++
-        clearScreen()
+        clear()
         console[method](format(), chalk.yellow(`(x${sameCount + 1})`))
       } else {
         sameCount = 0
         lastMsg = msg
         lastType = type
         if (options.clear) {
-          clearScreen()
+          clear()
         }
         console[method](format())
       }
@@ -84,7 +86,7 @@ export function createLogger(level: LogLevel = 'info'): Logger {
     },
     clearScreen(type) {
       if (thresh >= LogLevels[type]) {
-        clearScreen()
+        clear()
       }
     }
   }