@oclif/multi-stage-output 0.5.4 → 0.5.5

package/lib/components/stages.js

@@ -2,6 +2,7 @@ import { getLogger } from '@oclif/core/logger';
 import { capitalCase } from 'change-case';
 import { Box, Text, useStdout } from 'ink';
 import React from 'react';
+import wrapAnsi from 'wrap-ansi';
 import { constructDesignParams } from '../design.js';
 import { Divider } from './divider.js';
 import { Icon } from './icon.js';
@@ -122,11 +123,9 @@ export function determineCompactionLevel({ design = constructDesignParams(), has
     // 10 characters + 1 character for the space between the stage and timer,
     // examples: 999ms (5), 59.99s (6), 59m 59.99s (10), 23h 59m (7)
     const estimatedTimeLength = 11;
-    const calculateWrappedHeight = (length) => {
-        if (length > columns) {
-            return Math.ceil(length / columns);
-        }
-        return 1;
+    const calculateWrappedHeight = (text) => {
+        const wrapped = wrapAnsi(text, columns, { hard: true, trim: false, wordWrap: true });
+        return wrapped.split('\n').length;
     };
     const calculateHeightOfBlock = (block) => {
         if (!block)
@@ -137,7 +136,7 @@ export function determineCompactionLevel({ design = constructDesignParams(), has
                     return acc;
                 if (info.value.length > columns) {
                     // if the message is longer than the terminal width, add the number of lines
-                    return acc + calculateWrappedHeight(info.value.length);
+                    return acc + calculateWrappedHeight(info.value);
                 }
                 // if the message is multiline, add the number of lines
                 return acc + info.value.split('\n').length;
@@ -149,7 +148,7 @@ export function determineCompactionLevel({ design = constructDesignParams(), has
             const totalLength = `${label}: ${value}`.length;
             if (totalLength > columns) {
                 // if the value is longer than the terminal width, add the number of lines
-                return acc + calculateWrappedHeight(totalLength);
+                return acc + calculateWrappedHeight(`${label}: ${value}`);
             }
             return acc + value.split('\n').length;
         }, 0);
@@ -158,13 +157,15 @@ export function determineCompactionLevel({ design = constructDesignParams(), has
         const status = stageTracker.get(stage) ?? 'pending';
         const skipped = status === 'skipped' ? ' - Skipped' : '';
         const stageTimeLength = hasStageTime ? estimatedTimeLength : 0;
-        const totalLength = design.icons[status].paddingLeft +
-            design.icons[status].figure.length +
-            design.icons[status].paddingRight +
-            stage.length +
-            skipped.length +
-            stageTimeLength;
-        return calculateWrappedHeight(totalLength);
+        const parts = [
+            ' '.repeat(design.icons[status].paddingLeft),
+            design.icons[status].figure,
+            ' '.repeat(design.icons[status].paddingRight),
+            stage,
+            skipped,
+            '0'.repeat(stageTimeLength),
+        ];
+        return calculateWrappedHeight(parts.join(''));
     };
     const calculateWidthOfCompactStage = (stage) => {
         const status = stageTracker.get(stage) ?? 'current';
@@ -193,8 +194,10 @@ export function determineCompactionLevel({ design = constructDesignParams(), has
     const stageSpecificBlockHeight = calculateHeightOfBlock(stageSpecificBlock);
     // 3 at minimum because: 1 for marginTop on entire component, 1 for marginBottom on entire component, 1 for paddingBottom on StageEntries
     const paddings = 3 + (preStagesBlock ? 1 : 0) + (postStagesBlock ? 1 : 0) + (title ? 1 : 0);
-    const elapsedTimeHeight = hasElapsedTime ? calculateWrappedHeight('Elapsed Time:'.length + estimatedTimeLength) : 0;
-    const titleHeight = title ? calculateWrappedHeight(title.length) : 0;
+    const elapsedTimeHeight = hasElapsedTime
+        ? calculateWrappedHeight(`Elapsed Time:${'0'.repeat(estimatedTimeLength)}`)
+        : 0;
+    const titleHeight = title ? calculateWrappedHeight(title) : 0;
     const totalHeight = stagesHeight +
         preStagesBlockHeight +
         postStagesBlockHeight +

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/multi-stage-output",
   "description": "Terminal output for oclif commands with multiple stages",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/multi-stage-output/issues",
   "dependencies": {
@@ -11,7 +11,8 @@
     "cli-spinners": "^2",
     "figures": "^6.1.0",
     "ink": "^5.0.1",
-    "react": "^18.3.1"
+    "react": "^18.3.1",
+    "wrap-ansi": "^9.0.0"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^19",