Merge pull request #832 from oclif/mdonnalley/no-wrapped-process

feat: no longer use wrapped process.stdout and process.stderr

package.json

@@ -72,7 +72,7 @@
     "nyc": "^15.1.0",
     "prettier": "^3.0.3",
     "shx": "^0.3.4",
-    "sinon": "^11.1.2",
+    "sinon": "^16.1.0",
     "ts-node": "^10.9.1",
     "tsd": "^0.29.0",
     "typescript": "^5"

src/cli-ux/action/base.ts

@@ -1,7 +1,6 @@
 import {inspect} from 'node:util'
 
 import {castArray} from '../../util/util'
-import {stderr, stdout} from '../stream'
 import {Options} from './types'
 
 export interface ITask {
@@ -20,8 +19,8 @@ export class ActionBase {
   type!: ActionType
 
   private stdmockOrigs = {
-    stderr: stderr.write,
-    stdout: stdout.write,
+    stderr: process.stderr.write,
+    stdout: process.stdout.write,
   }
 
   protected get output(): string | undefined {
@@ -158,26 +157,26 @@ export class ActionBase {
       if (toggle) {
         if (this.stdmocks) return
         this.stdmockOrigs = {
-          stderr: stderr.write,
-          stdout: stdout.write,
+          stderr: process.stderr.write,
+          stdout: process.stdout.write,
         }
 
         this.stdmocks = []
-        stdout.write = (...args: any[]) => {
+        process.stdout.write = (...args: any[]) => {
           this.stdmocks!.push(['stdout', args] as ['stdout', string[]])
           return true
         }
 
-        stderr.write = (...args: any[]) => {
+        process.stderr.write = (...args: any[]) => {
           this.stdmocks!.push(['stderr', args] as ['stderr', string[]])
           return true
         }
       } else {
         if (!this.stdmocks) return
         // this._write('stderr', '\nresetstdmock\n\n\n')
         delete this.stdmocks
-        stdout.write = this.stdmockOrigs.stdout
-        stderr.write = this.stdmockOrigs.stderr
+        process.stdout.write = this.stdmockOrigs.stdout
+        process.stderr.write = this.stdmockOrigs.stderr
       }
     } catch (error) {
       this._write('stderr', inspect(error))
@@ -196,12 +195,12 @@ export class ActionBase {
   protected _write(std: 'stderr' | 'stdout', s: string | string[]): void {
     switch (std) {
       case 'stdout': {
-        this.stdmockOrigs.stdout.apply(stdout, castArray(s) as [string])
+        this.stdmockOrigs.stdout.apply(process.stdout, castArray(s) as [string])
         break
       }
 
       case 'stderr': {
-        this.stdmockOrigs.stderr.apply(stderr, castArray(s) as [string])
+        this.stdmockOrigs.stderr.apply(process.stderr, castArray(s) as [string])
         break
       }
 

src/cli-ux/flush.ts

@@ -1,5 +1,4 @@
 import {error} from '../errors'
-import {stdout} from './stream'
 
 function timeout(p: Promise<any>, ms: number) {
   function wait(ms: number, unref = false) {
@@ -14,9 +13,9 @@ function timeout(p: Promise<any>, ms: number) {
 
 async function _flush() {
   const p = new Promise((resolve) => {
-    stdout.once('drain', () => resolve(null))
+    process.stdout.once('drain', () => resolve(null))
   })
-  const flushed = stdout.write('')
+  const flushed = process.stdout.write('')
 
   if (flushed) return
 

src/cli-ux/index.ts

@@ -3,17 +3,17 @@ import {format as utilFormat} from 'node:util'
 
 import * as Errors from '../errors'
 import {ActionBase} from './action/base'
-import {Config, config} from './config'
+import {config} from './config'
 import {flush as _flush} from './flush'
 import * as uxPrompt from './prompt'
-import {stdout} from './stream'
 import * as styled from './styled'
 import uxWait from './wait'
+import write from './write'
 
 const hyperlinker = require('hyperlinker')
 
 export class ux {
-  public static config: Config = config
+  public static config = config
 
   public static get action(): ActionBase {
     return config.action
@@ -42,7 +42,7 @@ export class ux {
 
   public static debug(format: string, ...args: string[]): void {
     if (['debug', 'trace'].includes(this.config.outputLevel)) {
-      stdout.write(utilFormat(format, ...args) + '\n')
+      this.info(utilFormat(format, ...args) + '\n')
     }
   }
 
@@ -55,13 +55,17 @@ export class ux {
   }
 
   public static info(format: string, ...args: string[]): void {
-    stdout.write(utilFormat(format, ...args) + '\n')
+    write.stdout(utilFormat(format, ...args) + '\n')
   }
 
   public static log(format?: string, ...args: string[]): void {
     this.info(format || '', ...args)
   }
 
+  public static logToStderr(format?: string, ...args: string[]): void {
+    write.stderr(utilFormat(format, ...args) + '\n')
+  }
+
   public static get progress(): typeof styled.progress {
     return styled.progress
   }
@@ -77,7 +81,7 @@ export class ux {
   public static styledJSON(obj: unknown): void {
     const json = JSON.stringify(obj, null, 2)
     if (!chalk.level) {
-      info(json)
+      this.info(json)
       return
     }
 
@@ -96,7 +100,7 @@ export class ux {
 
   public static trace(format: string, ...args: string[]): void {
     if (this.config.outputLevel === 'trace') {
-      stdout.write(utilFormat(format, ...args) + '\n')
+      this.info(utilFormat(format, ...args) + '\n')
     }
   }
 
@@ -128,6 +132,7 @@ const {
   flush,
   info,
   log,
+  logToStderr,
   progress,
   prompt,
   styledHeader,
@@ -153,6 +158,7 @@ export {
   flush,
   info,
   log,
+  logToStderr,
   progress,
   prompt,
   styledHeader,
@@ -186,4 +192,6 @@ export {ActionBase} from './action/base'
 export {Config, config} from './config'
 export {ExitError} from './exit'
 export {IPromptOptions} from './prompt'
+export {makeStubs} from './stub'
+
 export {Table} from './styled'

src/cli-ux/prompt.ts

@@ -2,7 +2,6 @@ import chalk from 'chalk'
 
 import * as Errors from '../errors'
 import {config} from './config'
-import {stderr} from './stream'
 
 export interface IPromptOptions {
   default?: string
@@ -38,7 +37,7 @@ function normal(options: IPromptConfig, retries = 100): Promise<string> {
     }
 
     process.stdin.setEncoding('utf8')
-    stderr.write(options.prompt)
+    process.stderr.write(options.prompt)
     process.stdin.resume()
     process.stdin.once('data', (b) => {
       if (timer) clearTimeout(timer)
@@ -77,7 +76,7 @@ async function single(options: IPromptConfig): Promise<string> {
 
 function replacePrompt(prompt: string) {
   const ansiEscapes = require('ansi-escapes')
-  stderr.write(
+  process.stderr.write(
     ansiEscapes.cursorHide +
       ansiEscapes.cursorUp(1) +
       ansiEscapes.cursorLeft +
@@ -178,7 +177,7 @@ export async function anykey(message?: string): Promise<string> {
   }
 
   const char = await prompt(message, {required: false, type: 'single'})
-  if (tty) stderr.write('\n')
+  if (tty) process.stderr.write('\n')
   if (char === 'q') Errors.error('quit')
   if (char === '\u0003') Errors.error('ctrl-c')
   return char

src/cli-ux/stream.ts

@@ -35,5 +35,11 @@ class Stream {
   }
 }
 
+/**
+ * @deprecated Use process.stdout directly. This will be removed in the next major version
+ */
 export const stdout = new Stream('stdout')
+/**
+ * @deprecated Use process.stderr directly. This will be removed in the next major version
+ */
 export const stderr = new Stream('stderr')

src/cli-ux/stub.ts

@@ -0,0 +1,40 @@
+import type {SinonSandbox, SinonStub} from 'sinon'
+
+import write from './write'
+
+type Stubs = {
+  stderr: SinonStub
+  stdout: SinonStub
+}
+
+/**
+ * Create sinon stubs for writing to stdout and stderr.
+ *
+ * @example
+ * import {ux} from '@oclif/core'
+ *
+ * describe('example', () => {
+ *   let sandbox: SinonSandbox
+ *   let stubs: ReturnType<typeof ux.makeStubs>
+ *
+ *   beforeEach(() => {
+ *     sandbox = createSandbox()
+ *     stubs = ux.makeStubs(sandbox)
+ *   })
+ *
+ *   afterEach(() => {
+ *     sandbox.restore()
+ *   })
+ *
+ *   it('should log text to the console', () => {
+ *     ux.log('Hello, world!')
+ *     expect(stubs.stdout.firstCall.firstArg).to.equal('Hello, world!\n')
+ *   })
+ * })
+ */
+export function makeStubs(sandbox: SinonSandbox): Stubs {
+  return {
+    stderr: sandbox.stub(write, 'stderr'),
+    stdout: sandbox.stub(write, 'stdout'),
+  }
+}

src/cli-ux/styled/table.ts

@@ -9,7 +9,7 @@ import * as F from '../../flags'
 import * as Interfaces from '../../interfaces'
 import {stdtermwidth} from '../../screen'
 import {capitalize, sumBy} from '../../util/util'
-import {stdout} from '../stream'
+import write from '../write'
 
 class Table<T extends Record<string, unknown>> {
   columns: (table.Column<T> & {key: string; maxWidth?: number; width?: number})[]
@@ -48,7 +48,7 @@ class Table<T extends Record<string, unknown>> {
       'no-header': options['no-header'] ?? false,
       'no-truncate': options['no-truncate'] ?? false,
       output: csv ? 'csv' : output,
-      printLine: printLine ?? ((s: any) => stdout.write(s + '\n')),
+      printLine: printLine ?? ((s: any) => write.stdout(s + '\n')),
       rowStart: ' ',
       sort,
       title,
@@ -97,7 +97,7 @@ class Table<T extends Record<string, unknown>> {
       const filters = this.options.columns!.split(',')
       this.columns = this.filterColumnsFromHeaders(filters)
     } else if (!this.options.extended) {
-      // show extented columns/properties
+      // show extended columns/properties
       this.columns = this.columns.filter((c) => !c.extended)
     }
 
@@ -189,7 +189,7 @@ class Table<T extends Record<string, unknown>> {
     // truncation logic
     const shouldShorten = () => {
       // don't shorten if full mode
-      if (options['no-truncate'] || (!stdout.isTTY && !process.env.CLI_UX_SKIP_TTY_CHECK)) return
+      if (options['no-truncate'] || (!process.stdout.isTTY && !process.env.CLI_UX_SKIP_TTY_CHECK)) return
 
       // don't shorten if there is enough screen width
       const dataMaxWidth = sumBy(columns, (c) => c.width!)

src/cli-ux/write.ts

@@ -0,0 +1,12 @@
+const stdout = (msg: string): void => {
+  process.stdout.write(msg)
+}
+
+const stderr = (msg: string): void => {
+  process.stderr.write(msg)
+}
+
+export default {
+  stderr,
+  stdout,
+}

src/command.ts

@@ -1,9 +1,8 @@
 import chalk from 'chalk'
 import {fileURLToPath} from 'node:url'
-import {format, inspect} from 'node:util'
+import {inspect} from 'node:util'
 
 import {ux} from './cli-ux'
-import {stderr, stdout} from './cli-ux/stream'
 import {Config} from './config'
 import * as Errors from './errors'
 import {PrettyPrintableError} from './errors'
@@ -37,7 +36,7 @@ const pjson = requireJson<PJSON>(__dirname, '..', 'package.json')
  * swallows stdout epipe errors
  * this occurs when stdout closes such as when piping to head
  */
-stdout.on('error', (err: any) => {
+process.stdout.on('error', (err: any) => {
   if (err && err.code === 'EPIPE') return
   throw err
 })
@@ -258,7 +257,7 @@ export abstract class Command {
   public log(message = '', ...args: any[]): void {
     if (!this.jsonEnabled()) {
       message = typeof message === 'string' ? message : inspect(message)
-      stdout.write(format(message, ...args) + '\n')
+      ux.info(message, ...args)
     }
   }
 
@@ -269,7 +268,7 @@ export abstract class Command {
   public logToStderr(message = '', ...args: any[]): void {
     if (!this.jsonEnabled()) {
       message = typeof message === 'string' ? message : inspect(message)
-      stderr.write(format(message, ...args) + '\n')
+      ux.logToStderr(message, ...args)
     }
   }
 

src/config/config.ts

@@ -3,9 +3,8 @@ import WSL from 'is-wsl'
 import {arch, userInfo as osUserInfo, release, tmpdir, type} from 'node:os'
 import {join, sep} from 'node:path'
 import {URL, fileURLToPath} from 'node:url'
-import {format} from 'node:util'
 
-import {stdout} from '../cli-ux/stream'
+import {ux} from '../cli-ux'
 import {Command} from '../command'
 import {CLIError, error, exit, warn} from '../errors'
 import {getHelpFlagAdditions} from '../help/util'
@@ -499,7 +498,7 @@ export class Config implements IConfig {
           exit(code)
         },
         log(message?: any, ...args: any[]) {
-          stdout.write(format(message, ...args) + '\n')
+          ux.info(message, ...args)
         },
         warn(message: string) {
           warn(message)

src/config/ts-node.ts

@@ -1,11 +1,10 @@
-import {existsSync} from 'node:fs'
 import {join, relative as pathRelative, sep} from 'node:path'
 import * as TSNode from 'ts-node'
 
 import {memoizedWarn} from '../errors'
 import {Plugin, TSConfig} from '../interfaces'
 import {settings} from '../settings'
-import {readJsonSync} from '../util/fs'
+import {existsSync, readJsonSync} from '../util/fs'
 import {isProd} from '../util/util'
 import Cache from './cache'
 import {Debug} from './util'