feat(utxo-bin): add formatObjAsTree helper

Adds a utility function that creates a formatted tree output from any arbitrary
object by first parsing it and then applying the regular tree formatter.

Issue: BTC-2170

Co-authored-by: llm-git <[email protected]>

Author: OttoAllmendinger

modules/utxo-bin/src/format.ts

@@ -1,17 +1,30 @@
 import { Chalk, Instance } from 'chalk';
 import archy from 'archy';
 
-import { ParserNode, ParserNodeValue } from './Parser';
+import { Parser, ParserNode, ParserNodeValue } from './Parser';
+import { parseUnknown } from './parseUnknown';
 
 const hideDefault = ['pubkeys', 'sequence', 'locktime', 'scriptSig', 'witness'];
 
 export function formatSat(v: number | bigint): string {
   return (Number(v) / 1e8).toFixed(8);
 }
 
+type FormatOptions = {
+  hide?: string[];
+  chalk?: Chalk;
+};
+
+function getDefaultChalk(): Chalk {
+  if (process.env.NO_COLOR) {
+    return new Instance({ level: 0 });
+  }
+  return new Instance();
+}
+
 export function formatTree(
   n: ParserNode,
-  { hide = hideDefault, chalk = new Instance() }: { hide?: string[]; chalk?: Chalk } = {}
+  { hide = hideDefault, chalk = getDefaultChalk() }: FormatOptions = {}
 ): string {
   function getLabel(
     label: string | number,
@@ -61,3 +74,13 @@ export function formatTree(
 
   return archy(toArchy(n));
 }
+
+export function formatObjAsTree(
+  label: string | number,
+  obj: unknown,
+  { hide = hideDefault, chalk = getDefaultChalk() }: FormatOptions = {}
+): string {
+  const p = new Parser({ parseError: 'continue' });
+  const node = parseUnknown(p, label, obj, { omit: hide });
+  return formatTree(node, { hide, chalk });
+}