@oclif/multi-stage-output 0.4.3-dev.1 → 0.5.0

package/README.md

@@ -23,7 +23,7 @@ You can see examples of how to use it in the [examples](./examples/) directory.
 You can run any of these with the following:
 
 ```
-node --loader=ts-node/esm examples/basic.ts
+tsx examples/basic.ts
 ```
 
 # Usage
@@ -63,7 +63,7 @@ const ms = new MultiStageOutput<{message: string; staticValue: string; dynamicVa
   jsonEnabled: false,
   stages: ['stage 1', 'stage 2', 'stage 3'],
   // preStagesBlock will be displayed BEFORE the list of stages
-  postStagesBlock: [
+  preStagesBlock: [
     {
       get: (data) => data?.message,
       type: 'message',

package/lib/design.d.ts

@@ -40,6 +40,10 @@ export type Design = {
          * Icon to display for an async stage. Defaults to magenta '▶'
          */
         async?: IconProps;
+        /**
+         * Icon to display for a warning. Defaults to yellow '⚠'
+         */
+        warning?: IconProps;
     };
     title?: {
         /**

package/lib/design.js

@@ -65,6 +65,13 @@ export function constructDesignParams(design) {
                 paddingRight: 1,
                 ...design?.icons?.skipped,
             },
+            warning: {
+                color: 'yellow',
+                figure: figures.warning,
+                paddingLeft: 0,
+                paddingRight: 0,
+                ...design?.icons?.warning,
+            },
         },
         spinners: {
             info: process.platform === 'win32' ? 'line' : 'arc',

package/lib/stage-tracker.d.ts

@@ -1,4 +1,4 @@
-export type StageStatus = 'aborted' | 'async' | 'completed' | 'current' | 'failed' | 'paused' | 'pending' | 'skipped';
+export type StageStatus = 'aborted' | 'async' | 'completed' | 'current' | 'failed' | 'paused' | 'pending' | 'skipped' | 'warning';
 export declare class StageTracker {
     private stages;
     current: string | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/multi-stage-output",
   "description": "Terminal output for oclif commands with multiple stages",
-  "version": "0.4.3-dev.1",
+  "version": "0.5.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/multi-stage-output/issues",
   "dependencies": {