@oclif/table 0.4.5 → 0.4.7

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.
  *
@@ -16,7 +16,7 @@ import { allKeysInCollection, determineConfiguredWidth, determineWidthOfWrappedT
  */
 function determineWidthToUse(columns, maxWidth, width) {
     const tableWidth = columns.map((c) => c.width).reduce((a, b) => a + b, 0) + columns.length + 1;
-    return width ?? Math.max(tableWidth, maxWidth);
+    return width ?? (tableWidth < maxWidth ? maxWidth : tableWidth);
 }
 function determineTruncatePosition(overflow) {
     switch (overflow) {
@@ -286,7 +286,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 +396,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,6 +11,7 @@ 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;
+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.

package/lib/utils.js

@@ -42,6 +42,14 @@ export function determineWidthOfWrappedText(text) {
     const lines = text.split('\n');
     return lines.reduce((max, line) => Math.max(max, line.length), 0);
 }
+// In certain systems, `process.stdout.columns` can be 0
+// The column width is calculated by:
+// 1. The value of `OCLIF_TABLE_COLUMN_OVERRIDE` (if set)
+// 2. The value of `process.stdout.columns`
+// 3. If `process.stdout.columns` is 0, use 80
+export function getColumnWidth() {
+    return Number.parseInt(process.env.OCLIF_TABLE_COLUMN_OVERRIDE || '0', 10) || process.stdout.columns || 80;
+}
 /**
  * Determines the configured width based on the provided width value.
  * If no width is provided, it returns the width of the current terminal.
@@ -52,7 +60,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('%')
@@ -111,7 +119,7 @@ export function getColumns(config, headings) {
                 break;
             const minWidth = calcMinWidth(largestColumn);
             const difference = tableWidth - maxWidth;
-            const newWidth = Math.max(largestColumn.width - difference, minWidth);
+            const newWidth = largestColumn.width - difference < minWidth ? minWidth : largestColumn.width - difference;
             largestColumn.width = newWidth;
             tableWidth = calculateTableWidth(widths);
             seen.add(largestColumn.key);

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@oclif/table",
   "description": "Display table in terminal",
-  "version": "0.4.5",
+  "version": "0.4.7",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/table/issues",
   "dependencies": {
-    "@oclif/core": "^4",
     "@types/react": "^18.3.12",
     "change-case": "^5.4.4",
     "cli-truncate": "^4.0.0",
@@ -18,30 +17,31 @@
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^19",
-    "@eslint/compat": "^1.2.6",
+    "@eslint/compat": "^1.2.8",
+    "@oclif/core": "^4",
     "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^4.1.8",
+    "@oclif/test": "^4.1.12",
     "@types/chai": "^4.3.16",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18",
     "@types/object-hash": "^3.0.6",
     "@types/sinon": "^17.0.3",
-    "ansis": "^3.5.2",
+    "ansis": "^3.17.0",
     "chai": "^4.5.0",
     "commitlint": "^19",
-    "eslint": "^9.19.0",
-    "eslint-config-oclif": "^6.0.0",
-    "eslint-config-prettier": "^10.0.1",
+    "eslint": "^9.24.0",
+    "eslint-config-oclif": "^6.0.39",
+    "eslint-config-prettier": "^10.1.1",
     "eslint-config-xo": "^0.46.0",
     "eslint-config-xo-react": "^0.28.0",
-    "eslint-plugin-react": "^7.37.4",
+    "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^4.6.2",
     "husky": "^9.1.7",
     "ink-testing-library": "^4.0.0",
     "lint-staged": "^15",
     "mocha": "^10.8.2",
-    "prettier": "^3.4.2",
-    "shx": "^0.3.4",
+    "prettier": "^3.5.3",
+    "shx": "^0.4.0",
     "sinon": "^18",
     "terminal-link": "^3.0.0",
     "ts-node": "^10.9.2",