@oclif/core 3.0.0-beta.15 → 3.0.0-beta.16

package/lib/cli-ux/action/base.d.ts

@@ -1,12 +1,10 @@
+import { Options } from './types';
 export interface ITask {
     action: string;
     status: string | undefined;
     active: boolean;
 }
 export type ActionType = 'spinner' | 'simple' | 'debug';
-export interface Options {
-    stdout?: boolean;
-}
 export declare class ActionBase {
     type: ActionType;
     std: 'stdout' | 'stderr';
@@ -24,7 +22,7 @@ export declare class ActionBase {
     set status(status: string | undefined);
     pauseAsync<T>(fn: () => Promise<T>, icon?: string): Promise<T>;
     pause(fn: () => any, icon?: string): Promise<any>;
-    protected _start(): void;
+    protected _start(_opts: Options): void;
     protected _stop(_: string): void;
     protected _resume(): void;
     protected _pause(_?: string): void;

package/lib/cli-ux/action/base.js

@@ -16,7 +16,7 @@ class ActionBase {
         this.std = opts.stdout ? 'stdout' : 'stderr';
         const task = { action, status, active: Boolean(this.task && this.task.active) };
         this.task = task;
-        this._start();
+        this._start(opts);
         task.active = true;
         this._stdout(true);
     }
@@ -93,7 +93,7 @@ class ActionBase {
         }
         return ret;
     }
-    _start() {
+    _start(_opts) {
         throw new Error('not implemented');
     }
     _stop(_) {

package/lib/cli-ux/action/simple.js

@@ -7,10 +7,9 @@ class SimpleAction extends base_1.ActionBase {
         this.type = 'simple';
     }
     _start() {
-        const { task } = this;
-        if (!task)
+        if (!this.task)
             return;
-        this._render(task.action, task.status);
+        this._render(this.task.action, this.task.status);
     }
     _pause(icon) {
         if (icon)
@@ -22,29 +21,26 @@ class SimpleAction extends base_1.ActionBase {
         // Not implemented
     }
     _updateStatus(status, prevStatus, newline = false) {
-        const { task, std } = this;
-        if (!task)
+        if (!this.task)
             return;
-        if (task.active && !prevStatus)
-            this._write(std, ` ${status}`);
+        if (this.task.active && !prevStatus)
+            this._write(this.std, ` ${status}`);
         else
-            this._write(std, `${task.action}... ${status}`);
+            this._write(this.std, `${this.task.action}... ${status}`);
         if (newline || !prevStatus)
             this._flush();
     }
     _stop(status) {
-        const { task } = this;
-        if (!task)
+        if (!this.task)
             return;
-        this._updateStatus(status, task.status, true);
+        this._updateStatus(status, this.task.status, true);
     }
     _render(action, status) {
-        const { task, std } = this;
-        if (!task)
+        if (!this.task)
             return;
-        if (task.active)
+        if (this.task.active)
             this._flush();
-        this._write(std, status ? `${action}... ${status}` : `${action}...`);
+        this._write(this.std, status ? `${action}... ${status}` : `${action}...`);
     }
     _flush() {
         this._write(this.std, '\n');

package/lib/cli-ux/action/spinner.d.ts

@@ -1,15 +1,17 @@
 /// <reference types="node" />
 import { ActionBase, ActionType } from './base';
+import { Options } from './types';
 export default class SpinnerAction extends ActionBase {
     type: ActionType;
     spinner?: NodeJS.Timeout;
-    frames: any;
+    frames: string[];
     frameIndex: number;
     constructor();
-    protected _start(): void;
+    protected _start(opts: Options): void;
     protected _stop(status: string): void;
     protected _pause(icon?: string): void;
     protected _frame(): string;
+    private getFrames;
     private _render;
     private _reset;
     private _lines;

package/lib/cli-ux/action/spinner.js

@@ -18,10 +18,12 @@ class SpinnerAction extends base_1.ActionBase {
     constructor() {
         super();
         this.type = 'spinner';
-        this.frames = spinners_1.default[process.platform === 'win32' ? 'line' : 'dots2'].frames;
+        this.frames = this.getFrames();
         this.frameIndex = 0;
     }
-    _start() {
+    _start(opts) {
+        if (opts.style)
+            this.frames = this.getFrames(opts);
         this._reset();
         if (this.spinner)
             clearInterval(this.spinner);
@@ -51,16 +53,20 @@ class SpinnerAction extends base_1.ActionBase {
         this.frameIndex = ++this.frameIndex % this.frames.length;
         return color(frame);
     }
+    getFrames(opts) {
+        if (opts?.style)
+            return spinners_1.default[process.platform === 'win32' ? 'line' : opts.style].frames;
+        return spinners_1.default[process.platform === 'win32' ? 'line' : 'dots2'].frames;
+    }
     _render(icon) {
-        const { task, std, output } = this;
-        if (!task)
+        if (!this.task)
             return;
         this._reset();
         this._flushStdout();
         const frame = icon === 'spinner' ? ` ${this._frame()}` : icon || '';
-        const status = task.status ? ` ${task.status}` : '';
-        this.output = `${task.action}...${frame}${status}\n`;
-        this._write(std, output);
+        const status = this.task.status ? ` ${this.task.status}` : '';
+        this.output = `${this.task.action}...${frame}${status}\n`;
+        this._write(this.std, this.output);
     }
     _reset() {
         if (!this.output)

package/lib/cli-ux/action/types.d.ts

@@ -0,0 +1,5 @@
+import spinners from './spinners';
+export type Options = {
+    stdout?: boolean;
+    style?: keyof typeof spinners;
+};

package/lib/cli-ux/action/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "3.0.0-beta.15",
+  "version": "3.0.0-beta.16",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {