feat: copy oclif/core ux methods

[mdonnalley]

@oclif/core is slimming down the ux module: oclif/core#1056

As a result, we're going to copy over the functionality that sf-plugins-core relies on. Specifically:

• styledObject
• styledJSON
• table
• url
• progress

This serves two purposes:

• easier upgrade path for sf-plugins-core to update the new major of oclif/core
• we can delay switching to new libraries for this functionality since that will have customer impact (i.e. tables look different, etc.)

@W-15470636@

[mshanemc]

approved (seems like goal is lift + shift, no breaking changes).

It's worth a bit of github searching to see if anyone's ever used some of the table features mentioned. If not, maybe we can drop some complexity.

[mshanemc]

intentionally using || for falsy 0 ?

[mdonnalley]

Number.parseInt(undefined, 10) equals NaN and NaN ?? true returns NaN so we need ||

❯ node
Welcome to Node.js v20.11.0.
Type ".help" for more information.
> Number.parseInt(undefined, 10)
NaN
> NaN ?? true
NaN
> NaN || true
true

[mshanemc]

Suggested change

	let numOfLines = 1;
	for (const col of columns) {
	const d = row[col.key] as string;
	const lines = d.split('\n').length;
	if (lines > numOfLines) numOfLines = lines;
	}
	const numOfLines = Math.max(1, ...columns.map((c) => (row[c.key] as string).split('\n').length));

[mshanemc]

checking the type first instead of relying on ! and NaN's behavior is clearer

Suggested change

	const stdtermwidth = Number.parseInt(process.env.OCLIF_COLUMNS!, 10) || termwidth(process.stdout);
	const stdtermwidth =
	typeof process.env.OCLIF_COLUMNS === 'string' ? Number.parseInt(process.env.OCLIF_COLUMNS, 10) : termwidth(process.stdout);

[mshanemc]

QA:

✅ used existing table from plugin-marketplace
✅ this.url on each pluigin's homepage
✅ this.url doesn't print in --json mode
✅ use each of StndardColors and see how they look

📓 passing no data to this.table will print headers/horizontal lines only. If we did want smarter default behaviors for table, this might be a good time since it only affects sf plugins. Or maybe we could do it anytime since it's human-only UI and we have a good policy around that

✅ styled object with a flat object gives a nice table of key/value output

name:        sfdx-git-delta
description: Generate the sfdx content in source format and destructive change from two git commits
homepage:    https://github.com/scolladon/sfdx-git-delta#readme
downloads:   63935
published:   2024-05-16

❓ styledObject for an array of objects...does that look right? Or is it not meant to take arrays?

[mdonnalley]

❓ styledObject for an array of objects...does that look right? Or is it not meant to take arrays?

Yes, I think that's right. Here's the old oclif/core version:

ux.styledObject([
  {description: 'foo description', name: 'foo', value: 'foo'},
  {description: 'foo description', name: 'bar', value: 'bar'},
])

0: description: 'foo description', name: 'foo', value: 'foo'
1: description: 'foo description', name: 'bar', value: 'bar'

[mshanemc]

table QA

✅ sort works
📓 I can't see any impact from OCLIF_COLUMNS 🤷🏻
✅ title shows, adds all the ugly ASCII characters
✅ no-header works
✅ extended columns only show up when extended is true