@oclif/table 0.4.8 → 0.4.9

package/lib/table.js

@@ -8,7 +8,7 @@ import React from 'react';
 import stripAnsi from 'strip-ansi';
 import wrapAnsi from 'wrap-ansi';
 import { BORDER_SKELETONS } from './skeletons.js';
-import { allKeysInCollection, determineConfiguredWidth, determineWidthOfWrappedText, getColumns, getHeadings, intersperse, maybeStripAnsi, shouldUsePlainTable, sortData, } from './utils.js';
+import { allKeysInCollection, determineConfiguredWidth, determineWidthOfWrappedText, getColumns, getColumnWidth, getHeadings, intersperse, maybeStripAnsi, shouldUsePlainTable, sortData, } from './utils.js';
 /**
  * Determine the width to use for the table.
  *
@@ -64,13 +64,15 @@ export function formatTextWithMargins({ horizontalAlignment, overflow, padding,
     // https://github.com/Shopify/cli/pull/995
     const valueWithNoZeroWidthChars = String(value).replaceAll('​', ' ');
     const spaceForText = width - padding * 2;
-    if (stripAnsi(valueWithNoZeroWidthChars).length <= spaceForText) {
+    // Handle the simple case where text fits within the available space and doesn't contain any newlines.
+    if (stripAnsi(valueWithNoZeroWidthChars).length <= spaceForText && !valueWithNoZeroWidthChars.includes('\n')) {
         const spaces = width - stripAnsi(valueWithNoZeroWidthChars).length;
         return {
             text: valueWithNoZeroWidthChars,
             ...calculateMargins(spaces),
         };
     }
+    // Handle the case where the text needs to be wrapped.
     if (overflow === 'wrap') {
         const wrappedText = wrapAnsi(valueWithNoZeroWidthChars, spaceForText, {
             hard: true,
@@ -101,6 +103,7 @@ export function formatTextWithMargins({ horizontalAlignment, overflow, padding,
             text: lines.join('\n'),
         };
     }
+    // Handle the case where the text needs to be truncated.
     const text = cliTruncate(valueWithNoZeroWidthChars.replaceAll('\n', ' '), spaceForText, {
         position: determineTruncatePosition(overflow),
     });
@@ -286,7 +289,7 @@ const createStdout = () => {
     // https://github.com/vadimdemedes/ink/blob/v5.0.1/src/ink.tsx#L174
     // This might be a bad idea but it works.
     stdout.rows = 10_000;
-    stdout.columns = process.stdout.columns ?? 80;
+    stdout.columns = getColumnWidth();
     const frames = [];
     stdout.write = (data) => {
         frames.push(data);
@@ -396,7 +399,7 @@ export function printTables(tables, options) {
     const output = new Output();
     const leftMargin = options?.marginLeft ?? options?.margin ?? 0;
     const rightMargin = options?.marginRight ?? options?.margin ?? 0;
-    const columns = process.stdout.columns - (leftMargin + rightMargin);
+    const columns = getColumnWidth() - (leftMargin + rightMargin);
     const processed = tables.map((table) => ({
         ...table,
         // adjust maxWidth to account for margin and columnGap

package/lib/utils.d.ts

@@ -11,9 +11,22 @@ export declare function intersperse<T, I>(intersperser: (index: number) => I, el
 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;
+/**
+ * Gets the width of the terminal column.
+ * First checks for an override in the OCLIF_TABLE_COLUMN_OVERRIDE environment variable.
+ * If no override is set or the override is 0, returns the actual terminal width from process.stdout.columns.
+ *
+ * It's possible that `process.stdout.columns` is undefined or 0, which is okay. We'll end up using the table's natural width
+ * in that case. If that renders poorly for the user, they can set the OCLIF_TABLE_COLUMN_OVERRIDE environment variable to a
+ * non-zero value.
+ *
+ * @returns {number} The width of the terminal column
+ */
+export declare function getColumnWidth(): number;
 /**
  * Determines the configured width based on the provided width value.
  * If no width is provided, it returns the width of the current terminal.
+ *   - It's possible that `process.stdout.columns` is undefined, which is okay. We'll end up using the table's natural width.
  * If the provided width is a percentage, it calculates the width based on the percentage of the terminal width.
  * If the provided width is a number, it returns the provided width.
  * If the calculated width is greater than the terminal width, it returns the terminal width.

package/lib/utils.js

@@ -42,9 +42,24 @@ export function determineWidthOfWrappedText(text) {
     const lines = text.split('\n');
     return lines.reduce((max, line) => Math.max(max, line.length), 0);
 }
+/**
+ * Gets the width of the terminal column.
+ * First checks for an override in the OCLIF_TABLE_COLUMN_OVERRIDE environment variable.
+ * If no override is set or the override is 0, returns the actual terminal width from process.stdout.columns.
+ *
+ * It's possible that `process.stdout.columns` is undefined or 0, which is okay. We'll end up using the table's natural width
+ * in that case. If that renders poorly for the user, they can set the OCLIF_TABLE_COLUMN_OVERRIDE environment variable to a
+ * non-zero value.
+ *
+ * @returns {number} The width of the terminal column
+ */
+export function getColumnWidth() {
+    return Number.parseInt(process.env.OCLIF_TABLE_COLUMN_OVERRIDE || '0', 10) || process.stdout.columns;
+}
 /**
  * Determines the configured width based on the provided width value.
  * If no width is provided, it returns the width of the current terminal.
+ *   - It's possible that `process.stdout.columns` is undefined, which is okay. We'll end up using the table's natural width.
  * If the provided width is a percentage, it calculates the width based on the percentage of the terminal width.
  * If the provided width is a number, it returns the provided width.
  * If the calculated width is greater than the terminal width, it returns the terminal width.
@@ -52,7 +67,7 @@ export function determineWidthOfWrappedText(text) {
  * @param providedWidth - The width value provided.
  * @returns The determined configured width.
  */
-export function determineConfiguredWidth(providedWidth, columns = process.stdout.columns) {
+export function determineConfiguredWidth(providedWidth, columns = getColumnWidth()) {
     if (!providedWidth)
         return columns;
     const num = typeof providedWidth === 'string' && providedWidth.endsWith('%')
@@ -101,6 +116,10 @@ export function getColumns(config, headings) {
     let tableWidth = calculateTableWidth(widths);
     const seen = new Set();
     const reduceColumnWidths = (calcMinWidth) => {
+        // maxWidth === 0 is likely from a test environment where process.stdout.columns is undefined or 0
+        // In that case, we don't want to reduce the column widths and just use the table's natural width.
+        if (maxWidth === 0)
+            return;
         // If the table is too wide, reduce the width of the largest column as little as possible to fit the table.
         // If the table is still too wide, it will reduce the width of the next largest column and so on
         while (tableWidth > maxWidth) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/table",
   "description": "Display table in terminal",
-  "version": "0.4.8",
+  "version": "0.4.9",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/table/issues",
   "dependencies": {
@@ -17,10 +17,10 @@
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^19",
-    "@eslint/compat": "^1.2.8",
+    "@eslint/compat": "^1.3.0",
     "@oclif/core": "^4",
     "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^4.1.12",
+    "@oclif/test": "^4.1.13",
     "@types/chai": "^4.3.16",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18",
@@ -29,10 +29,10 @@
     "ansis": "^3.17.0",
     "chai": "^4.5.0",
     "commitlint": "^19",
-    "eslint": "^9.24.0",
-    "eslint-config-oclif": "^6.0.42",
-    "eslint-config-prettier": "^10.1.2",
-    "eslint-config-xo": "^0.46.0",
+    "eslint": "^9.29.0",
+    "eslint-config-oclif": "^6.0.68",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-config-xo": "^0.47.0",
     "eslint-config-xo-react": "^0.28.0",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^4.6.2",