@oclif/multi-stage-output 0.2.2 → 0.3.1

package/lib/components/divider.js

@@ -3,7 +3,7 @@ import React from 'react';
 const getSideDividerWidth = (width, titleWidth) => (width - titleWidth) / 2;
 const getNumberOfCharsPerWidth = (char, width) => width / char.length;
 const PAD = ' ';
-export function Divider({ dividerChar = '─', dividerColor = 'dim', padding = 1, textColor = 'white', textPadding: titlePadding = 1, title = '', width = 50, }) {
+export function Divider({ dividerChar = '─', dividerColor = 'dim', padding = 1, textColor, textPadding: titlePadding = 1, title = '', width = 50, }) {
     const titleString = title ? `${PAD.repeat(titlePadding) + title + PAD.repeat(titlePadding)}` : '';
     const titleWidth = titleString.length;
     const terminalWidth = process.stdout.columns ?? 80;

package/lib/design.d.ts

@@ -43,7 +43,7 @@ export type Design = {
          */
         padding?: number;
         /**
-         * Color of the title. Defaults to 'white'
+         * Color of the title
          */
         textColor?: string;
         /**

package/lib/design.js

@@ -54,7 +54,7 @@ export function constructDesignParams(design) {
             dividerChar: '─',
             dividerColor: 'dim',
             padding: 1,
-            textColor: 'white',
+            textColor: 'reset',
             textPadding: 1,
             width: 50,
             ...design?.title,

package/lib/multi-stage-output.d.ts

@@ -45,6 +45,10 @@ export type MultiStageOutputOptions<T extends Record<string, unknown>> = {
      * Design options to customize the output.
      */
     readonly design?: Design;
+    /**
+     * Set to true when --json flag is passed to the command. This will prevent any output to the console. Defaults to false
+     */
+    readonly jsonEnabled: boolean;
 };
 export declare class MultiStageOutput<T extends Record<string, unknown>> implements Disposable {
     private ciInstance;
@@ -61,7 +65,7 @@ export declare class MultiStageOutput<T extends Record<string, unknown>> impleme
     private stopped;
     private readonly timerUnit?;
     private readonly title?;
-    constructor({ data, design, postStagesBlock, preStagesBlock, showElapsedTime, showStageTime, stageSpecificBlock, stages, timerUnit, title, }: MultiStageOutputOptions<T>);
+    constructor({ data, design, jsonEnabled, postStagesBlock, preStagesBlock, showElapsedTime, showStageTime, stageSpecificBlock, stages, timerUnit, title, }: MultiStageOutputOptions<T>);
     goto(stage: string, data?: Partial<T>): void;
     next(data?: Partial<T>): void;
     stop(error?: Error): void;

package/lib/multi-stage-output.js

@@ -144,7 +144,7 @@ export class MultiStageOutput {
     stopped = false;
     timerUnit;
     title;
-    constructor({ data, design, postStagesBlock, preStagesBlock, showElapsedTime, showStageTime, stageSpecificBlock, stages, timerUnit, title, }) {
+    constructor({ data, design, jsonEnabled = false, postStagesBlock, preStagesBlock, showElapsedTime, showStageTime, stageSpecificBlock, stages, timerUnit, title, }) {
         this.data = data;
         this.design = constructDesignParams(design);
         this.stages = stages;
@@ -156,10 +156,13 @@ export class MultiStageOutput {
         this.timerUnit = timerUnit ?? 'ms';
         this.stageTracker = new StageTracker(stages);
         this.stageSpecificBlock = stageSpecificBlock;
+        if (jsonEnabled)
+            return;
         if (isInCi) {
             this.ciInstance = new CIMultiStageOutput({
                 data,
                 design,
+                jsonEnabled,
                 postStagesBlock,
                 preStagesBlock,
                 showElapsedTime,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/multi-stage-output",
   "description": "Terminal output for oclif commands with multiple stages",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/multi-stage-output/issues",
   "dependencies": {
@@ -33,7 +33,7 @@
     "husky": "^9.1.3",
     "ink-testing-library": "^4.0.0",
     "lint-staged": "^15",
-    "mocha": "^10.7.0",
+    "mocha": "^10.7.3",
     "prettier": "^3.3.3",
     "shx": "^0.3.4",
     "sinon": "^18",