feat: merge cli-ux library with oclif/core

.gitignore

@@ -8,3 +8,4 @@
 /node_modules
 /tmp
 /test/tmp
+.DS_Store

package.json

@@ -6,19 +6,31 @@
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
     "@oclif/linewrap": "^1.0.0",
+    "@oclif/screen": "^3.0.2",
+    "ansi-escapes": "^4.3.0",
+    "ansi-styles": "^4.2.0",
+    "cardinal": "^2.1.1",
     "chalk": "^4.1.2",
     "clean-stack": "^3.0.1",
-    "cli-ux": "^6.0.6",
+    "cli-progress": "^3.10.0",
     "debug": "^4.3.3",
     "ejs": "^3.1.6",
     "fs-extra": "^9.1.0",
     "get-package-type": "^0.1.0",
     "globby": "^11.0.4",
+    "hyperlinker": "^1.0.0",
     "indent-string": "^4.0.0",
     "is-wsl": "^2.2.0",
+    "js-yaml": "^3.13.1",
+    "lodash": "^4.17.21",
+    "natural-orderby": "^2.0.3",
+    "object-treeify": "^1.1.4",
+    "password-prompt": "^1.1.2",
     "semver": "^7.3.5",
     "string-width": "^4.2.3",
     "strip-ansi": "^6.0.1",
+    "supports-color": "^8.1.1",
+    "supports-hyperlinks": "^2.2.0",
     "tslib": "^2.3.1",
     "widest-line": "^3.1.0",
     "wrap-ansi": "^7.0.0"
@@ -28,12 +40,16 @@
     "@oclif/plugin-help": "^5.1.7",
     "@oclif/plugin-plugins": "^2.0.8",
     "@oclif/test": "^1.2.8",
+    "@types/ansi-styles": "^3.2.1",
     "@types/chai": "^4.2.22",
     "@types/chai-as-promised": "^7.1.4",
     "@types/clean-stack": "^2.1.1",
+    "@types/cli-progress": "^3.9.2",
     "@types/ejs": "^3.1.0",
     "@types/fs-extra": "^9.0.13",
     "@types/indent-string": "^4.0.1",
+    "@types/js-yaml": "^3.12.1",
+    "@types/lodash": "^4.14.117",
     "@types/mocha": "^8.2.3",
     "@types/nock": "^11.1.0",
     "@types/node": "^15.14.9",
@@ -42,6 +58,7 @@
     "@types/semver": "^7.3.9",
     "@types/shelljs": "^0.8.10",
     "@types/strip-ansi": "^5.2.1",
+    "@types/supports-color": "^8.1.1",
     "@types/wrap-ansi": "^3.0.0",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
@@ -59,7 +76,7 @@
     "shx": "^0.3.3",
     "sinon": "^11.1.2",
     "ts-node": "^9.1.1",
-    "typescript": "4.5.2"
+    "typescript": "4.4.4"
   },
   "resolutions": {
     "@oclif/command": "1.8.9",

src/cli-ux/action/base.ts

@@ -0,0 +1,201 @@
+import castArray from 'lodash/castArray'
+import {inspect} from 'util'
+
+export interface ITask {
+  action: string;
+  status: string | undefined;
+  active: boolean;
+}
+
+export type ActionType = 'spinner' | 'simple' | 'debug'
+
+export interface Options {
+  stdout?: boolean;
+}
+
+export class ActionBase {
+  type!: ActionType
+
+  std: 'stdout' | 'stderr' = 'stderr'
+
+  protected stdmocks?: ['stdout' | 'stderr', string[]][]
+
+  private stdmockOrigs = {
+    stdout: process.stdout.write,
+    stderr: process.stderr.write,
+  }
+
+  public start(action: string, status?: string, opts: Options = {}) {
+    this.std = opts.stdout ? 'stdout' : 'stderr'
+    const task = {action, status, active: Boolean(this.task && this.task.active)}
+    this.task = task
+
+    this._start()
+    task.active = true
+    this._stdout(true)
+  }
+
+  public stop(msg = 'done') {
+    const task = this.task
+    if (!task) {
+      return
+    }
+
+    this._stop(msg)
+    task.active = false
+    this.task = undefined
+    this._stdout(false)
+  }
+
+  private get globals(): { action: { task?: ITask }; output: string | undefined } {
+    (global as any)['cli-ux'] = (global as any)['cli-ux'] || {}
+    const globals = (global as any)['cli-ux']
+    globals.action = globals.action || {}
+    return globals
+  }
+
+  public get task(): ITask | undefined {
+    return this.globals.action.task
+  }
+
+  public set task(task: ITask | undefined) {
+    this.globals.action.task = task
+  }
+
+  protected get output(): string | undefined {
+    return this.globals.output
+  }
+
+  protected set output(output: string | undefined) {
+    this.globals.output = output
+  }
+
+  get running(): boolean {
+    return Boolean(this.task)
+  }
+
+  get status(): string | undefined {
+    return this.task ? this.task.status : undefined
+  }
+
+  set status(status: string | undefined) {
+    const task = this.task
+    if (!task) {
+      return
+    }
+
+    if (task.status === status) {
+      return
+    }
+
+    this._updateStatus(status, task.status)
+    task.status = status
+  }
+
+  public async pauseAsync(fn: () => Promise<any>, icon?: string) {
+    const task = this.task
+    const active = task && task.active
+    if (task && active) {
+      this._pause(icon)
+      this._stdout(false)
+      task.active = false
+    }
+
+    const ret = await fn()
+    if (task && active) {
+      this._resume()
+    }
+
+    return ret
+  }
+
+  public pause(fn: () => any, icon?: string) {
+    const task = this.task
+    const active = task && task.active
+    if (task && active) {
+      this._pause(icon)
+      this._stdout(false)
+      task.active = false
+    }
+
+    const ret = fn()
+    if (task && active) {
+      this._resume()
+    }
+
+    return ret
+  }
+
+  protected _start() {
+    throw new Error('not implemented')
+  }
+
+  protected _stop(_: string) {
+    throw new Error('not implemented')
+  }
+
+  protected _resume() {
+    if (this.task) this.start(this.task.action, this.task.status)
+  }
+
+  protected _pause(_?: string) {
+    throw new Error('not implemented')
+  }
+
+  protected _updateStatus(_: string | undefined, __?: string) {}
+
+  // mock out stdout/stderr so it doesn't screw up the rendering
+  protected _stdout(toggle: boolean) {
+    try {
+      const outputs: ['stdout', 'stderr'] = ['stdout', 'stderr']
+      if (toggle) {
+        if (this.stdmocks) return
+        this.stdmockOrigs = {
+          stdout: process.stdout.write,
+          stderr: process.stderr.write,
+        }
+
+        this.stdmocks = []
+        for (const std of outputs) {
+          (process[std] as any).write = (...args: any[]) => {
+            this.stdmocks!.push([std, args] as ['stdout' | 'stderr', string[]])
+          }
+        }
+      } else {
+        if (!this.stdmocks) return
+        // this._write('stderr', '\nresetstdmock\n\n\n')
+        delete this.stdmocks
+        for (const std of outputs) process[std].write = this.stdmockOrigs[std] as any
+      }
+    } catch (error) {
+      this._write('stderr', inspect(error))
+    }
+  }
+
+  // flush mocked stdout/stderr
+  protected _flushStdout() {
+    try {
+      let output = ''
+      let std: 'stdout' | 'stderr' | undefined
+      while (this.stdmocks && this.stdmocks.length > 0) {
+        const cur = this.stdmocks.shift() as ['stdout' | 'stderr', string[]]
+        std = cur[0]
+        this._write(std, cur[1])
+        output += (cur[1][0] as any).toString('utf8')
+      }
+      // add newline if there isn't one already
+      // otherwise we'll just overwrite it when we render
+
+      if (output && std && output[output.length - 1] !== '\n') {
+        this._write(std, '\n')
+      }
+    } catch (error) {
+      this._write('stderr', inspect(error))
+    }
+  }
+
+  // write to the real stdout/stderr
+  protected _write(std: 'stdout' | 'stderr', s: string | string[]) {
+    this.stdmockOrigs[std].apply(process[std], castArray(s) as [string])
+  }
+}

src/cli-ux/action/pride-spinner.ts

@@ -0,0 +1,32 @@
+// tslint:disable restrict-plus-operands
+
+import * as chalk from 'chalk'
+import * as supportsColor from 'supports-color'
+
+import SpinnerAction from './spinner'
+
+function color(s: string, frameIndex: number): string {
+  const prideColors = [
+    chalk.keyword('pink'),
+    chalk.red,
+    chalk.keyword('orange'),
+    chalk.yellow,
+    chalk.green,
+    chalk.cyan,
+    chalk.blue,
+    chalk.magenta,
+  ]
+
+  if (!supportsColor) return s
+  const has256 = supportsColor.stdout ? supportsColor.stdout.has256 : (process.env.TERM || '').includes('256')
+  const prideColor = prideColors[frameIndex] || prideColors[0]
+  return has256 ? prideColor(s) : chalk.magenta(s)
+}
+
+export default class PrideSpinnerAction extends SpinnerAction {
+  protected _frame(): string {
+    const frame = this.frames[this.frameIndex]
+    this.frameIndex = ++this.frameIndex % this.frames.length
+    return color(frame, this.frameIndex)
+  }
+}

src/cli-ux/action/simple.ts

@@ -0,0 +1,44 @@
+import {ActionBase, ActionType} from './base'
+
+export default class SimpleAction extends ActionBase {
+  public type: ActionType = 'simple'
+
+  protected _start() {
+    const task = this.task
+    if (!task) return
+    this._render(task.action, task.status)
+  }
+
+  protected _pause(icon?: string) {
+    if (icon) this._updateStatus(icon)
+    else this._flush()
+  }
+
+  protected _resume() {}
+
+  protected _updateStatus(status: string, prevStatus?: string, newline = false) {
+    const task = this.task
+    if (!task) return
+    if (task.active && !prevStatus) this._write(this.std, ` ${status}`)
+    else this._write(this.std, `${task.action}... ${status}`)
+    if (newline || !prevStatus) this._flush()
+  }
+
+  protected _stop(status: string) {
+    const task = this.task
+    if (!task) return
+    this._updateStatus(status, task.status, true)
+  }
+
+  private _render(action: string, status?: string) {
+    const task = this.task
+    if (!task) return
+    if (task.active) this._flush()
+    this._write(this.std, status ? `${action}... ${status}` : `${action}...`)
+  }
+
+  private _flush() {
+    this._write(this.std, '\n')
+    this._flushStdout()
+  }
+}