feat(dev): suggest using nuxt curl when starting a dev server in non-interactive mode

Author: danielroe

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

@@ -103,6 +103,16 @@ function printHelp(context: ActionContext): void {
   console.log(`\n${lines.join('\n')}\n`)
 }
 
+/**
+ * Without a TTY there are no shortcuts to offer, so point at the way to talk to
+ * the server instead: non-interactive callers (scripts, agents) otherwise have
+ * no indication that one exists.
+ */
+function printRequestHint(): void {
+  // eslint-disable-next-line no-console
+  console.log(`\n  ${styleText('dim', 'run')} ${styleText('bold', 'nuxt curl /api/hello')} ${styleText('dim', 'to send a request to this server')}\n`)
+}
+
 function availableShortcuts(context: ShortcutContext): Shortcut[] {
   return shortcuts.filter(shortcut => shortcut.isAvailable?.(context) !== false)
 }
@@ -115,6 +125,9 @@ function availableShortcuts(context: ShortcutContext): Shortcut[] {
  */
 export function setupShortcuts(context: ShortcutContext): void {
   if (!process.stdin.isTTY || isCI || isTest) {
+    if (!isTest) {
+      context.onReady(() => printRequestHint())
+    }
     return
   }
 

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

@@ -88,6 +88,18 @@ describe('setupShortcuts', () => {
     expect(setup().stdin.listenerCount('data')).toBe(0)
   })
 
+  it('should suggest `nuxt curl` when there is no TTY', () => {
+    setup({}, { isTTY: false })
+
+    expect(vi.mocked(console.log).mock.calls.join('\n')).toContain('nuxt curl /api/hello')
+  })
+
+  it('should not suggest `nuxt curl` when shortcuts are available', () => {
+    setup()
+
+    expect(vi.mocked(console.log).mock.calls.join('\n')).not.toContain('nuxt curl')
+  })
+
   it('should take stdin out of raw mode', async () => {
     const { stdin, listener, press } = setup({}, { isRaw: true })