feat: include a --no-wrap flag for table displays (#3613)

* Include a --no-wrap flag for table displays

* feat: use shared no-wrap flag and table helper

Made-with: Cursor

* fix: use valid color exports in log colorize

Made-with: Cursor

* fix(addons): flatten add-on cell for --no-wrap

Made-with: Cursor

Author: heroku-johnny

src/commands/addons/index.ts

@@ -5,6 +5,7 @@ import {ux} from '@oclif/core/ux'
 import _ from 'lodash'
 
 import {formatPrice, formatState, grandfatheredPrice} from '../../lib/addons/util.js'
+import {huxTableNoWrapOptions} from '../../lib/utils/tableUtils.js'
 
 const topic = 'addons'
 
@@ -25,6 +26,7 @@ export default class Addons extends Command {
     all: flags.boolean({char: 'A', description: 'show add-ons and attachments for all accessible apps'}),
     app: flags.app(),
     json: flags.boolean({description: 'return add-ons in json format'}),
+    'no-wrap': flags.noWrap(),
     remote: flags.remote(),
   }
 
@@ -41,13 +43,13 @@ export default class Addons extends Command {
       if (json)
         displayJSON(addons)
       else
-        displayForApp(app, addons)
+        displayForApp(app, addons, flags['no-wrap'])
     } else {
       const addons = await addonGetter(this.heroku)
       if (json)
         displayJSON(addons)
       else
-        displayAll(addons)
+        displayAll(addons, flags['no-wrap'])
     }
   }
 }
@@ -125,7 +127,7 @@ async function addonGetter(api: APIClient, app?: string) {
   return addons
 }
 
-function displayAll(addons: Heroku.AddOn[]) {
+function displayAll(addons: Heroku.AddOn[], noWrap = false) {
   addons = _.sortBy(addons, 'app.name', 'plan.name', 'addon.name')
   if (addons.length === 0) {
     ux.stdout('No add-ons.')
@@ -187,14 +189,12 @@ function displayAll(addons: Heroku.AddOn[]) {
         },
       },
     },
-    {
-      overflow: 'wrap',
-    },
+    huxTableNoWrapOptions(noWrap),
   )
   /* eslint-enable perfectionist/sort-objects */
 }
 
-function displayForApp(app: string, addons: Heroku.AddOn[]) {
+function displayForApp(app: string, addons: Heroku.AddOn[], noWrap = false) {
   if (addons.length === 0) {
     ux.stdout(`No add-ons for app ${app}.`)
     return
@@ -210,13 +210,16 @@ function displayForApp(app: string, addons: Heroku.AddOn[]) {
 
     const addonLine = `${service} (${name})`
     const atts = _.sortBy(addon.attachments, isForeignApp, 'app.name', 'name')
-    // render each attachment under the add-on
     const attLines = atts.map((attachment, idx) => {
       const isLast = (idx === addon.attachments.length - 1)
       return renderAttachment(attachment, app, isLast)
     })
-    return [addonLine].concat(attLines)
-      .join('\n') + '\n' // Separate each add-on row by a blank line
+    const lines = [addonLine, ...attLines]
+    if (noWrap) {
+      return lines.join('  ')
+    }
+
+    return `${lines.join('\n')}\n`
   }
 
   addons = _.sortBy(addons, isForeignApp, 'plan.name', 'name')
@@ -253,9 +256,7 @@ function displayForApp(app: string, addons: Heroku.AddOn[]) {
         get: ({state}) => formatState(state || ''),
       },
     },
-    {
-      overflow: 'wrap',
-    },
+    huxTableNoWrapOptions(noWrap),
   )
   ux.stdout(`The table above shows add-ons and the attachments to the current app (${color.app(app)}) or other apps.\n  `)
 }

src/commands/data/pg/credentials/index.ts

@@ -8,6 +8,7 @@ import type {CredentialInfo, CredentialsInfo} from '../../../../lib/data/types.j
 import BaseCommand from '../../../../lib/data/baseCommand.js'
 import {sortByOwnerAndName} from '../../../../lib/data/credentialUtils.js'
 import {presentCredentialAttachments} from '../../../../lib/pg/util.js'
+import {huxTableNoWrapOptions} from '../../../../lib/utils/tableUtils.js'
 
 export default class DataPgCredentialsIndex extends BaseCommand {
   static args = {
@@ -25,6 +26,7 @@ export default class DataPgCredentialsIndex extends BaseCommand {
 
   static flags = {
     app: Flags.app({required: true}),
+    'no-wrap': Flags.noWrap(),
     remote: Flags.remote(),
   }
 
@@ -74,8 +76,6 @@ export default class DataPgCredentialsIndex extends BaseCommand {
       State: {
         get: cred => cred.state,
       },
-    }, {
-      overflow: 'wrap',
-    })
+    }, huxTableNoWrapOptions(flags['no-wrap']))
   }
 }

src/commands/domains/index.ts

@@ -7,6 +7,7 @@ import Uri from 'urijs'
 
 import parseKeyValue from '../../lib/utils/keyValueParser.js'
 import {paginateRequest} from '../../lib/utils/paginator.js'
+import {huxTableNoWrapOptions} from '../../lib/utils/tableUtils.js'
 
 export default class DomainsIndex extends Command {
   static description = 'list domains for an app'
@@ -30,6 +31,7 @@ www.example.com  CNAME            www.example.herokudns.com`]
     extended: flags.boolean({char: 'x', description: 'show extra columns'}),
     filter: flags.string({description: 'filter property by partial string matching, ex: name=foo'}),
     json: flags.boolean({char: 'j', description: 'output in json format'}),
+    'no-wrap': flags.noWrap(),
     remote: flags.remote(),
     sort: flags.string({description: 'sort by property'}),
   }
@@ -215,7 +217,7 @@ www.example.com  CNAME            www.example.herokudns.com`]
           this.outputCSV(customDomains, tableConfig, sortProperty)
         } else {
           hux.table(customDomains, tableConfig, {
-            overflow: 'wrap',
+            ...huxTableNoWrapOptions(flags['no-wrap']),
             sort: flags.sort ? {[sortProperty]: 'asc'} : undefined,
           })
         }

src/commands/pg/credentials.ts

@@ -6,6 +6,7 @@ import {Args} from '@oclif/core'
 import type {NonAdvancedCredentialInfo} from '../../lib/data/types.js'
 
 import {presentCredentialAttachments} from '../../lib/pg/util.js'
+import {huxTableNoWrapOptions} from '../../lib/utils/tableUtils.js'
 import {nls} from '../../nls.js'
 
 export default class Credentials extends Command {
@@ -16,6 +17,7 @@ export default class Credentials extends Command {
   static description = 'show information on credentials in the database'
   static flags = {
     app: flags.app({required: true}),
+    'no-wrap': flags.noWrap(),
     remote: flags.remote(),
   }
 
@@ -62,9 +64,7 @@ export default class Credentials extends Command {
       State: {
         get: cred => cred.state,
       },
-    }, {
-      overflow: 'wrap',
-    })
+    }, huxTableNoWrapOptions(flags['no-wrap']))
   }
 
   protected sortByDefaultAndName(credentials: NonAdvancedCredentialInfo[]) {

src/commands/ps/index.ts

@@ -8,6 +8,7 @@ import {AccountQuota} from '../../lib/types/account_quota.js'
 import {AppProcessTier} from '../../lib/types/app_process_tier.js'
 import {DynoExtended} from '../../lib/types/dyno_extended.js'
 import {Account} from '../../lib/types/fir.js'
+import {huxTableNoWrapOptions} from '../../lib/utils/tableUtils.js'
 
 const heredoc = tsheredoc.default
 
@@ -29,6 +30,7 @@ export default class Index extends Command {
     app: flags.app({required: true}),
     extended: flags.boolean({char: 'x', hidden: true}), // only works with sudo privileges
     json: flags.boolean({description: 'display as json'}),
+    'no-wrap': flags.noWrap(),
     remote: flags.remote(),
   }
 
@@ -79,7 +81,7 @@ export default class Index extends Command {
     if (json)
       hux.styledJSON(selectedDynos)
     else if (extended)
-      printExtended(selectedDynos)
+      printExtended(selectedDynos, flags['no-wrap'])
     else {
       await printAccountQuota(this.heroku, appInfo, accountInfo)
       if (selectedDynos.length === 0)
@@ -207,7 +209,7 @@ function printDynos(dynos: DynoExtended[]) : void {
   })
 }
 
-function printExtended(dynos: DynoExtended[]) {
+function printExtended(dynos: DynoExtended[], noWrap = false) {
   const sortedDynos = dynos.sort(byProcessTypeAndNumber)
 
   /* eslint-disable perfectionist/sort-objects */
@@ -229,9 +231,7 @@ function printExtended(dynos: DynoExtended[]) {
       Route: {get: (dyno: DynoExtended) => dyno.extended?.route ?? ''},
       Size: {get: (dyno: DynoExtended) => dyno.size},
     },
-    {
-      overflow: 'wrap',
-    },
+    huxTableNoWrapOptions(noWrap),
   )
   /* eslint-enable perfectionist/sort-objects */
 }

src/lib/run/colorize.ts

@@ -7,11 +7,11 @@ export const COLORS: Array<(s: string) => string> = [
   s => color.cyan(s),
   s => color.magenta(s),
   s => color.blue(s),
-  s => color.teal(s),
-  s => color.pink(s),
-  s => color.gold(s),
-  s => color.purple(s),
-  s => color.orange(s),
+  s => color.info(s),
+  s => color.name(s),
+  s => color.addon(s),
+  s => color.pipeline(s),
+  s => color.warning(s),
 ]
 const assignedColors: any = {}
 let isInitialized = false

src/lib/utils/tableUtils.ts

@@ -2,6 +2,16 @@ import {ux} from '@oclif/core/ux'
 
 import parseKeyValue from './keyValueParser.js'
 
+export function huxTableNoWrapOptions(noWrap: boolean): {
+  maxWidth: 'none' | undefined
+  overflow: 'truncate' | 'wrap'
+} {
+  return {
+    maxWidth: noWrap ? 'none' : undefined,
+    overflow: noWrap ? 'truncate' : 'wrap',
+  }
+}
+
 export const constructSortFilterTableOptions = (flags: Record<string, string>, tableColumns: Record<string, any>) => {
   const {filter, sort} = flags
   const columnNames = new Set(Object.keys(tableColumns).map(key => key.toLowerCase()))

test/unit/commands/addons/index.unit.test.ts

@@ -1,7 +1,9 @@
 /* eslint-disable max-nested-callbacks */
 import * as Heroku from '@heroku-cli/schema'
 import {expect} from 'chai'
+import {hux} from '@heroku/heroku-cli-util'
 import nock from 'nock'
+import sinon from 'sinon'
 
 import Cmd from '../../../../src/commands/addons/index.js'
 import * as fixtures from '../../../fixtures/addons/fixtures.js'
@@ -24,6 +26,7 @@ describe('addons', function () {
   afterEach(function () {
     api.done()
     nock.cleanAll()
+    sinon.restore()
   })
 
   describe('--all', function () {
@@ -59,6 +62,14 @@ describe('addons', function () {
         expect(stdout.indexOf('acme-inc-api')).to.be.lt(stdout.indexOf('acme-inc-www'))
         expect(stdout.indexOf('www-db')).to.be.lt(stdout.indexOf('www-redis'))
       })
+      it('passes no-wrap option through to table rendering', async function () {
+        const tableStub = sinon.stub(hux, 'table')
+
+        await runCommand(Cmd, ['--all', '--no-wrap'])
+
+        const callArgs = tableStub.firstCall.args
+        expect(callArgs[2]).to.include({maxWidth: 'none', overflow: 'truncate'})
+      })
       context('--json', function () {
         it('prints the output in json format', async function () {
           const {stdout} = await runCommand(Cmd, [

test/unit/commands/data/pg/credentials/index.unit.test.ts

@@ -1,6 +1,8 @@
 import ansis from 'ansis'
 import {expect} from 'chai'
+import {hux} from '@heroku/heroku-cli-util'
 import nock from 'nock'
+import sinon from 'sinon'
 import {stdout} from 'stdout-stderr'
 import tsheredoc from 'tsheredoc'
 
@@ -18,6 +20,10 @@ import removeAllWhitespace from '../../../../../helpers/utils/remove-whitespaces
 const heredoc = tsheredoc.default
 
 describe('data:pg:credentials:index', function () {
+  afterEach(function () {
+    sinon.restore()
+  })
+
   it('shows error for non-advanced databases', async function () {
     const herokuApi = nock('https://api.heroku.com')
       .post('/actions/addons/resolve')
@@ -97,4 +103,25 @@ describe('data:pg:credentials:index', function () {
     herokuApi.done()
     dataApi.done()
   })
+
+  it('passes no-wrap option through to table rendering', async function () {
+    const herokuApi = nock('https://api.heroku.com')
+      .post('/actions/addons/resolve')
+      .reply(200, [addon])
+      .get(`/addons/${addon.id}/addon-attachments`)
+      .reply(200, advancedCredentialsAttachmentsResponse)
+
+    const dataApi = nock('https://api.data.heroku.com')
+      .get(`/data/postgres/v1/${addon.id}/credentials`)
+      .reply(200, advancedCredentialsResponse)
+
+    const tableStub = sinon.stub(hux, 'table')
+    await runCommand(DataPgCredentialsIndex, ['DATABASE', '--app=myapp', '--no-wrap'])
+
+    const callArgs = tableStub.firstCall.args
+    expect(callArgs[2]).to.include({maxWidth: 'none', overflow: 'truncate'})
+
+    herokuApi.done()
+    dataApi.done()
+  })
 })

test/unit/commands/domains/index.unit.test.ts

@@ -2,6 +2,7 @@ import {expect} from 'chai'
 import nock from 'nock'
 import sinon from 'sinon'
 import {stderr, stdout} from 'stdout-stderr'
+import {hux} from '@heroku/heroku-cli-util'
 
 import DomainsIndex from '../../../../src/commands/domains/index.js'
 import {runCommand} from '../../../helpers/run-command.js'
@@ -195,4 +196,17 @@ describe('domains', function () {
       'Warning: This app has over 100 domains. Your terminal may not be configured to display the total amount of domains.',
     )
   })
+
+  it('passes no-wrap option through to table rendering', async function () {
+    api.get('/apps/myapp/domains').reply(200, herokuAndCustomDomainsResponse)
+    const tableStub = sinon.stub(hux, 'table')
+
+    await runCommand(DomainsIndex, ['--app', 'myapp', '--no-wrap'])
+
+    expect(tableStub.calledOnce).to.equal(true)
+    const callArgs = tableStub.firstCall.args
+    expect(callArgs[2]).to.include({maxWidth: 'none', overflow: 'truncate'})
+
+    tableStub.restore()
+  })
 })