feat: add nuxi tag to logs

eslint.config.js

@@ -17,4 +17,9 @@ export default createConfigForNuxt({
     // TODO: remove usage of `any` throughout codebase
     '@typescript-eslint/no-explicit-any': 'off',
   },
+}, {
+  files: ['src/**'],
+  rules: {
+    'no-console': 'error',
+  },
 })

src/commands/add.ts

@@ -1,7 +1,8 @@
 import { existsSync, promises as fsp } from 'node:fs'
 import { dirname, resolve, extname } from 'pathe'
-import { consola } from 'consola'
 import { defineCommand } from 'citty'
+
+import { logger } from '../utils/logger'
 import { loadKit } from '../utils/kit'
 import { templates } from '../utils/templates'
 import { cwdArgs, logLevelArgs } from './_shared'
@@ -43,7 +44,7 @@ export default defineCommand({
 
     // Validate template name
     if (!template) {
-      consola.error(
+      logger.error(
         `Template ${templateName} is not supported. Possible values: ${Object.keys(
           templates,
         ).join(', ')}`,
@@ -53,7 +54,7 @@ export default defineCommand({
 
     // Validate options
     if (!name) {
-      consola.error('name argument is missing!')
+      logger.error('name argument is missing!')
       process.exit(1)
     }
 
@@ -66,7 +67,7 @@ export default defineCommand({
 
     // Ensure not overriding user code
     if (!ctx.args.force && existsSync(res.path)) {
-      consola.error(
+      logger.error(
         `File exists: ${res.path} . Use --force to override or use a different name.`,
       )
       process.exit(1)
@@ -75,15 +76,15 @@ export default defineCommand({
     // Ensure parent directory exists
     const parentDir = dirname(res.path)
     if (!existsSync(parentDir)) {
-      consola.info('Creating directory', parentDir)
+      logger.info('Creating directory', parentDir)
       if (templateName === 'page') {
-        consola.info('This enables vue-router functionality!')
+        logger.info('This enables vue-router functionality!')
       }
       await fsp.mkdir(parentDir, { recursive: true })
     }
 
     // Write file
     await fsp.writeFile(res.path, res.contents.trim() + '\n')
-    consola.info(`🪄 Generated a new ${templateName} in ${res.path}`)
+    logger.info(`🪄 Generated a new ${templateName} in ${res.path}`)
   },
 })

src/commands/analyze.ts

@@ -8,6 +8,7 @@ import { defineCommand } from 'citty'
 import { loadKit } from '../utils/kit'
 import { clearDir } from '../utils/fs'
 import { overrideEnv } from '../utils/env'
+import { logger } from '../utils/logger'
 import { legacyRootDirArgs, dotEnvArgs, cwdArgs, logLevelArgs } from './_shared'
 
 export default defineCommand({
@@ -99,10 +100,8 @@ export default defineCommand({
       'utf-8',
     )
 
-    console.info('Analyze results are available at: `' + analyzeDir + '`')
-    console.warn(
-      'Do not deploy analyze results! Use `nuxi build` before deploying.',
-    )
+    logger.info('Analyze results are available at: `' + analyzeDir + '`')
+    logger.warn('Do not deploy analyze results! Use `nuxi build` before deploying.')
 
     if (ctx.args.serve !== false && !process.env.CI) {
       const app = createApp()
@@ -115,7 +114,7 @@ export default defineCommand({
           })
         })
 
-      console.info('Starting stats server...')
+      logger.info('Starting stats server...')
 
       app.use('/client', serveFile(join(analyzeDir, 'client.html')))
       app.use('/nitro', serveFile(join(analyzeDir, 'nitro.html')))

src/commands/build-module.ts

@@ -1,8 +1,9 @@
 import { x } from 'tinyexec'
-import { consola } from 'consola'
 import { resolve } from 'pathe'
 import { defineCommand } from 'citty'
 import { readPackageJSON } from 'pkg-types'
+
+import { logger } from '../utils/logger'
 import { cwdArgs, legacyRootDirArgs, logLevelArgs } from './_shared'
 
 const MODULE_BUILDER_PKG = '@nuxt/module-builder'
@@ -45,7 +46,7 @@ export default defineCommand({
 
     let cmd = 'nuxt-module-build'
     if (!hasLocal) {
-      consola.warn(
+      logger.warn(
         `Cannot find locally installed version of \`${MODULE_BUILDER_PKG}\` (>=0.2.0). Falling back to \`npx ${MODULE_BUILDER_PKG}\``,
       )
       cmd = 'npx'

src/commands/build.ts

@@ -1,7 +1,8 @@
 import { relative, resolve } from 'pathe'
-import { consola } from 'consola'
 import type { Nitro } from 'nitropack'
 import { defineCommand } from 'citty'
+
+import { logger } from '../utils/logger'
 import { loadKit } from '../utils/kit'
 import { clearBuildDir } from '../utils/fs'
 import { overrideEnv } from '../utils/env'
@@ -61,7 +62,7 @@ export default defineCommand({
     try {
       // Use ? for backward compatibility for Nuxt <= RC.10
       nitro = kit.useNitro?.()
-      consola.info(`Building for Nitro preset: \`${nitro.options.preset}\``)
+      logger.info(`Building for Nitro preset: \`${nitro.options.preset}\``)
     }
     catch {
       //
@@ -72,22 +73,22 @@ export default defineCommand({
     await kit.writeTypes(nuxt)
 
     nuxt.hook('build:error', (err) => {
-      consola.error('Nuxt Build Error:', err)
+      logger.error('Nuxt Build Error:', err)
       process.exit(1)
     })
 
     await kit.buildNuxt(nuxt)
 
     if (ctx.args.prerender) {
       if (!nuxt.options.ssr) {
-        consola.warn(
+        logger.warn(
           'HTML content not prerendered because `ssr: false` was set. You can read more in `https://nuxt.com/docs/getting-started/deployment#static-hosting`.',
         )
       }
       // TODO: revisit later if/when nuxt build --prerender will output hybrid
       const dir = nitro?.options.output.publicDir
       const publicDir = dir ? relative(process.cwd(), dir) : '.output/public'
-      consola.success(
+      logger.success(
         `You can now deploy \`${publicDir}\` to any static hosting!`,
       )
     }

src/commands/dev-child.ts

@@ -1,7 +1,8 @@
 import { resolve } from 'pathe'
-import { consola } from 'consola'
 import { defineCommand } from 'citty'
 import { isTest } from 'std-env'
+
+import { logger } from '../utils/logger'
 import { overrideEnv } from '../utils/env'
 import type { NuxtDevContext, NuxtDevIPCMessage } from '../utils/dev'
 import { createNuxtDevServer } from '../utils/dev'
@@ -20,8 +21,6 @@ export default defineCommand({
     ...legacyRootDirArgs,
   },
   async run(ctx) {
-    const logger = consola.withTag('nuxi')
-
     if (!process.send && !isTest) {
       logger.warn(
         '`nuxi _dev` is an internal command and should not be used directly. Please use `nuxi dev` instead.',

src/commands/dev.ts

@@ -6,14 +6,12 @@ import { setupDotenv } from 'c12'
 import type { ParsedArgs } from 'citty'
 import { defineCommand } from 'citty'
 import { isBun, isTest } from 'std-env'
-import {
-  getArgs as getListhenArgs,
-  parseArgs as parseListhenArgs,
-} from 'listhen/cli'
+import { getArgs as getListhenArgs, parseArgs as parseListhenArgs } from 'listhen/cli'
 import type { HTTPSOptions, ListenOptions } from 'listhen'
 import type { NuxtOptions } from '@nuxt/schema'
-import { consola } from 'consola'
 import { createJiti } from 'jiti'
+
+import { logger } from '../utils/logger'
 import { showVersions } from '../utils/banner'
 import { loadKit } from '../utils/kit'
 import { overrideEnv } from '../utils/env'
@@ -213,7 +211,7 @@ async function _startSubprocess(devProxy: DevProxy, rawArgs: string[]) {
         restart()
       }
       else if (message.type === 'nuxt:internal:dev:rejection') {
-        consola.withTag('nuxi').info(`Restarting Nuxt due to error: \`${message.message}\``)
+        logger.withTag('nuxi').info(`Restarting Nuxt due to error: \`${message.message}\``)
         restart()
       }
     })

src/commands/devtools.ts

@@ -2,6 +2,7 @@ import { resolve } from 'pathe'
 import { x } from 'tinyexec'
 import { defineCommand } from 'citty'
 
+import { logger } from '../utils/logger'
 import { cwdArgs, legacyRootDirArgs } from './_shared'
 
 export default defineCommand({
@@ -22,7 +23,7 @@ export default defineCommand({
     const cwd = resolve(ctx.args.cwd || ctx.args.rootDir)
 
     if (!['enable', 'disable'].includes(ctx.args.command)) {
-      console.error(`Unknown command \`${ctx.args.command}\`.`)
+      logger.error(`Unknown command \`${ctx.args.command}\`.`)
       process.exit(1)
     }
 

src/commands/info.ts

@@ -13,6 +13,7 @@ import nuxiPkg from '../../package.json' assert { type: 'json' }
 import { tryResolveNuxt } from '../utils/kit'
 import { getPackageManagerVersion } from '../utils/packageManagers'
 
+import { logger } from '../utils/logger'
 import { cwdArgs, legacyRootDirArgs } from './_shared'
 
 export default defineCommand({
@@ -97,7 +98,7 @@ export default defineCommand({
       BuildModules: await listModules((nuxtConfig as any /* nuxt v2 */).buildModules || []),
     }
 
-    console.log('Working directory:', cwd)
+    logger.log('Working directory:', cwd)
 
     let maxLength = 0
     const entries = Object.entries(infoObj).map(([key, val]) => {
@@ -120,12 +121,6 @@ export default defineCommand({
       .write(infoStr)
       .then(() => true)
       .catch(() => false)
-    const splitter = '------------------------------'
-    console.log(
-      `Nuxt project info: ${
-        copied ? '(copied to clipboard)' : ''
-      }\n\n${splitter}\n${infoStr}${splitter}\n`,
-    )
 
     const isNuxt3 = !isLegacy
     const isBridge = !isNuxt3 && infoObj.BuildModules.includes('bridge')
@@ -138,7 +133,8 @@ export default defineCommand({
       `👉 Read documentation: ${(isNuxt3 || isBridge) ? 'https://nuxt.com' : 'https://v2.nuxt.com'}`,
     ].filter(Boolean).join('\n')
 
-    console.log('\n' + log + '\n')
+    const splitter = '------------------------------'
+    logger.log(`Nuxt project info: ${copied ? '(copied to clipboard)' : ''}\n\n${splitter}\n${infoStr}${splitter}\n\n${log}\n`)
   },
 })
 

src/commands/init.ts

@@ -1,12 +1,12 @@
 import { downloadTemplate, startShell } from 'giget'
 import type { DownloadTemplateResult } from 'giget'
 import { relative, resolve } from 'pathe'
-import { consola } from 'consola'
 import { installDependencies } from 'nypm'
 import { x } from 'tinyexec'
 import type { PackageManagerName } from 'nypm'
 import { defineCommand } from 'citty'
 
+import { logger } from '../utils/logger'
 import { cwdArgs } from './_shared'
 
 const DEFAULT_REGISTRY
@@ -68,7 +68,7 @@ export default defineCommand({
     const templateName = ctx.args.template || DEFAULT_TEMPLATE_NAME
 
     if (typeof templateName !== 'string') {
-      consola.error('Please specify a template!')
+      logger.error('Please specify a template!')
       process.exit(1)
     }
 
@@ -89,7 +89,7 @@ export default defineCommand({
       if (process.env.DEBUG) {
         throw err
       }
-      consola.error((err as Error).toString())
+      logger.error((err as Error).toString())
       process.exit(1)
     }
 
@@ -106,18 +106,18 @@ export default defineCommand({
       packageManagerArg,
     )
       ? packageManagerArg
-      : await consola.prompt('Which package manager would you like to use?', {
+      : await logger.prompt('Which package manager would you like to use?', {
         type: 'select',
         options: packageManagerOptions,
       })
 
     // Install project dependencies
     // or skip installation based on the '--no-install' flag
     if (ctx.args.install === false) {
-      consola.info('Skipping install dependencies step.')
+      logger.info('Skipping install dependencies step.')
     }
     else {
-      consola.start('Installing dependencies...')
+      logger.start('Installing dependencies...')
 
       try {
         await installDependencies({
@@ -132,20 +132,20 @@ export default defineCommand({
         if (process.env.DEBUG) {
           throw err
         }
-        consola.error((err as Error).toString())
+        logger.error((err as Error).toString())
         process.exit(1)
       }
 
-      consola.success('Installation completed.')
+      logger.success('Installation completed.')
     }
 
     if (ctx.args.gitInit === undefined) {
-      ctx.args.gitInit = await consola.prompt('Initialize git repository?', {
+      ctx.args.gitInit = await logger.prompt('Initialize git repository?', {
         type: 'confirm',
       })
     }
     if (ctx.args.gitInit) {
-      consola.info('Initializing git repository...\n')
+      logger.info('Initializing git repository...\n')
       try {
         await x('git', ['init', template.dir], {
           throwOnError: true,
@@ -155,12 +155,12 @@ export default defineCommand({
         })
       }
       catch (err) {
-        consola.warn(`Failed to initialize git repository: ${err}`)
+        logger.warn(`Failed to initialize git repository: ${err}`)
       }
     }
 
     // Display next steps
-    consola.log(
+    logger.log(
       `\n✨ Nuxt project has been created with the \`${template.name}\` template. Next steps:`,
     )
     const relativeTemplateDir = relative(process.cwd(), template.dir) || '.'
@@ -173,7 +173,7 @@ export default defineCommand({
     ].filter(Boolean)
 
     for (const step of nextSteps) {
-      consola.log(` › ${step}`)
+      logger.log(` › ${step}`)
     }
 
     if (ctx.args.shell) {