fix(dev): suggest a route that exists, only where it can be read

Author: danielroe

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

@@ -106,13 +106,16 @@ function printHelp(context: ActionContext): void {
 }
 
 /**
- * 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.
+ * Without a readable stdin there are no shortcuts to offer, so point at the way
+ * to talk to the server instead: a caller driving the CLI without a keyboard
+ * (an agent, a wrapper script) otherwise has no indication that one exists.
+ *
+ * `/` is suggested rather than an API route because it is the one path every
+ * project serves.
  */
 functionprintRequestHint(): 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`)
+console.log(`\n ${styleText('dim','run')}${styleText('bold','nuxt curl /')}${styleText('dim','to send a request to this server')}\n`)
 }
 
 functionavailableShortcuts(context: ShortcutContext): Shortcut[]{
@@ -127,7 +130,9 @@ function availableShortcuts(context: ShortcutContext): Shortcut[] {
  */
 exportfunctionsetupShortcuts(context: ShortcutContext): void{
 if(!process.stdin.isTTY||isCI||isTest){
-if(!isCI&&!isTest){
+// A hint written into a redirected log is read by nobody and answered by
+// nobody, so it is only offered while stdout is still a terminal.
+if(process.stdout.isTTY&&!isCI&&!isTest){
 context.onReady(()=>printRequestHint())
 }
 return

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

@@ -38,14 +38,18 @@ describe('setupShortcuts', () => {
 vi.clearAllMocks()
 })
 
-functionsetup(context: Partial<ShortcutContext>={},{ isTTY =true, isRaw =false}={}){
+functionsetup(context: Partial<ShortcutContext>={},{ isTTY =true, isRaw =false, stdoutIsTTY =true}={}){
 conststdin=newPassThrough()asunknownastypeofprocess.stdin
 Object.assign(stdin,{ isTTY, isRaw,setRawMode: vi.fn((raw: boolean)=>Object.assign(stdin,{isRaw: raw}))})
 
 constoriginal=process.stdin
 Object.defineProperty(process,'stdin',{value: stdin,configurable: true})
 restores.push(()=>Object.defineProperty(process,'stdin',{value: original,configurable: true}))
 
+constoriginalStdoutIsTTY=process.stdout.isTTY
+Object.defineProperty(process.stdout,'isTTY',{value: stdoutIsTTY,configurable: true})
+restores.push(()=>Object.defineProperty(process.stdout,'isTTY',{value: originalStdoutIsTTY,configurable: true}))
+
 constlog=vi.spyOn(console,'log').mockImplementation(()=>{})
 
 constlistener={
@@ -89,10 +93,16 @@ describe('setupShortcuts', () => {
 expect(setup().stdin.listenerCount('data')).toBe(0)
 })
 
-it('should suggest `nuxt curl` when there is no TTY',()=>{
+it('should suggest `nuxt curl` when stdin cannot be read',()=>{
 const{ log }=setup({},{isTTY: false})
 
-expect(log.mock.calls.join('\n')).toContain('nuxt curl /api/hello')
+expect(log.mock.calls.join('\n')).toContain('nuxt curl /')
+})
+
+it('should stay silent when the output is redirected',()=>{
+const{ log }=setup({},{isTTY: false,stdoutIsTTY: false})
+
+expect(log.mock.calls.join('\n')).not.toContain('nuxt curl')
 })
 
 it('should stay silent in CI',()=>{