@oclif/table 0.1.18 → 0.1.20

package/lib/table.js

@@ -121,7 +121,7 @@ export function formatTextWithMargins({ horizontalAlignment, overflow, padding,
         ...calculateMargins(spaces),
     };
 }
-export function Table(props) {
+function setup(props) {
     const { data, filter, horizontalAlignment = 'left', maxWidth, noStyle = false, overflow = 'truncate', padding = 1, sort, title, verticalAlignment = 'top', } = props;
     const headerOptions = noStyle ? {} : { bold: true, color: 'blue', ...props.headerOptions };
     const borderStyle = noStyle ? 'none' : (props.borderStyle ?? 'all');
@@ -142,6 +142,12 @@ export function Table(props) {
     };
     const headings = getHeadings(config);
     const columns = getColumns(config, headings);
+    // check for duplicate columns
+    const columnKeys = columns.map((c) => c.key);
+    const duplicates = columnKeys.filter((c, i) => columnKeys.indexOf(c) !== i);
+    if (duplicates.length > 0) {
+        throw new Error(`Duplicate columns found: ${duplicates.join(', ')}`);
+    }
     const dataComponent = row({
         borderProps,
         cell: Cell,
@@ -180,6 +186,23 @@ export function Table(props) {
         props: borderProps,
         skeleton: BORDER_SKELETONS[config.borderStyle].separator,
     });
+    return {
+        columns,
+        config,
+        dataComponent,
+        footerComponent,
+        headerComponent,
+        headerFooterComponent,
+        headingComponent,
+        headings,
+        processedData,
+        separatorComponent,
+        title,
+        titleOptions,
+    };
+}
+export function Table(props) {
+    const { columns, config, dataComponent, footerComponent, headerComponent, headerFooterComponent, headingComponent, headings, processedData, separatorComponent, title, titleOptions, } = setup(props);
     return (React.createElement(Box, { flexDirection: "column", width: determineWidthToUse(columns, config.maxWidth) },
         title && React.createElement(Text, { ...titleOptions }, title),
         headerComponent({ columns, data: {}, key: 'header' }),
@@ -264,7 +287,12 @@ export function Skeleton(props) {
 class Stream extends WriteStream {
     frames = [];
     lastFrame() {
-        return this.frames.filter((f) => stripAnsi(f) !== '').at(-1);
+        return this.frames
+            .filter((f) => {
+            const stripped = stripAnsi(f);
+            return stripped !== '' && stripped !== '\n';
+        })
+            .at(-1);
     }
     write(data) {
         this.frames.push(data);
@@ -273,23 +301,64 @@ class Stream extends WriteStream {
 }
 class Output {
     stream;
-    constructor(fd = 1) {
+    constructor() {
+        const fd = process.env.OCLIF_TABLE_FD ? Number(process.env.OCLIF_TABLE_FD) : 0;
         this.stream = process.env.NODE_ENV === 'test' ? process.stdout : new Stream(fd);
     }
     maybePrintLastFrame() {
         if (this.stream instanceof Stream) {
-            process.stdout.write(`${this.stream.lastFrame()}\n`);
+            process.stdout.write(`${this.stream.lastFrame()}`);
         }
         else {
             process.stdout.write('\n');
         }
     }
 }
+function chunk(array, size) {
+    return array.reduce((acc, _, i) => {
+        if (i % size === 0)
+            acc.push(array.slice(i, i + size));
+        return acc;
+    }, []);
+}
+function renderTableInChunks(props) {
+    const { columns, config, dataComponent, footerComponent, headerComponent, headerFooterComponent, headingComponent, headings, processedData, separatorComponent, title, titleOptions, } = setup(props);
+    const headerOutput = new Output();
+    const headerInstance = render(React.createElement(Box, { flexDirection: "column", width: determineWidthToUse(columns, config.maxWidth) },
+        title && React.createElement(Text, { ...titleOptions }, title),
+        headerComponent({ columns, data: {}, key: 'header' }),
+        headingComponent({ columns, data: headings, key: 'heading' }),
+        headerFooterComponent({ columns, data: {}, key: 'footer' })), { stdout: headerOutput.stream });
+    headerInstance.unmount();
+    headerOutput.maybePrintLastFrame();
+    const chunks = chunk(processedData, Math.max(1, Math.floor(process.stdout.rows / 2)));
+    for (const chunk of chunks) {
+        const chunkOutput = new Output();
+        const instance = render(React.createElement(Box, { flexDirection: "column", width: determineWidthToUse(columns, config.maxWidth) }, chunk.map((row, index) => {
+            // Calculate the hash of the row based on its value and position
+            const key = `row-${sha1(row)}-${index}`;
+            // Construct a row.
+            return (React.createElement(Box, { key: key, flexDirection: "column" },
+                separatorComponent({ columns, data: {}, key: `separator-${key}` }),
+                dataComponent({ columns, data: row, key: `data-${key}` })));
+        })), { stdout: chunkOutput.stream });
+        instance.unmount();
+        chunkOutput.maybePrintLastFrame();
+    }
+    const footerOutput = new Output();
+    const footerInstance = render(React.createElement(Box, { flexDirection: "column", width: determineWidthToUse(columns, config.maxWidth) }, footerComponent({ columns, data: {}, key: 'footer' })), { stdout: footerOutput.stream });
+    footerInstance.unmount();
+    footerOutput.maybePrintLastFrame();
+}
 /**
  * Renders a table with the given data.
  * @param options see {@link TableOptions}
  */
 export function printTable(options) {
+    if (options.data.length > 50_000) {
+        renderTableInChunks(options);
+        return;
+    }
     const output = new Output();
     const instance = render(React.createElement(Table, { ...options }), { stdout: output.stream });
     instance.unmount();
@@ -299,6 +368,9 @@ function Container(props) {
     return (React.createElement(Box, { flexWrap: "wrap", flexDirection: props.direction ?? 'row', ...props }, props.children));
 }
 export function printTables(tables, options) {
+    if (tables.reduce((acc, table) => acc + table.data.length, 0) > 30_000) {
+        throw new Error('The data is too large to print multiple tables. Please use `printTable` instead.');
+    }
     const output = new Output();
     const leftMargin = options?.marginLeft ?? options?.margin ?? 0;
     const rightMargin = options?.marginRight ?? options?.margin ?? 0;

package/lib/utils.js

@@ -67,14 +67,18 @@ export function getColumns(config, headings) {
         };
     });
     const numberOfBorders = widths.length + 1;
-    const calculateTableWidth = (widths) => widths.map((w) => w.width).reduce((a, b) => a + b) + numberOfBorders;
+    const calculateTableWidth = (widths) => widths.map((w) => w.width + w.padding * 2).reduce((a, b) => a + b) + numberOfBorders;
     // If the table is too wide, reduce the width of the largest column as little as possible to fit the table.
     // At most, it will reduce the width to the length of the column's header plus padding.
     // If the table is still too wide, it will reduce the width of the next largest column and so on
     let tableWidth = calculateTableWidth(widths);
     const seen = new Set();
     while (tableWidth > maxWidth) {
-        const largestColumn = widths.reduce((a, b) => (a.width > b.width ? a : b));
+        const largestColumn = widths.filter((w) => !seen.has(w.key)).sort((a, b) => b.width - a.width)[0];
+        if (!largestColumn)
+            break;
+        if (seen.has(largestColumn.key))
+            break;
         const header = String(headings[largestColumn.key]).length;
         // The minimum width of a column is the width of the header plus padding on both sides
         const minWidth = header + largestColumn.padding * 2;
@@ -82,8 +86,6 @@ export function getColumns(config, headings) {
         const newWidth = largestColumn.width - difference < minWidth ? minWidth : largestColumn.width - difference;
         largestColumn.width = newWidth;
         tableWidth = calculateTableWidth(widths);
-        if (seen.has(largestColumn.key))
-            break;
         seen.add(largestColumn.key);
     }
     return widths;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/table",
   "description": "Display table in terminal",
-  "version": "0.1.18",
+  "version": "0.1.20",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/table/issues",
   "dependencies": {
@@ -21,7 +21,7 @@
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^4.0.9",
     "@types/chai": "^4.3.16",
-    "@types/mocha": "^10.0.8",
+    "@types/mocha": "^10.0.9",
     "@types/node": "^18",
     "@types/object-hash": "^3.0.6",
     "@types/sinon": "^17.0.3",
@@ -30,7 +30,7 @@
     "commitlint": "^19",
     "eslint": "^8.57.0",
     "eslint-config-oclif": "^5.2.0",
-    "eslint-config-oclif-typescript": "^3.1.11",
+    "eslint-config-oclif-typescript": "^3.1.12",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-xo": "^0.45.0",
     "eslint-config-xo-react": "^0.27.0",