fix(W-18763150): width calculation when no process.stdout.columns

Author: mdonnalley

examples/no-width-table.ts

@@ -0,0 +1,37 @@
+import {printTable} from '../src/index.js'
+
+const data = [
+  {
+    actual: 'This is a string of the actual test results. ',
+    expected: 'This is a long string of the expected test results. ',
+    result: 'Passed',
+    test: 'Topic',
+  },
+]
+
+process.stdout.columns = 0
+printTable({
+  columns: ['test', 'result', 'expected', 'actual'],
+  data,
+  headerOptions: {
+    formatter: 'capitalCase',
+  },
+  noStyle: true,
+  overflow: 'wrap',
+  title: 'process.stdout.columns is 0',
+  titleOptions: {bold: true},
+})
+
+// @ts-expect-error for testing
+process.stdout.columns = undefined
+printTable({
+  columns: ['test', 'result', 'expected', 'actual'],
+  data,
+  headerOptions: {
+    formatter: 'capitalCase',
+  },
+  noStyle: true,
+  overflow: 'wrap',
+  title: 'process.stdout.columns is undefined',
+  titleOptions: {bold: true},
+})

src/table.tsx

@@ -27,6 +27,7 @@ import {
   determineConfiguredWidth,
   determineWidthOfWrappedText,
   getColumns,
+  getColumnWidth,
   getHeadings,
   intersperse,
   maybeStripAnsi,
@@ -431,7 +432,7 @@ const createStdout = (): FakeStdout => {
   // 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: string[] = []
 
   stdout.write = (data: string) => {
@@ -568,8 +569,7 @@ export function printTables<T extends Record<string, unknown>[]>(
   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

src/utils.ts

@@ -51,9 +51,25 @@ export function determineWidthOfWrappedText(text: string): number {
   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(): number {
+  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.
@@ -63,7 +79,7 @@ export function determineWidthOfWrappedText(text: string): number {
  */
 export function determineConfiguredWidth(
   providedWidth: number | Percentage | undefined,
-  columns = process.stdout.columns,
+  columns = getColumnWidth(),
 ): number {
   if (!providedWidth) return columns
 
@@ -126,6 +142,9 @@ export function getColumns<T extends Record<string, unknown>>(config: Config<T>,
   const seen = new Set<string>()
 
   const reduceColumnWidths = (calcMinWidth: (col: Column<T>) => number) => {
+    // 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) {

test/table.test.tsx

@@ -718,4 +718,80 @@ describe('printTable compatibility with @oclif/test', () => {
     )
     expect(stdout).to.equal(expected)
   })
+
+  it('prints full table with no set width', async () => {
+    console.log(process.stdout.columns)
+    const data = [
+      {name: 'Foo', age: '1'.repeat(60)},
+      {name: 'Bar', age: '2'.repeat(60)},
+    ]
+
+    const expected = `┌──────┬──────────────────────────────────────────────────────────────┐
+│ name │ age                                                          │
+├──────┼──────────────────────────────────────────────────────────────┤
+│ Foo  │ 111111111111111111111111111111111111111111111111111111111111 │
+├──────┼──────────────────────────────────────────────────────────────┤
+│ Bar  │ 222222222222222222222222222222222222222222222222222222222222 │
+└──────┴──────────────────────────────────────────────────────────────┘
+
+`
+
+    const {stdout} = await captureOutput(async () =>
+      printTable({
+        data,
+        columns: ['name', 'age'],
+      }),
+    )
+    expect(stdout).to.equal(expected)
+  })
+
+  it('should use natural width of 80 if process.stdout.columns is 0', async () => {
+    const backupColumns = process.stdout.columns
+    process.stdout.columns = 0
+    const data = [
+      {name: 'Foo', age: '1'.repeat(100)},
+      {name: 'Bar', age: '2'.repeat(100)},
+    ]
+
+    const {stdout} = await captureOutput(async () =>
+      printTable({
+        data,
+        columns: ['name', 'age'],
+      }),
+    )
+    expect(stdout.length).to.equal(785)
+
+    process.stdout.columns = backupColumns
+  })
+
+  it('should respect the OCLIF_TABLE_COLUMN_OVERRIDE env var', async () => {
+    const backupColumns = process.stdout.columns
+    process.stdout.columns = 0
+    process.env.OCLIF_TABLE_COLUMN_OVERRIDE = '50'
+    const data = [
+      {name: 'Foo', age: '1'.repeat(100)},
+      {name: 'Bar', age: '2'.repeat(100)},
+    ]
+
+    const expected = `┌──────┬─────────────────────────────────────────┐
+│ name │ age                                     │
+├──────┼─────────────────────────────────────────┤
+│ Foo  │ 11111111111111111111111111111111111111… │
+├──────┼─────────────────────────────────────────┤
+│ Bar  │ 22222222222222222222222222222222222222… │
+└──────┴─────────────────────────────────────────┘
+
+`
+
+    const {stdout} = await captureOutput(async () =>
+      printTable({
+        data,
+        columns: ['name', 'age'],
+      }),
+    )
+    expect(stdout).to.equal(expected)
+
+    delete process.env.OCLIF_TABLE_COLUMN_OVERRIDE
+    process.stdout.columns = backupColumns
+  })
 })

test/util.test.ts

@@ -1,6 +1,6 @@
 import {config, expect} from 'chai'
 
-import {intersperse, sortData} from '../src/utils.js'
+import {getColumnWidth, intersperse, sortData} from '../src/utils.js'
 
 config.truncateThreshold = 0
 
@@ -64,3 +64,21 @@ describe('sortData', () => {
     expect(sortData(data, sort)).to.deep.equal(expected)
   })
 })
+
+describe('should get the correct column width', () => {
+  it('should return the value of OCLIF_TABLE_COLUMN_OVERRIDE', () => {
+    process.env.OCLIF_TABLE_COLUMN_OVERRIDE = '100'
+    expect(getColumnWidth()).to.equal(100)
+    delete process.env.OCLIF_TABLE_COLUMN_OVERRIDE
+  })
+
+  it('should return the value of process.stdout.columns', () => {
+    if (process.env.CI && !process.stdout.columns) {
+      // In GHA process.stdout.columns is undefined
+      expect(getColumnWidth()).to.equal(80)
+    } else {
+      const currentColumns = process.stdout.columns
+      expect(getColumnWidth()).to.equal(currentColumns)
+    }
+  })
+})