chore: remove narration comments

Author: danielroe

packages/create-nuxt/src/init.ts

@@ -226,7 +226,6 @@ export default defineCommand({
     if (!ctx.args.template || !ctx.args.dir) {
       const defaultTemplates = await import('../../nuxt-cli/src/data/templates').then(r => r.templates)
       if (ctx.args.offline || ctx.args.preferOffline) {
-        // In offline mode, use static templates directly
         availableTemplates = defaultTemplates
       }
       else {
@@ -297,7 +296,6 @@ export default defineCommand({
       prompted = true
     }
 
-    // Fallback to default if still not set
     templateName ||= DEFAULT_TEMPLATE_NAME
 
     if (typeof templateName !== 'string') {
@@ -329,8 +327,6 @@ export default defineCommand({
 
     let shouldForce = Boolean(ctx.args.force)
 
-    // Prompt the user if the template download directory already exists
-    // when no `--force` flag is provided
     const shouldVerify = !shouldForce && existsSync(templateDownloadPath)
     if (shouldVerify) {
       if (isNonInteractive) {
@@ -371,14 +367,12 @@ export default defineCommand({
           break
         }
 
-        // 'Abort'
         case 'abort':
         default:
           process.exit(1)
       }
     }
 
-    // Download template
     let template: DownloadTemplateResult
 
     const registry = process.env.NUXI_INIT_REGISTRY || DEFAULT_REGISTRY
@@ -482,7 +476,6 @@ export default defineCommand({
     const recoveryCommands: string[] = []
 
     const currentPackageManager = detectCurrentPackageManager()
-    // Resolve package manager
     const packageManagerArg = ctx.args.packageManager as PackageManagerName
     const packageManagerSelectOptions = packageManagerOptions.map(pm => ({
       label: pm,
@@ -545,7 +538,6 @@ export default defineCommand({
       logger.info(`Created ${styleText('cyan', '.yarnrc.yml')} with ${styleText('cyan', 'nodeLinker: node-modules')}, as Nuxt cannot resolve its modules under Yarn's Plug'n'Play linker.`)
     }
 
-    // Determine if we should init git
     let gitInit: boolean | undefined = ctx.args.gitInit === 'false' as unknown ? false : ctx.args.gitInit
     if (gitInit === undefined) {
       const result = await confirm({
@@ -561,8 +553,6 @@ export default defineCommand({
       prompted = true
     }
 
-    // Install project dependencies and initialize git
-    // or skip installation based on the '--no-install' flag
     if (!installRequested || skipInstallOnConflict) {
       if (!skipInstallOnConflict) {
         logger.info('Skipping install dependencies step.')
@@ -652,13 +642,9 @@ export default defineCommand({
         logger.warn(`Skipping module installation. Add ${requestedModules.map(mod => styleText('cyan', mod)).join(', ')} with ${styleText('cyan', 'nuxt module add')} once dependencies are installed.`)
       }
     }
-
-    // Get modules from arg (if provided)
     else if (ctx.args.modules !== undefined) {
       modulesToAdd.push(...requestedModules)
     }
-
-    // ...or offer to browse and install modules (if not offline nor non-interactive)
     else if (!ctx.args.offline && !ctx.args.preferOffline && !isNonInteractive) {
       // Requested before the prompt so the list is ready if the user says yes,
       // but a failure is only reported to users who asked for it (and never
@@ -731,7 +717,6 @@ export default defineCommand({
       }
     }
 
-    // Add modules
     if (modulesToAdd.length > 0) {
       const args: string[] = [
         ...modulesToAdd,

packages/nuxi/src/main.ts

@@ -55,15 +55,14 @@ const _main = defineCommand({
     setupGlobalConsole({ dev: command === 'dev' })
     debug(`Running \`nuxt ${command}\` command`)
 
-    // Check Node.js version in background
     let backgroundTasks: Promise<any> | undefined
     if (provider !== 'stackblitz') {
       backgroundTasks = Promise.all([
         checkEngines(),
       ]).catch(err => logger.error(String(err)))
     }
 
-    // Avoid background check to fix prompt issues
+    // Awaited so the engine warning cannot land in the middle of a prompt.
     if (command === 'init') {
       await backgroundTasks
     }

packages/nuxt-cli/src/commands/dev.ts

@@ -154,7 +154,6 @@ const command = defineCommand({
     },
   },
   async run(ctx) {
-    // Prepare
     const requestedCwd = resolveRootDir(ctx.args)
     const cwd = await preflight({ cwd: requestedCwd })
     if (cwd !== requestedCwd) {
@@ -190,7 +189,6 @@ const command = defineCommand({
       await openInspector(inspect)
     }
 
-    // Start the initial dev server in-process with listener
     const { listener, close, reload, onRestart, onReady, onFileChange } = await initialize({ cwd, args: ctx.args, handoverFrom: takeover.action === 'taken' ? takeover.pid : undefined }, {
       data: ctx.data,
       listenOverrides,
@@ -226,7 +224,6 @@ const command = defineCommand({
       pool.startWarming()
     })
 
-    // On hard restart, use a fork from the pool
     // Whatever is serving the app right now: this process, then each fork in turn.
     let closeCurrent = close
     let currentPid = process.pid
@@ -261,7 +258,6 @@ const command = defineCommand({
       // serialised whenever the inspector is open.
       const handover = reusePort && !inspect
 
-      // Get a fork from the pool (warm if available, cold otherwise)
       const context: NuxtDevContext = {
         cwd,
         args: ctx.args,
@@ -283,7 +279,6 @@ const command = defineCommand({
             ? { port: listener.address.port, handover: true }
             : undefined,
           onMessage: (message) => {
-            // Handle IPC messages from the fork
             if (message.type === 'nuxt:internal:dev:ready' || message.type === 'nuxt:internal:dev:loading:error') {
               serving = true
               if (message.type === 'nuxt:internal:dev:ready' && startTime) {
@@ -295,7 +290,6 @@ const command = defineCommand({
               // leaves the outgoing server in place.
             }
             else if (message.type === 'nuxt:internal:dev:restart') {
-              // Fork is requesting another restart
               void restartWithFork(message.reason)
             }
             else if (message.type === 'nuxt:internal:dev:rejection') {

packages/nuxt-cli/src/commands/module/add.ts

@@ -376,7 +376,6 @@ async function resolveModule(moduleName: string, cwd: string, modulesDB: NuxtMod
   if (matchedModule && matchedModule.compatibility.nuxt) {
     const nuxtVersion = await getProjectNuxtVersion()
 
-    // Check for Module Compatibility
     if (!checkNuxtCompatibility(matchedModule, nuxtVersion)) {
       logger.warn(
         `The module ${styleText('cyan', pkgName)} is not compatible with Nuxt ${styleText('cyan', nuxtVersion)} (requires ${styleText('cyan', matchedModule.compatibility.nuxt)})`,
@@ -390,7 +389,6 @@ async function resolveModule(moduleName: string, cwd: string, modulesDB: NuxtMod
       }
     }
 
-    // Match corresponding version of module for local Nuxt version
     const versionMap = matchedModule.compatibility.versionMap
     if (versionMap) {
       for (const [_nuxtVersion, _moduleVersion] of Object.entries(versionMap)) {
@@ -420,7 +418,6 @@ async function resolveModule(moduleName: string, cwd: string, modulesDB: NuxtMod
     }
   }
 
-  // Fetch package on npm
   let version = pkgVersion || 'latest'
   const pkgScope = pkgName.startsWith('@') ? pkgName.split('/')[0]! : null
   const meta: RegistryMeta = await detectNpmRegistry(pkgScope, cwd)
@@ -440,7 +437,6 @@ async function resolveModule(moduleName: string, cwd: string, modulesDB: NuxtMod
     return false
   }
 
-  // fully resolve the version
   if (pkgDetails['dist-tags']?.[version]) {
     version = pkgDetails['dist-tags'][version]
   }

packages/nuxt-cli/src/dev/index.ts

@@ -20,7 +20,7 @@ function formatErrorMessage(error: unknown): string {
 
 /**
  * Hand an unhandled rejection to the parent process and stop this one, unless
- * it is only a client that went away — that is traffic, not a crash, and the
+ * it is only a client that went away. That is traffic, not a crash, and the
  * session has to survive it.
  */
 export function createRejectionHandler(report: (message: string) => void, stop: () => void): (reason: unknown) => void {
@@ -42,7 +42,6 @@ interface InitializeOptions {
   showBanner?: boolean
 }
 
-// IPC Hooks
 class IPC {
   enabled = !!process.send && !process.title?.includes('vitest') && process.env.__NUXT__FORK
   #shutdown?: () => Promise<void>
@@ -186,7 +185,6 @@ export async function initialize(devContext: NuxtDevContext, ctx: InitializeOpti
     })
   }
 
-  // Init server
   await devServer.init()
 
   if (process.env.DEBUG) {

packages/nuxt-cli/src/dev/pool.ts

@@ -70,7 +70,6 @@ export class ForkPool {
     }
     this.warming = true
 
-    // Start warming forks up to pool size
     for (let i = 0; i < this.poolSize; i++) {
       this.warmFork()
     }
@@ -165,7 +164,6 @@ export class ForkPool {
         fork.state = 'ready'
       }
     }).catch(() => {
-      // Fork failed to warm, remove from pool
       this.removeFork(fork)
     })
     this.pool.push(fork)
@@ -201,20 +199,17 @@ export class ForkPool {
       serving: false,
     }
 
-    // Listen for fork-ready message
     childProc.on('message', (message: NuxtDevIPCMessage) => {
       if (message.type === 'nuxt:internal:dev:fork-ready') {
         readyResolve()
       }
     })
 
-    // Handle errors
     childProc.on('error', (err) => {
       readyReject(err)
       this.removeFork(pooledFork)
     })
 
-    // Handle unexpected exit
     childProc.on('close', (errorCode) => {
       // A fork can exit without ever emitting `error` (a throw while loading the
       // entry, or a kill), which would leave `ready` pending forever.
@@ -223,7 +218,6 @@ export class ForkPool {
         // Ending the session on the crash of the process that holds the listener is
         // silent otherwise, leaving no clue as to what stopped the dev server.
         logger.error(`The dev server process (PID ${childProc.pid}) exited with code ${errorCode}.`)
-        // Active fork crashed
         process.exit(errorCode)
       }
       this.removeFork(pooledFork)

packages/nuxt-cli/src/dev/utils.ts

@@ -399,7 +399,6 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
     try {
       this.closeWatchers()
 
-      // For reloads, we already have a listener, so use the existing flow
       await this.#load(reload, reason)
 
       this.#loadingError = undefined
@@ -538,11 +537,9 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
       throw new Error('Nuxt must be loaded before creating listener')
     }
 
-    // Merge config values with CLI overrides
     const listenOptions = this.#resolveListenOptions()
     this.listener = await listen(this.handler, listenOptions)
 
-    // Apply devServer overrides based on whether listener is public
     if (listenOptions.public) {
       this.#currentNuxt.options.devServer.cors = { origin: '*' }
       if (this.#currentNuxt.options.vite?.server) {
@@ -551,7 +548,6 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
       return
     }
 
-    // Get listener URLs for configuring allowed hosts
     const urls = this.listener.getURLs().map(({ url }) => url)
     if (urls.length > 0) {
       this.#currentNuxt.options.vite = defu(this.#currentNuxt.options.vite, {
@@ -574,7 +570,6 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
 
     const hostname = overrides.hostname ?? nuxtConfig.devServer?.host
 
-    // Resolve public flag
     const isPublic = provider === 'codesandbox' || (overrides.public ?? (isPublicHostname(hostname) ? true : undefined))
 
     // `--https` (or its absence) wins over the config; `https.*` arguments and
@@ -583,7 +578,6 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
     const https = (httpsEnabled ?? !!nuxtConfig.devServer?.https)
       && defu(typeof overrides.https === 'object' ? overrides.https : {}, httpsFromConfig)
 
-    // Resolve baseURL
     const baseURL = nuxtConfig.app?.baseURL?.startsWith?.('./')
       ? nuxtConfig.app.baseURL.slice(1)
       : nuxtConfig.app?.baseURL
@@ -607,7 +601,6 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
       this.emit('change')
     })
 
-    // Connect Vite HMR
     if (!process.env.NUXI_DISABLE_VITE_HMR) {
       this.#currentNuxt.hooks.hook('vite:extend', ({ config }) => {
         if (config.server) {
@@ -616,13 +609,11 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
       })
     }
 
-    // Remove websocket handlers on close
     this.#currentNuxt.hooks.hookOnce('close', () => {
       this.#closeWebSocketConnections()
       this.listener.server.removeAllListeners('upgrade')
     })
 
-    // Write manifest and also check if we need cache invalidation
     if (!reload) {
       const previousManifest = await loadNuxtManifest(this.#currentNuxt.options.buildDir)
       const newManifest = resolveNuxtManifest(this.#currentNuxt)
@@ -666,7 +657,6 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
         }
         nuxt.server.upgrade(req, socket as any, head)
 
-        // Track WebSocket connections
         this.#websocketConnections.add(socket)
         socket.on('close', () => {
           this.#websocketConnections.delete(socket)
@@ -700,7 +690,6 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
       throw new Error('Nitro server has not been initialized.')
     }
 
-    // Watch dist directory
     const distDir = join(this.#currentNuxt.options.buildDir, 'dist')
     await mkdir(distDir, { recursive: true })
     this.#fileChangeTracker.prime(distDir)
@@ -727,7 +716,6 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
       this.#handler = toNodeListener(this.#currentNuxt.server.app)
     }
 
-    // Emit ready with the server URL
     const serverUrl = getAddressURL(addr, !!this.listener.https).replace(TRAILING_SLASH_RE, '')
 
     // Re-acquire if buildDir changed (nuxt.config edits can move it on reload);
@@ -835,7 +823,6 @@ export class NuxtDevServer extends EventEmitter<DevServerEventMap> {
       }
     }
 
-    // Configure the Nuxt instance (shared logic with initial load)
     await this.#initializeNuxt(!!reload)
   }
 

packages/nuxt-cli/src/utils/console.ts

@@ -8,7 +8,6 @@ import { isRemotePeerError } from './errors'
 import { debug } from './logger'
 import { trackOutputSpacing } from './stdout'
 
-// Filter out unwanted logs
 // TODO: Use better API from consola for intercepting logs
 function wrapReporter(reporter: ConsolaReporter) {
   return ({
@@ -33,7 +32,6 @@ export function setupGlobalConsole(opts: { dev?: boolean } = {}) {
   consola.options.formatOptions.date = false
   consola.options.reporters = consola.options.reporters.map(wrapReporter)
 
-  // Wrap all console logs with consola for better DX
   if (opts.dev) {
     trackOutputSpacing()
     consola.wrapAll()

packages/nuxt-cli/src/utils/formatting.ts

@@ -51,7 +51,6 @@ export function formatInfoBox(infoObj: Record<string, string | undefined>): stri
     return [label, val || '-'] as const
   })
 
-  // get maximum width of terminal
   const terminalWidth = Math.max(process.stdout.columns || 80, firstColumnLength) - 8 /* box padding + extra margin */
 
   let boxStr = ''
@@ -64,7 +63,6 @@ export function formatInfoBox(infoObj: Record<string, string | undefined>): stri
 
     let boxRowLength = firstColumnLength
 
-    // Split by spaces and wrap as needed
     const words = formattedValue.split(' ')
     let currentLine = ''
 
@@ -73,7 +71,6 @@ export function formatInfoBox(infoObj: Record<string, string | undefined>): stri
       const spaceLength = currentLine ? 1 : 0
 
       if (boxRowLength + wordLength + spaceLength > terminalWidth) {
-        // Wrap to next line
         if (currentLine) {
           boxStr += styleText('cyan', currentLine)
         }