feat(dev): support opening a custom path or url

Author: danielroe

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

@@ -65,6 +65,10 @@ const command = defineCommand({
       alias: ['o'],
       default: false,
     },
+    'open.url': {
+      type: 'string',
+      description: 'Path or URL to open instead of the dev server root',
+    },
     'clipboard': {
       type: 'boolean',
       description: 'Copy the URL to the clipboard',
@@ -298,7 +302,8 @@ function resolveListenOverrides(args: ParsedArgs<ArgsT>): DevListenOverrides {
       || undefined,
     strictPort: args.strictPort,
     hostname: host === true || host === '' ? '' : host || undefined,
-    open: args.open,
+    open: args.open || !!args['open.url'],
+    openURL: args['open.url'] || undefined,
     clipboard: args.clipboard,
     qr: args.qr,
     tunnel: args.tunnel,

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

@@ -25,6 +25,8 @@ export interface ListenOptions {
   baseURL?: string
   showURL?: boolean
   open?: boolean
+  /** Path (resolved against the dev server URL) or absolute URL to open. */
+  openURL?: string
   clipboard?: boolean
   qr?: boolean
   tunnel?: boolean
@@ -202,7 +204,7 @@ export async function listen(handler: RequestListener, options: ListenOptions =
   }
 
   if (options.open) {
-    openBrowser(url)
+    openBrowser(options.openURL ? resolveOpenURL(options.openURL, url) : url)
   }
 
   return {
@@ -253,6 +255,16 @@ function centerBlock(block: string): string {
   return lines.map(line => indent + line).join('\n')
 }
 
+function resolveOpenURL(target: string, baseURL: string): string {
+  try {
+    return new URL(target, baseURL).href
+  }
+  catch {
+    logger.warn(`Ignoring invalid \`--open.url\` value: ${target}`)
+    return baseURL
+  }
+}
+
 /**
  * Resolve the command that opens `url`, honouring the de facto `BROWSER` and
  * `BROWSER_ARGS` environment variables (`BROWSER=none` disables opening).

packages/nuxt-cli/test/unit/listen.spec.ts

@@ -6,6 +6,10 @@ import { afterEach, describe, expect, it, vi } from 'vitest'
 
 import { getNetworkAddresses, listen, resolveOpenCommand } from '../../src/dev/listen'
 
+const spawn = vi.hoisted(() => vi.fn((_command: string, _args: string[]) => ({ on: () => ({ unref: () => {} }) })))
+
+vi.mock('node:child_process', () => ({ spawn }))
+
 vi.mock('node:os', () => ({
   networkInterfaces: vi.fn(() => ({})),
   release: () => 'test',
@@ -91,6 +95,20 @@ describe('listen', () => {
     await expect(start({ port: first.address.port, strictPort: true })).rejects.toThrow(/already in use/)
   })
 
+  it('should open the dev server URL', async () => {
+    const listener = await start({ port: 0, open: true })
+
+    expect(spawn.mock.lastCall?.[1]).toContain(listener.url)
+  })
+
+  it('should open a path or URL relative to the dev server', async () => {
+    const listener = await start({ port: 0, open: true, openURL: '/dashboard' })
+    expect(spawn.mock.lastCall?.[1]).toContain(`${listener.url}dashboard`)
+
+    await start({ port: 0, open: true, openURL: 'https://example.com/foo' })
+    expect(spawn.mock.lastCall?.[1]).toContain('https://example.com/foo')
+  })
+
   it('should use the requested port with `strictPort`', async () => {
     const { address } = await start({ port: 0 })
     const port = address.port