@oclif/table 0.4.10 → 0.4.12

package/lib/table.d.ts

@@ -1,11 +1,12 @@
 import React from 'react';
 import { CellProps, ContainerProps, HorizontalAlignment, Overflow, TableOptions } from './types.js';
-export declare function formatTextWithMargins({ horizontalAlignment, overflow, padding, value, width, }: {
+export declare function formatTextWithMargins({ horizontalAlignment, overflow, padding, trimWhitespace, value, width }: {
     overflow: Overflow;
     value: unknown;
     width: number;
     padding: number;
     horizontalAlignment: HorizontalAlignment;
+    trimWhitespace?: boolean;
 }): {
     text: string;
     marginLeft: number;

package/lib/table.js

@@ -34,7 +34,7 @@ function determineTruncatePosition(overflow) {
         }
     }
 }
-export function formatTextWithMargins({ horizontalAlignment, overflow, padding, value, width, }) {
+export function formatTextWithMargins({ horizontalAlignment, overflow, padding, trimWhitespace = true, value, width }) {
     function calculateMargins(spaces) {
         let marginLeft;
         let marginRight;
@@ -76,7 +76,7 @@ export function formatTextWithMargins({ horizontalAlignment, overflow, padding,
     if (overflow === 'wrap') {
         const wrappedText = wrapAnsi(valueWithNoZeroWidthChars, spaceForText, {
             hard: true,
-            trim: true,
+            trim: trimWhitespace,
             wordWrap: true,
         }).replace(/^\n/, ''); // remove leading newline (wrapAnsi adds it to emojis)
         const { marginLeft, marginRight } = calculateMargins(width - determineWidthOfWrappedText(stripAnsi(wrappedText)));
@@ -114,7 +114,7 @@ export function formatTextWithMargins({ horizontalAlignment, overflow, padding,
     };
 }
 function setupTable(props) {
-    const { data, filter, horizontalAlignment = 'left', maxWidth, noStyle = false, overflow = 'truncate', padding = 1, sort, title, verticalAlignment = 'top', width, } = props;
+    const { data, filter, horizontalAlignment = 'left', maxWidth, noStyle = false, overflow = 'truncate', padding = 1, sort, title, trimWhitespace, verticalAlignment = 'top', width, } = props;
     const headerOptions = noStyle ? {} : { bold: true, color: 'blue', ...props.headerOptions };
     const borderStyle = noStyle ? 'none' : (props.borderStyle ?? 'all');
     const borderColor = noStyle ? undefined : props.borderColor;
@@ -131,6 +131,7 @@ function setupTable(props) {
         maxWidth: tableWidth ?? determineConfiguredWidth(maxWidth),
         overflow,
         padding,
+        trimWhitespace,
         verticalAlignment,
         width: tableWidth,
     };
@@ -146,6 +147,7 @@ function setupTable(props) {
         borderProps,
         cell: Cell,
         skeleton: BORDER_SKELETONS[config.borderStyle].data,
+        trimWhitespace
     });
     const footerComponent = row({
         borderProps,
@@ -217,7 +219,7 @@ export function Table(props) {
  */
 function row(config) {
     // This is a component builder. We return a function.
-    const { borderProps, skeleton } = config;
+    const { borderProps, skeleton, trimWhitespace } = config;
     return (props) => {
         const data = props.columns.map((column, colI) => {
             const { horizontalAlignment, overflow, padding, verticalAlignment, width } = column;
@@ -231,6 +233,7 @@ function row(config) {
                 horizontalAlignment,
                 overflow,
                 padding,
+                trimWhitespace,
                 value,
                 width,
             });
@@ -316,19 +319,39 @@ function renderPlainTable(props) {
     const { columns, headings, processedData, title } = setupTable(props);
     if (title)
         console.log(title);
-    const headerString = columns.reduce((acc, column) => {
+    // Process header columns the same way as data rows to handle multi-line headers
+    const headerColumnTexts = columns.map((column) => {
         const { horizontalAlignment, overflow, padding, width } = column;
         const { marginLeft, marginRight, text } = formatTextWithMargins({
             horizontalAlignment,
             overflow,
             padding,
+            trimWhitespace: props.trimWhitespace,
             value: headings[column.column] ?? column.column,
             width,
         });
-        return `${acc}${' '.repeat(marginLeft)}${text}${' '.repeat(marginRight)}`;
-    }, '');
-    console.log(headerString);
-    console.log('-'.repeat(headerString.length));
+        // Split the formatted text into lines
+        const lines = text.split('\n');
+        return lines.map((line) => `${' '.repeat(marginLeft)}${line.trimStart()}${' '.repeat(marginRight)}`);
+    });
+    // Find the maximum number of lines in any header column
+    const maxHeaderLines = Math.max(...headerColumnTexts.map((col) => col.length));
+    // Pad all header columns to have the same number of lines
+    const paddedHeaderColumns = headerColumnTexts.map((col, colIndex) => {
+        const column = columns[colIndex];
+        while (col.length < maxHeaderLines) {
+            col.push(' '.repeat(column.width)); // Add empty lines
+        }
+        return col;
+    });
+    // Print each line of the header
+    for (let lineIndex = 0; lineIndex < maxHeaderLines; lineIndex++) {
+        const lineToPrint = paddedHeaderColumns.map((col) => col[lineIndex]).join('');
+        console.log(lineToPrint);
+    }
+    // Calculate total width for the separator line
+    const totalWidth = columns.reduce((acc, column) => acc + column.width, 0);
+    console.log('-'.repeat(totalWidth));
     for (const row of processedData) {
         // Process all columns and get their formatted text
         const columnTexts = columns.map((column) => {
@@ -341,6 +364,7 @@ function renderPlainTable(props) {
                 horizontalAlignment,
                 overflow,
                 padding,
+                trimWhitespace: props.trimWhitespace,
                 value,
                 width,
             });

package/lib/types.d.ts

@@ -165,6 +165,11 @@ export type TableOptions<T extends Record<string, unknown>> = {
      * Title of the table. Displayed above the table.
      */
     title?: string;
+    /**
+     * Whether or not to trim the whitespace of row content
+     * default: true
+     */
+    trimWhitespace?: boolean;
     /**
      * Styling options for the title of the table.
      */
@@ -181,6 +186,7 @@ export type Config<T> = {
     maxWidth: number;
     overflow: Overflow;
     headerOptions: HeaderOptions;
+    trimWhitespace: boolean | undefined;
     borderStyle: BorderStyle;
     horizontalAlignment: HorizontalAlignment;
     verticalAlignment: VerticalAlignment;
@@ -206,6 +212,11 @@ export type RowConfig = {
         cross: string;
         line: string;
     };
+    /**
+     * Whether or not to trim the whitespace of row content
+     * default: true
+     */
+    trimWhitespace?: boolean;
     props?: Record<string, unknown>;
     borderProps: {
         color: SupportedColor | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/table",
   "description": "Display table in terminal",
-  "version": "0.4.10",
+  "version": "0.4.12",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/table/issues",
   "dependencies": {
@@ -30,7 +30,7 @@
     "chai": "^4.5.0",
     "commitlint": "^19",
     "eslint": "^9.32.0",
-    "eslint-config-oclif": "^6.0.87",
+    "eslint-config-oclif": "^6.0.89",
     "eslint-config-prettier": "^10.1.8",
     "eslint-config-xo": "^0.48.0",
     "eslint-config-xo-react": "^0.28.0",