@oclif/table 0.1.3 → 0.1.5

package/lib/table.js

@@ -39,6 +39,73 @@ function determineWidthToUse(columns, configuredWidth) {
     const tableWidth = columns.map((c) => c.width).reduce((a, b) => a + b) + columns.length + 1;
     return tableWidth < configuredWidth ? configuredWidth : tableWidth;
 }
+function determineWidthOfWrappedText(text) {
+    const lines = text.split('\n');
+    return lines.reduce((max, line) => Math.max(max, line.length), 0);
+}
+function determineTruncatePosition(overflow) {
+    switch (overflow) {
+        case 'truncate-middle': {
+            return 'middle';
+        }
+        case 'truncate-start': {
+            return 'start';
+        }
+        case 'truncate-end': {
+            return 'end';
+        }
+        default: {
+            return 'end';
+        }
+    }
+}
+function doStuffWithText({ horizontalAlignment, overflow, padding, value, width, }) {
+    function calculateMargins(spaces) {
+        let marginLeft;
+        let marginRight;
+        if (horizontalAlignment === 'left') {
+            marginLeft = padding;
+            marginRight = spaces - marginLeft;
+        }
+        else if (horizontalAlignment === 'center') {
+            marginLeft = Math.floor(spaces / 2);
+            marginRight = Math.ceil(spaces / 2);
+        }
+        else {
+            marginRight = padding;
+            marginLeft = spaces - marginRight;
+        }
+        return { marginLeft, marginRight };
+    }
+    // Some terminals don't play nicely with zero-width characters, so we replace them with spaces.
+    // https://github.com/sindresorhus/terminal-link/issues/18
+    // https://github.com/Shopify/cli/pull/995
+    const valueWithNoZeroWidthChars = String(value).replaceAll('​', ' ');
+    const spaceForText = width - padding * 2;
+    if (stripAnsi(valueWithNoZeroWidthChars).length < spaceForText) {
+        const spaces = width - stripAnsi(valueWithNoZeroWidthChars).length;
+        return {
+            text: valueWithNoZeroWidthChars,
+            ...calculateMargins(spaces),
+        };
+    }
+    if (overflow === 'wrap') {
+        const wrappedText = wrapAnsi(valueWithNoZeroWidthChars, spaceForText, { hard: true, trim: true, wordWrap: true });
+        const { marginLeft, marginRight } = calculateMargins(width - determineWidthOfWrappedText(wrappedText));
+        const text = wrappedText.replaceAll('\n', `${' '.repeat(marginRight)}\n${' '.repeat(marginLeft)}`);
+        return {
+            marginLeft,
+            marginRight,
+            text,
+        };
+    }
+    const text = cliTruncate(valueWithNoZeroWidthChars, spaceForText, { position: determineTruncatePosition(overflow) });
+    const spaces = width - stripAnsi(text).length;
+    return {
+        text,
+        ...calculateMargins(spaces),
+    };
+}
 export function Table(props) {
     const { data, filter, horizontalAlignment = 'left', maxWidth, noStyle = false, orientation = 'horizontal', overflow = 'truncate', padding = 1, sort, title, verticalAlignment = 'top', } = props;
     const headerOptions = noStyle ? {} : { bold: true, color: 'blue', ...props.headerOptions };
@@ -148,35 +215,15 @@ function row(config) {
                 return (React.createElement(config.cell, { key: key, column: colI, ...config.props }, skeleton.line.repeat(width)));
             }
             const key = `${props.key}-cell-${column.key}`;
-            // Some terminals don't play nicely with zero-width characters, so we replace them with spaces.
-            // https://github.com/sindresorhus/terminal-link/issues/18
-            // https://github.com/Shopify/cli/pull/995
-            const valueWithNoZeroWidthChars = String(value).replaceAll('​', ' ');
-            const spaceForText = width - padding * 2;
-            const v = 
-            // if the visible length of the value is greater than the column width, truncate or wrap
-            stripAnsi(valueWithNoZeroWidthChars).length >= spaceForText
-                ? overflow === 'wrap'
-                    ? wrapAnsi(valueWithNoZeroWidthChars, spaceForText, { hard: true, trim: true, wordWrap: false }).replaceAll('\n', `${' '.repeat(padding)}\n${' '.repeat(padding)}`)
-                    : cliTruncate(valueWithNoZeroWidthChars, spaceForText)
-                : valueWithNoZeroWidthChars;
-            const spaces = overflow === 'wrap' ? width - stripAnsi(v).split('\n')[0].trim().length : width - stripAnsi(v).length;
-            let marginLeft;
-            let marginRight;
-            if (horizontalAlignment === 'left') {
-                marginLeft = padding;
-                marginRight = spaces - marginLeft;
-            }
-            else if (horizontalAlignment === 'center') {
-                marginLeft = Math.floor(spaces / 2);
-                marginRight = Math.ceil(spaces / 2);
-            }
-            else {
-                marginRight = padding;
-                marginLeft = spaces - marginRight;
-            }
+            const { marginLeft, marginRight, text } = doStuffWithText({
+                horizontalAlignment,
+                overflow,
+                padding,
+                value,
+                width,
+            });
             const alignItems = verticalAlignment === 'top' ? 'flex-start' : verticalAlignment === 'center' ? 'center' : 'flex-end';
-            return (React.createElement(config.cell, { key: key, column: colI, alignItems, ...config.props }, `${skeleton.line.repeat(marginLeft)}${v}${skeleton.line.repeat(marginRight)}`));
+            return (React.createElement(config.cell, { key: key, column: colI, alignItems, ...config.props }, `${skeleton.line.repeat(marginLeft)}${text}${skeleton.line.repeat(marginRight)}`));
         });
         const height = data.map((d) => d.props.children.split('\n').length).reduce((a, b) => Math.max(a, b), 0);
         const elements = intersperse((i) => {

package/lib/types.d.ts

@@ -51,7 +51,7 @@ export type HeaderOptions = TextOptions & {
      */
     formatter?: HeaderFormatter;
 };
-type Overflow = 'wrap' | 'truncate';
+export type Overflow = 'wrap' | 'truncate' | 'truncate-middle' | 'truncate-start' | 'truncate-end';
 type SortOrder<T> = 'asc' | 'desc' | ((valueA: T, valueB: T) => number);
 export type Sort<T> = {
     [K in keyof T]?: SortOrder<T[K]>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/table",
   "description": "Display table in terminal",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/multi-stage-output/issues",
   "dependencies": {