refactor: use AnyJson for styledObject

Author: mdonnalley

src/ux/styledObject.ts

@@ -6,43 +6,42 @@
  */
 import { inspect } from 'node:util';
 import chalk from 'chalk';
+import { AnyJson } from '@salesforce/ts-types';
 
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-function pp(obj: any): any {
-  if (typeof obj === 'string' || typeof obj === 'number') return obj;
+function prettyPrint(obj: AnyJson): string {
+  if (!obj) return inspect(obj);
+  if (typeof obj === 'string') return obj;
+  if (typeof obj === 'number') return obj.toString();
+  if (typeof obj === 'boolean') return obj.toString();
   if (typeof obj === 'object') {
-    return (
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      Object.keys(obj)
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        .map((k) => k + ': ' + inspect(obj[k]))
-        .join(', ')
-    );
+    return Object.entries(obj)
+      .map(([key, value]) => `${key}: ${inspect(value)}`)
+      .join(', ');
   }
 
   return inspect(obj);
 }
 
-// @oclif/core v4 will have native support for coloring JSON so we won't need this then.
-export default function styledObject(obj: any, keys?: string[]): string {
+export default function styledObject(obj: AnyJson, keys?: string[]): string {
+  if (!obj) return inspect(obj);
+  if (typeof obj === 'string') return obj;
+  if (typeof obj === 'number') return obj.toString();
+  if (typeof obj === 'boolean') return obj.toString();
+
   const output: string[] = [];
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
   const keyLengths = Object.keys(obj).map((key) => key.toString().length);
   const maxKeyLength = Math.max(...keyLengths) + 2;
 
-  const logKeyValue = (key: string, value: any): string =>
-    `${chalk.blue(key)}:` + ' '.repeat(maxKeyLength - key.length - 1) + pp(value);
+  const logKeyValue = (key: string, value: AnyJson): string =>
+    `${chalk.blue(key)}:` + ' '.repeat(maxKeyLength - key.length - 1) + prettyPrint(value);
 
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-  for (const key of keys ?? Object.keys(obj).sort()) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
-    const value = obj[key];
+  for (const [key, value] of Object.entries(obj)) {
+    if (keys && !keys.includes(key)) continue;
     if (Array.isArray(value)) {
       if (value.length > 0) {
         output.push(logKeyValue(key, value[0]));
         for (const e of value.slice(1)) {
-          output.push(' '.repeat(maxKeyLength) + pp(e));
+          output.push(' '.repeat(maxKeyLength) + prettyPrint(e));
         }
       }
     } else if (value !== null && value !== undefined) {

test/unit/ux/object.test.ts

@@ -9,7 +9,27 @@ import stripAnsi from 'strip-ansi';
 import styledObject from '../../../src/ux/styledObject.js';
 
 describe('styledObject', () => {
-  it('should show a table', () => {
+  it('should handle simple object', () => {
+    const result = styledObject({ foo: 1, bar: 2 });
+    expect(stripAnsi(result)).to.equal('foo: 1\nbar: 2');
+  });
+
+  it('should handle object with select keys', () => {
+    const result = styledObject({ foo: 1, bar: 2 }, ['foo']);
+    expect(stripAnsi(result)).to.equal('foo: 1');
+  });
+
+  it('should handle deeply nested object', () => {
+    const result = styledObject({ foo: { bar: { baz: 1 } } });
+    expect(stripAnsi(result)).to.equal('foo: bar: { baz: 1 }');
+  });
+
+  it('should handle deeply nested objects with arrays', () => {
+    const result = styledObject({ foo: { bar: [{ baz: 1 }, { baz: 2 }] } });
+    expect(stripAnsi(result)).to.equal('foo: bar: [ { baz: 1 }, { baz: 2 } ]');
+  });
+
+  it('should show array input as table', () => {
     const result = styledObject([
       { foo: 1, bar: 1 },
       { foo: 2, bar: 2 },
@@ -19,4 +39,30 @@ describe('styledObject', () => {
 1: foo: 2, bar: 2
 2: foo: 3, bar: 3`);
   });
+
+  it('should handle nulls', () => {
+    const result = styledObject([{ foo: 1, bar: 1 }, null, { foo: 3, bar: 3 }]);
+    expect(stripAnsi(result)).to.equal(`0: foo: 1, bar: 1
+2: foo: 3, bar: 3`);
+  });
+
+  it('should handle null input', () => {
+    const result = styledObject(null);
+    expect(stripAnsi(result)).to.equal('null');
+  });
+
+  it('should handle string input', () => {
+    const result = styledObject('foo');
+    expect(stripAnsi(result)).to.equal('foo');
+  });
+
+  it('should handle number input', () => {
+    const result = styledObject(1);
+    expect(stripAnsi(result)).to.equal('1');
+  });
+
+  it('should handle boolean input', () => {
+    const result = styledObject(true);
+    expect(stripAnsi(result)).to.equal('true');
+  });
 });