@oclif/table 0.1.11 → 0.1.13

package/lib/table.d.ts

@@ -1,5 +1,16 @@
 import React from 'react';
-import { CellProps, ContainerProps, TableOptions } from './types.js';
+import { CellProps, ContainerProps, HorizontalAlignment, Overflow, TableOptions } from './types.js';
+export declare function formatTextWithMargins({ horizontalAlignment, overflow, padding, value, width, }: {
+    overflow: Overflow;
+    value: unknown;
+    width: number;
+    padding: number;
+    horizontalAlignment: HorizontalAlignment;
+}): {
+    text: string;
+    marginLeft: number;
+    marginRight: number;
+};
 export declare function Table<T extends Record<string, unknown>>(props: TableOptions<T>): React.JSX.Element;
 /**
  * Renders the header of a table.

package/lib/table.js

@@ -6,7 +6,7 @@ import React from 'react';
 import stripAnsi from 'strip-ansi';
 import wrapAnsi from 'wrap-ansi';
 import { BORDER_SKELETONS } from './skeletons.js';
-import { allKeysInCollection, getColumns, getHeadings, intersperse, maybeStripAnsi, sortData } from './utils.js';
+import { allKeysInCollection, determineWidthOfWrappedText, getColumns, getHeadings, intersperse, maybeStripAnsi, sortData, } from './utils.js';
 /**
  * Determines the configured width based on the provided width value.
  * If no width is provided, it returns the width of the current terminal.
@@ -39,10 +39,6 @@ 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': {
@@ -59,7 +55,7 @@ function determineTruncatePosition(overflow) {
         }
     }
 }
-function formatTextWithMargins({ horizontalAlignment, overflow, padding, value, width, }) {
+export function formatTextWithMargins({ horizontalAlignment, overflow, padding, value, width, }) {
     function calculateMargins(spaces) {
         let marginLeft;
         let marginRight;
@@ -93,28 +89,21 @@ function formatTextWithMargins({ horizontalAlignment, overflow, padding, value,
         const wrappedText = wrapAnsi(valueWithNoZeroWidthChars, spaceForText, { hard: true, trim: true, wordWrap: true });
         const { marginLeft, marginRight } = calculateMargins(width - determineWidthOfWrappedText(stripAnsi(wrappedText)));
         const lines = wrappedText.split('\n').map((line, idx) => {
-            const { marginLeft: lineSpecificLeftMargin } = calculateMargins(width - stripAnsi(line).length);
+            const { marginLeft: lineSpecificLeftMargin, marginRight: lineSpecificRightMargin } = calculateMargins(width - stripAnsi(line).length);
             if (horizontalAlignment === 'left') {
-                if (idx === 0) {
-                    // if it's the first line, only add margin to the right side (The left margin will be applied later)
-                    return `${line}${' '.repeat(marginRight)}`;
-                }
-                // if left alignment, add the overall margin to the left side and right sides
-                return `${' '.repeat(marginLeft)}${line}${' '.repeat(marginRight)}`;
+                return idx === 0
+                    ? `${line}${' '.repeat(lineSpecificRightMargin - marginRight)}`
+                    : `${' '.repeat(marginLeft)}${line}${' '.repeat(lineSpecificRightMargin - marginRight)}`;
             }
             if (horizontalAlignment === 'center') {
-                if (idx === 0) {
-                    // if it's the first line, only add margin to the right side (The left margin will be applied later)
-                    return `${line}${' '.repeat(marginRight)}`;
-                }
-                // if center alignment, add line specific margin to the left side and the overall margin to the right side
-                return `${' '.repeat(lineSpecificLeftMargin)}${line}${' '.repeat(marginRight)}`;
+                return idx === 0
+                    ? `${' '.repeat(lineSpecificLeftMargin - marginLeft)}${line}${' '.repeat(lineSpecificRightMargin)}`
+                    : `${' '.repeat(lineSpecificLeftMargin)}${line}${' '.repeat(lineSpecificRightMargin - marginRight)}`;
             }
             // right alignment
-            if (idx === 0) {
-                return `${' '.repeat(Math.max(0, lineSpecificLeftMargin - marginLeft))}${line}${' '.repeat(marginRight)}`;
-            }
-            return `${' '.repeat(lineSpecificLeftMargin)}${line}${' '.repeat(marginRight)}`;
+            return idx === 0
+                ? `${' '.repeat(Math.max(0, lineSpecificLeftMargin - marginLeft))}${line}${' '.repeat(lineSpecificRightMargin - marginRight)}`
+                : `${' '.repeat(lineSpecificLeftMargin)}${line}${' '.repeat(lineSpecificRightMargin - marginRight)}`;
         });
         return {
             marginLeft,
@@ -122,7 +111,9 @@ function formatTextWithMargins({ horizontalAlignment, overflow, padding, value,
             text: lines.join('\n'),
         };
     }
-    const text = cliTruncate(valueWithNoZeroWidthChars, spaceForText, { position: determineTruncatePosition(overflow) });
+    const text = cliTruncate(valueWithNoZeroWidthChars.replaceAll('\n', ' '), spaceForText, {
+        position: determineTruncatePosition(overflow),
+    });
     const spaces = width - stripAnsi(text).length;
     return {
         text,

package/lib/utils.d.ts

@@ -10,6 +10,7 @@ import { Column, Config, Sort } from './types.js';
 export declare function intersperse<T, I>(intersperser: (index: number) => I, elements: T[]): (T | I)[];
 export declare function sortData<T extends Record<string, unknown>>(data: T[], sort?: Sort<T> | undefined): T[];
 export declare function allKeysInCollection<T extends Record<string, unknown>>(data: T[]): (keyof T)[];
+export declare function determineWidthOfWrappedText(text: string): number;
 export declare function getColumns<T extends Record<string, unknown>>(config: Config<T>, headings: Partial<T>): Column<T>[];
 export declare function getHeadings<T extends Record<string, unknown>>(config: Config<T>): Partial<T>;
 export declare function maybeStripAnsi<T extends Record<string, unknown>[]>(data: T, noStyle: boolean): T;

package/lib/utils.js

@@ -37,6 +37,10 @@ export function allKeysInCollection(data) {
     }
     return [...keys];
 }
+export function determineWidthOfWrappedText(text) {
+    const lines = text.split('\n');
+    return lines.reduce((max, line) => Math.max(max, line.length), 0);
+}
 export function getColumns(config, headings) {
     const { columns, horizontalAlignment, maxWidth, overflow, verticalAlignment } = config;
     const widths = columns.map((propsOrKey) => {
@@ -48,7 +52,7 @@ export function getColumns(config, headings) {
             const value = data[key];
             if (value === undefined || value === null)
                 return 0;
-            return stripAnsi(String(value).replaceAll('​', ' ')).length;
+            return determineWidthOfWrappedText(stripAnsi(String(value).replaceAll('​', ' ')));
         });
         const header = String(headings[key]).length;
         const width = Math.max(...data, header) + padding * 2;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@oclif/table",
   "description": "Display table in terminal",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/table/issues",
   "dependencies": {
     "@oclif/core": "^4",
+    "@types/react": "^18.3.10",
     "change-case": "^5.4.4",
     "cli-truncate": "^4.0.0",
     "ink": "^5.0.1",
@@ -22,7 +23,6 @@
     "@types/mocha": "^10.0.8",
     "@types/node": "^18",
     "@types/object-hash": "^3.0.6",
-    "@types/react": "^18.3.10",
     "@types/sinon": "^17.0.3",
     "ansis": "^3.3.2",
     "chai": "^4.5.0",