Use shared stderr prompt defaults and retain concurrent JSON output

Author: isaacroldan

.changeset/cli-kit-json-ui-routing.md

@@ -2,4 +2,4 @@
 '@shopify/cli-kit': patch
 ---
 
-Keep interactive prompts and concurrent process output on stderr in JSON mode.
+Send finite concurrent process output as JSON diagnostic and progress events on stderr.

packages/cli-kit/src/private/node/ui.tsx

@@ -1,5 +1,4 @@
 import {output} from './output.js'
-import {getUIOutputStream} from './ui/output-stream.js'
 import {Logger, LogLevel} from '../../public/node/output.js'
 import {isUnitTest} from '../../public/node/context/local.js'
 import {treeKill} from '../../public/node/tree-kill.js'
@@ -69,7 +68,6 @@ export async function render(element: JSX.Element, options?: RenderOptions) {
   const {waitUntilExit} = inkRender(<InkLifecycleRoot>{element}</InkLifecycleRoot>, {
     patchConsole: !isUnitTest(),
     ...options,
-    stdout: getUIOutputStream(options?.stdout),
   })
   await waitUntilExit()
 }

packages/cli-kit/src/private/node/ui/output-stream.ts

@@ -8,7 +8,6 @@ import {platformAndArch} from './os.js'
 import {shouldDisplayColors, outputDebug} from './output.js'
 import {isCloudEnvironment} from './context/local.js'
 import {isInputDisabled} from './no-input.js'
-import {getUIOutputStream} from '../../private/node/ui/output-stream.js'
 import {execa, ExecaChildProcess} from 'execa'
 import supportsHyperlinks from 'supports-hyperlinks'
 import which from 'which'
@@ -342,16 +341,12 @@ export function terminalSupportsHyperlinks(): boolean {
   return supportsHyperlinks.stdout
 }
 
-interface TerminalPromptingOptions {
-  stdout?: NodeJS.WriteStream
-}
-
 /**
  * Check if standard input and standard error are terminals that support prompting.
  *
  * @returns True if standard input and standard error support prompting.
  */
-export function terminalSupportsPrompting(options: TerminalPromptingOptions = {}): boolean {
+export function terminalSupportsPrompting(): boolean {
   if (isInputDisabled() || isTruthy(process.env.CI)) {
     return false
   }

packages/cli-kit/src/public/node/system.ts

@@ -294,7 +294,7 @@ export async function renderSelectPrompt<T>(
   {renderOptions, isConfirmationPrompt, ...props}: RenderSelectPromptOptions<T>,
   uiDebugOptions: UIDebugOptions = defaultUIDebugOptions,
 ): Promise<T> {
-  throwInNonTTY({message: props.message, stdin: renderOptions?.stdin, stdout: renderOptions?.stdout}, uiDebugOptions)
+  throwInNonTTY({message: props.message, stdin: renderOptions?.stdin}, uiDebugOptions)
 
   return runWithTimer('cmd_all_timing_prompts_ms')(async () => {
     let selectedValue: T
@@ -429,7 +429,7 @@ export async function renderAutocompletePrompt<T>(
   {renderOptions, ...props}: RenderAutocompleteOptions<T>,
   uiDebugOptions: UIDebugOptions = defaultUIDebugOptions,
 ): Promise<T> {
-  throwInNonTTY({message: props.message, stdin: renderOptions?.stdin, stdout: renderOptions?.stdout}, uiDebugOptions)
+  throwInNonTTY({message: props.message, stdin: renderOptions?.stdin}, uiDebugOptions)
 
   // The default search filters in-memory choices synchronously, so it doesn't need
   // throttling. Skipping the throttle makes the keystroke-to-result latency feel
@@ -666,7 +666,7 @@ export async function renderTextPrompt(
   {renderOptions, ...props}: RenderTextPromptOptions,
   uiDebugOptions: UIDebugOptions = defaultUIDebugOptions,
 ): Promise<string> {
-  throwInNonTTY({message: props.message, stdin: renderOptions?.stdin, stdout: renderOptions?.stdout}, uiDebugOptions)
+  throwInNonTTY({message: props.message, stdin: renderOptions?.stdin}, uiDebugOptions)
 
   return runWithTimer('cmd_all_timing_prompts_ms')(async () => {
     let enteredText = ''
@@ -719,7 +719,7 @@ export async function renderDangerousConfirmationPrompt(
   {renderOptions, ...props}: RenderDangerousConfirmationPromptOptions,
   uiDebugOptions: UIDebugOptions = defaultUIDebugOptions,
 ): Promise<boolean> {
-  throwInNonTTY({message: props.message, stdin: renderOptions?.stdin, stdout: renderOptions?.stdout}, uiDebugOptions)
+  throwInNonTTY({message: props.message, stdin: renderOptions?.stdin}, uiDebugOptions)
 
   return runWithTimer('cmd_all_timing_prompts_ms')(async () => {
     let confirmed: boolean
@@ -772,23 +772,21 @@ export const keypress = async (stdin = process.stdin, uiDebugOptions: UIDebugOpt
 
 interface IsTTYOptions {
   stdin?: NodeJS.ReadStream
-  stdout?: NodeJS.WriteStream
   uiDebugOptions?: UIDebugOptions
 }
 
-export function isTTY({stdin = undefined, stdout, uiDebugOptions = defaultUIDebugOptions}: IsTTYOptions = {}) {
+export function isTTY({stdin = undefined, uiDebugOptions = defaultUIDebugOptions}: IsTTYOptions = {}) {
   // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- false should fall through to stdin/terminalSupportsPrompting
-  return Boolean(uiDebugOptions.skipTTYCheck || stdin || terminalSupportsPrompting({stdout}))
+  return Boolean(uiDebugOptions.skipTTYCheck || stdin || terminalSupportsPrompting())
 }
 
 interface ThrowInNonTTYOptions {
   message: TokenItem
   stdin?: NodeJS.ReadStream
-  stdout?: NodeJS.WriteStream
 }
 
-function throwInNonTTY({message, stdin = undefined, stdout}: ThrowInNonTTYOptions, uiDebugOptions: UIDebugOptions) {
-  if (isTTY({stdin, stdout, uiDebugOptions})) return
+function throwInNonTTY({message, stdin = undefined}: ThrowInNonTTYOptions, uiDebugOptions: UIDebugOptions) {
+  if (isTTY({stdin, uiDebugOptions})) return
 
   const promptText = tokenItemToString(message)
   const errorMessage = `Failed to prompt: