refactor: make debugger nullable (#12687)

Author: bluwy

packages/vite/src/node/config.ts

@@ -775,16 +775,14 @@ export async function resolveConfig(
     )
   }
 
-  if (process.env.DEBUG) {
-    debug(`using resolved config: %O`, {
-      ...resolved,
-      plugins: resolved.plugins.map((p) => p.name),
-      worker: {
-        ...resolved.worker,
-        plugins: resolved.worker.plugins.map((p) => p.name),
-      },
-    })
-  }
+  debug?.(`using resolved config: %O`, {
+    ...resolved,
+    plugins: resolved.plugins.map((p) => p.name),
+    worker: {
+      ...resolved.worker,
+      plugins: resolved.worker.plugins.map((p) => p.name),
+    },
+  })
 
   if (config.build?.terserOptions && config.build.minify !== 'terser') {
     logger.warn(
@@ -915,7 +913,7 @@ export async function loadConfigFromFile(
   }
 
   if (!resolvedPath) {
-    debug('no config file found.')
+    debug?.('no config file found.')
     return null
   }
 
@@ -940,7 +938,7 @@ export async function loadConfigFromFile(
       bundled.code,
       isESM,
     )
-    debug(`bundled config file loaded in ${getTime()}`)
+    debug?.(`bundled config file loaded in ${getTime()}`)
 
     const config = await (typeof userConfig === 'function'
       ? userConfig(configEnv)

packages/vite/src/node/optimizer/index.ts

@@ -3,7 +3,6 @@ import fsp from 'node:fs/promises'
 import path from 'node:path'
 import { promisify } from 'node:util'
 import { performance } from 'node:perf_hooks'
-import _debug from 'debug'
 import colors from 'picocolors'
 import type { BuildContext, BuildOptions as EsbuildBuildOptions } from 'esbuild'
 import esbuild, { build } from 'esbuild'
@@ -37,9 +36,7 @@ export {
   getDepsOptimizer,
 } from './optimizer'
 
-export const debuggerViteDeps = createDebugger('vite:deps')
-const debug = debuggerViteDeps
-const isDebugEnabled = _debug('vite:deps').enabled
+const debug = createDebugger('vite:deps')
 
 const jsExtensionRE = /\.js$/i
 const jsMapExtensionRE = /\.js\.map$/i
@@ -243,7 +240,7 @@ export async function optimizeDeps(
   const deps = await discoverProjectDependencies(config).result
 
   const depsString = depsLogString(Object.keys(deps))
-  log(colors.green(`Optimizing dependencies:\n  ${depsString}`))
+  log?.(colors.green(`Optimizing dependencies:\n  ${depsString}`))
 
   await addManuallyIncludedOptimizeDeps(deps, config, ssr)
 
@@ -369,7 +366,7 @@ export async function loadCachedDepOptimizationMetadata(
     } catch (e) {}
     // hash is consistent, no need to re-bundle
     if (cachedMetadata && cachedMetadata.hash === getDepHash(config, ssr)) {
-      log('Hash is consistent. Skipping. Use --force to override.')
+      log?.('Hash is consistent. Skipping. Use --force to override.')
       // Nothing to commit or cancel as we are using the cache, we only
       // need to resolve the processing promise so requests can move on
       return cachedMetadata
@@ -440,7 +437,7 @@ export function toDiscoveredDependencies(
 }
 
 export function depsLogString(qualifiedIds: string[]): string {
-  if (isDebugEnabled) {
+  if (debug) {
     return colors.yellow(qualifiedIds.join(`, `))
   } else {
     const total = qualifiedIds.length
@@ -656,7 +653,7 @@ export function runOptimizeDeps(
           }
         }
 
-        debug(
+        debug?.(
           `Dependencies bundled in ${(performance.now() - start).toFixed(2)}ms`,
         )
 
@@ -1162,7 +1159,7 @@ export async function extractExportsData(
     parseResult = parse(entryContent)
   } catch {
     const loader = esbuildOptions.loader?.[path.extname(filePath)] || 'jsx'
-    debug(
+    debug?.(
       `Unable to parse: ${filePath}.\n Trying again with a ${loader} transform.`,
     )
     const transformed = await transformWithEsbuild(entryContent, filePath, {

packages/vite/src/node/optimizer/optimizer.ts

@@ -1,14 +1,12 @@
 import colors from 'picocolors'
-import _debug from 'debug'
-import { getHash } from '../utils'
+import { createDebugger, getHash } from '../utils'
 import { getDepOptimizationConfig } from '../config'
 import type { ResolvedConfig, ViteDevServer } from '..'
 import {
   addManuallyIncludedOptimizeDeps,
   addOptimizedDepInfo,
   createIsOptimizedDepFile,
   createIsOptimizedDepUrl,
-  debuggerViteDeps as debug,
   depsFromOptimizedDepInfo,
   depsLogString,
   discoverProjectDependencies,
@@ -28,7 +26,7 @@ import type {
   OptimizedDepInfo,
 } from '.'
 
-const isDebugEnabled = _debug('vite:deps').enabled
+const debug = createDebugger('vite:deps')
 
 /**
  * The amount to wait for requests to register newly found dependencies before triggering
@@ -214,7 +212,7 @@ async function createDepsOptimizer(
         // Runs in the background in case blocking high priority tasks
         ;(async () => {
           try {
-            debug(colors.green(`scanning for dependencies...`))
+            debug?.(colors.green(`scanning for dependencies...`))
 
             discover = discoverProjectDependencies(config)
             const deps = await discover.result
@@ -395,7 +393,7 @@ async function createDepsOptimizer(
       if (!needsReload) {
         await commitProcessing()
 
-        if (!isDebugEnabled) {
+        if (!debug) {
           if (newDepsToLogHandle) clearTimeout(newDepsToLogHandle)
           newDepsToLogHandle = setTimeout(() => {
             newDepsToLogHandle = undefined
@@ -420,15 +418,15 @@ async function createDepsOptimizer(
           // once a rerun is committed
           processingResult.cancel()
 
-          debug(
+          debug?.(
             colors.green(
               `✨ delaying reload as new dependencies have been found...`,
             ),
           )
         } else {
           await commitProcessing()
 
-          if (!isDebugEnabled) {
+          if (!debug) {
             if (newDepsToLogHandle) clearTimeout(newDepsToLogHandle)
             newDepsToLogHandle = undefined
             logNewlyDiscoveredDeps()
@@ -492,7 +490,7 @@ async function createDepsOptimizer(
     // optimizeDeps processing is finished
     const deps = Object.keys(metadata.discovered)
     const depsString = depsLogString(deps)
-    debug(colors.green(`new dependencies found: ${depsString}`))
+    debug?.(colors.green(`new dependencies found: ${depsString}`))
     runOptimizer()
   }
 
@@ -586,7 +584,7 @@ async function createDepsOptimizer(
   }
 
   async function onCrawlEnd() {
-    debug(colors.green(`✨ static imports crawl ended`))
+    debug?.(colors.green(`✨ static imports crawl ended`))
     if (firstRunCalled) {
       return
     }
@@ -606,7 +604,7 @@ async function createDepsOptimizer(
       const scanDeps = Object.keys(result.metadata.optimized)
 
       if (scanDeps.length === 0 && crawlDeps.length === 0) {
-        debug(
+        debug?.(
           colors.green(
             `✨ no dependencies found by the scanner or crawling static imports`,
           ),
@@ -635,16 +633,16 @@ async function createDepsOptimizer(
           }
         }
         if (scannerMissedDeps) {
-          debug(
+          debug?.(
             colors.yellow(
               `✨ new dependencies were found while crawling that weren't detected by the scanner`,
             ),
           )
         }
-        debug(colors.green(`✨ re-running optimizer`))
+        debug?.(colors.green(`✨ re-running optimizer`))
         debouncedProcessing(0)
       } else {
-        debug(
+        debug?.(
           colors.green(
             `✨ using post-scan optimizer result, the scanner found every used dependency`,
           ),
@@ -654,7 +652,7 @@ async function createDepsOptimizer(
       }
     } else {
       if (crawlDeps.length === 0) {
-        debug(
+        debug?.(
           colors.green(
             `✨ no dependencies found while crawling the static imports`,
           ),
@@ -808,7 +806,7 @@ function findInteropMismatches(
         // This only happens when a discovered dependency has mixed ESM and CJS syntax
         // and it hasn't been manually added to optimizeDeps.needsInterop
         needsInteropMismatch.push(dep)
-        debug(colors.cyan(`✨ needsInterop mismatch detected for ${dep}`))
+        debug?.(colors.cyan(`✨ needsInterop mismatch detected for ${dep}`))
       }
     }
   }

packages/vite/src/node/optimizer/scan.ts

@@ -34,7 +34,6 @@ import { transformGlobImport } from '../plugins/importMetaGlob'
 
 type ResolveIdOptions = Parameters<PluginContainer['resolveId']>[2]
 
-const isDebug = process.env.DEBUG
 const debug = createDebugger('vite:deps')
 
 const htmlTypesRE = /\.(html|vue|svelte|astro|imba)$/
@@ -85,7 +84,7 @@ export function scanImports(config: ResolvedConfig): {
     }
     if (scanContext.cancelled) return
 
-    debug(
+    debug?.(
       `Crawling dependencies using entries: ${entries
         .map((entry) => `\n  ${colors.dim(entry)}`)
         .join('')}`,
@@ -141,7 +140,7 @@ export function scanImports(config: ResolvedConfig): {
       throw e
     })
     .finally(() => {
-      if (isDebug) {
+      if (debug) {
         const duration = (performance.now() - start).toFixed(2)
         const depsStr =
           Object.keys(orderedDependencies(deps))

packages/vite/src/node/plugins/esbuild.ts

@@ -24,7 +24,6 @@ import type { ResolvedConfig, ViteDevServer } from '..'
 import type { Plugin } from '../plugin'
 import { searchForWorkspaceRoot } from '..'
 
-const isDebug = process.env.DEBUG
 const debug = createDebugger('vite:esbuild')
 
 const INJECT_HELPERS_IIFE_RE =
@@ -193,7 +192,7 @@ export async function transformWithEsbuild(
       map,
     }
   } catch (e: any) {
-    debug(`esbuild error with options used: `, resolvedOptions)
+    debug?.(`esbuild error with options used: `, resolvedOptions)
     // patch error information
     if (e.errors) {
       e.frame = ''
@@ -455,7 +454,7 @@ function initTSConfck(root: string, force = false) {
 }
 
 async function initTSConfckParseOptions(workspaceRoot: string) {
-  const start = isDebug ? performance.now() : 0
+  const start = debug ? performance.now() : 0
 
   const options: TSConfckParseOptions = {
     cache: new Map(),
@@ -468,7 +467,7 @@ async function initTSConfckParseOptions(workspaceRoot: string) {
     resolveWithEmptyIfConfigNotFound: true,
   }
 
-  isDebug && debug(timeFrom(start), 'tsconfck init', colors.dim(workspaceRoot))
+  debug?.(timeFrom(start), 'tsconfck init', colors.dim(workspaceRoot))
 
   return options
 }

packages/vite/src/node/plugins/importAnalysis.ts

@@ -62,7 +62,6 @@ import {
 import { isCSSRequest, isDirectCSSRequest, isModuleCSSRequest } from './css'
 import { browserExternalId } from './resolve'
 
-const isDebug = !!process.env.DEBUG
 const debug = createDebugger('vite:import-analysis')
 
 const clientDir = normalizePath(CLIENT_DIR)
@@ -207,7 +206,7 @@ export function importAnalysisPlugin(config: ResolvedConfig): Plugin {
       const prettyImporter = prettifyUrl(importer, root)
 
       if (canSkipImportAnalysis(importer)) {
-        isDebug && debug(colors.dim(`[skipped] ${prettyImporter}`))
+        debug?.(colors.dim(`[skipped] ${prettyImporter}`))
         return null
       }
 
@@ -259,12 +258,9 @@ export function importAnalysisPlugin(config: ResolvedConfig): Plugin {
 
       if (!imports.length && !(this as any)._addedImports) {
         importerModule.isSelfAccepting = false
-        isDebug &&
-          debug(
-            `${timeFrom(start)} ${colors.dim(
-              `[no imports] ${prettyImporter}`,
-            )}`,
-          )
+        debug?.(
+          `${timeFrom(start)} ${colors.dim(`[no imports] ${prettyImporter}`)}`,
+        )
         return source
       }
 
@@ -572,7 +568,7 @@ export function importAnalysisPlugin(config: ResolvedConfig): Plugin {
                   )
                 }
               } else if (needsInterop) {
-                debug(`${url} needs interop`)
+                debug?.(`${url} needs interop`)
                 interopNamedImports(str(), imports[index], url, index)
                 rewriteDone = true
               }
@@ -682,7 +678,7 @@ export function importAnalysisPlugin(config: ResolvedConfig): Plugin {
       }
 
       if (hasHMR && !ssr) {
-        debugHmr(
+        debugHmr?.(
           `${
             isSelfAccepting
               ? `[self-accepts]`
@@ -766,12 +762,11 @@ export function importAnalysisPlugin(config: ResolvedConfig): Plugin {
         }
       }
 
-      isDebug &&
-        debug(
-          `${timeFrom(start)} ${colors.dim(
-            `[${importedUrls.size} imports rewritten] ${prettyImporter}`,
-          )}`,
-        )
+      debug?.(
+        `${timeFrom(start)} ${colors.dim(
+          `[${importedUrls.size} imports rewritten] ${prettyImporter}`,
+        )}`,
+      )
 
       if (s) {
         return transformStableResult(s, importer, config)

packages/vite/src/node/plugins/optimizedDeps.ts

@@ -10,7 +10,6 @@ export const ERR_OPTIMIZE_DEPS_PROCESSING_ERROR =
   'ERR_OPTIMIZE_DEPS_PROCESSING_ERROR'
 export const ERR_OUTDATED_OPTIMIZED_DEP = 'ERR_OUTDATED_OPTIMIZED_DEP'
 
-const isDebug = process.env.DEBUG
 const debug = createDebugger('vite:optimize-deps')
 
 export function optimizedDepsPlugin(config: ResolvedConfig): Plugin {
@@ -62,7 +61,7 @@ export function optimizedDepsPlugin(config: ResolvedConfig): Plugin {
             }
           }
         }
-        isDebug && debug(`load ${colors.cyan(file)}`)
+        debug?.(`load ${colors.cyan(file)}`)
         // Load the file from the cache instead of waiting for other plugin
         // load hooks to avoid race conditions, once processing is resolved,
         // we are sure that the file has been properly save to disk
@@ -117,7 +116,7 @@ export function optimizedDepsBuildPlugin(config: ResolvedConfig): Plugin {
       const info = optimizedDepInfoFromFile(depsOptimizer.metadata, file)
       if (info) {
         await info.processing
-        isDebug && debug(`load ${colors.cyan(file)}`)
+        debug?.(`load ${colors.cyan(file)}`)
       } else {
         throw new Error(
           `Something unexpected happened while optimizing "${id}".`,