@oclif/multi-stage-output 0.5.2 → 0.5.4-qa.0

package/lib/components/stages.js

@@ -1,3 +1,4 @@
+import { getLogger } from '@oclif/core/logger';
 import { capitalCase } from 'change-case';
 import { Box, Text, useStdout } from 'ink';
 import React from 'react';
@@ -237,6 +238,28 @@ export function determineCompactionLevel({ design = constructDesignParams(), has
         totalHeight,
     };
 }
+class ErrorBoundary extends React.Component {
+    state = {
+        hasError: false,
+    };
+    static getDerivedStateFromError() {
+        // Update state so the next render will show the fallback UI.
+        return { hasError: true };
+    }
+    componentDidCatch(error, info) {
+        getLogger('multi-stage-output').debug(error);
+        getLogger('multi-stage-output').debug(info);
+    }
+    render() {
+        if (this.state.hasError) {
+            if (this.props.getFallbackText) {
+                return React.createElement(Text, null, this.props.getFallbackText());
+            }
+            return false;
+        }
+        return this.props.children;
+    }
+}
 export function Stages({ compactionLevel, design = constructDesignParams(), error, hasElapsedTime = true, hasStageTime = true, postStagesBlock, preStagesBlock, stageSpecificBlock, stageTracker, timerUnit = 'ms', title, }) {
     const { stdout } = useStdout();
     const [levelOfCompaction, setLevelOfCompaction] = React.useState(determineCompactionLevel({
@@ -297,14 +320,19 @@ export function Stages({ compactionLevel, design = constructDesignParams(), erro
     const padding = actualLevelOfCompaction >= 8 ? 0 : 1;
     return (React.createElement(Box, { flexDirection: "column", marginTop: padding, marginBottom: padding },
         actualLevelOfCompaction < 3 && title && (React.createElement(Box, { paddingBottom: padding },
-            React.createElement(Divider, { title: title, ...design.title, terminalWidth: stdout.columns }))),
+            React.createElement(ErrorBoundary, { getFallbackText: () => title },
+                React.createElement(Divider, { title: title, ...design.title, terminalWidth: stdout.columns })))),
         preStages && preStages.length > 0 && (React.createElement(Box, { flexDirection: "column", marginLeft: 1, paddingBottom: padding },
-            React.createElement(Infos, { design: design, error: error, keyValuePairs: preStages }))),
+            React.createElement(ErrorBoundary, { getFallbackText: () => preStages.map((s) => (s.label ? `${s.label}: ${s.value}` : s.value)).join('\n') },
+                React.createElement(Infos, { design: design, error: error, keyValuePairs: preStages })))),
         React.createElement(Box, { flexDirection: "column", marginLeft: 1, paddingBottom: padding },
-            React.createElement(StageEntries, { compactionLevel: actualLevelOfCompaction, design: design, error: error, hasStageTime: hasStageTime, stageSpecificBlock: stageSpecific, stageTracker: stageTracker, timerUnit: timerUnit })),
+            React.createElement(ErrorBoundary, { getFallbackText: () => stageTracker.current ?? 'unknown' },
+                React.createElement(StageEntries, { compactionLevel: actualLevelOfCompaction, design: design, error: error, hasStageTime: hasStageTime, stageSpecificBlock: stageSpecific, stageTracker: stageTracker, timerUnit: timerUnit }))),
         postStages && postStages.length > 0 && (React.createElement(Box, { flexDirection: "column", marginLeft: 1 },
-            React.createElement(Infos, { design: design, error: error, keyValuePairs: postStages }))),
+            React.createElement(ErrorBoundary, { getFallbackText: () => postStages.map((s) => (s.label ? `${s.label}: ${s.value}` : s.value)).join('\n') },
+                React.createElement(Infos, { design: design, error: error, keyValuePairs: postStages })))),
         hasElapsedTime && (React.createElement(Box, { marginLeft: 1, display: actualLevelOfCompaction < 2 ? 'flex' : 'none', flexWrap: "wrap" },
-            React.createElement(Text, null, "Elapsed Time: "),
-            React.createElement(Timer, { unit: timerUnit })))));
+            React.createElement(ErrorBoundary, null,
+                React.createElement(Text, null, "Elapsed Time: "),
+                React.createElement(Timer, { unit: timerUnit }))))));
 }

package/lib/multi-stage-output.js

@@ -7,10 +7,32 @@ import { Stages, } from './components/stages.js';
 import { constructDesignParams } from './design.js';
 import { StageTracker } from './stage-tracker.js';
 import { readableTime } from './utils.js';
-// Taken from https://github.com/sindresorhus/is-in-ci
-const isInCi = env.CI !== '0' &&
-    env.CI !== 'false' &&
-    ('CI' in env || 'CONTINUOUS_INTEGRATION' in env || Object.keys(env).some((key) => key.startsWith('CI_')));
+function isTruthy(value) {
+    return value !== '0' && value !== 'false';
+}
+/**
+ * Determines whether the CI mode should be used.
+ *
+ * If the MSO_DISABLE_CI_MODE environment variable is set to a truthy value, CI mode will be disabled.
+ *
+ * If the CI environment variable is set, CI mode will be enabled.
+ *
+ * If the DEBUG environment variable is set, CI mode will be enabled.
+ *
+ * @returns {boolean} True if CI mode should be used, false otherwise.
+ */
+function shouldUseCIMode() {
+    if (env.MSO_DISABLE_CI_MODE && isTruthy(env.MSO_DISABLE_CI_MODE))
+        return false;
+    // Inspired by https://github.com/sindresorhus/is-in-ci
+    if (isTruthy(env.CI) &&
+        ('CI' in env || 'CONTINUOUS_INTEGRATION' in env || Object.keys(env).some((key) => key.startsWith('CI_'))))
+        return true;
+    if (env.DEBUG && isTruthy(env.DEBUG))
+        return true;
+    return false;
+}
+const isInCi = shouldUseCIMode();
 class CIMultiStageOutput {
     data;
     design;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/multi-stage-output",
   "description": "Terminal output for oclif commands with multiple stages",
-  "version": "0.5.2",
+  "version": "0.5.4-qa.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/multi-stage-output/issues",
   "dependencies": {
@@ -24,11 +24,11 @@
     "commitlint": "^19",
     "eslint": "^8.57.0",
     "eslint-config-oclif": "^5.2.0",
-    "eslint-config-oclif-typescript": "^3.1.8",
+    "eslint-config-oclif-typescript": "^3.1.10",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-xo": "^0.45.0",
     "eslint-config-xo-react": "^0.27.0",
-    "eslint-plugin-react": "^7.34.3",
+    "eslint-plugin-react": "^7.35.2",
     "eslint-plugin-react-hooks": "^4.6.2",
     "husky": "^9.1.5",
     "ink-testing-library": "^4.0.0",