🗞️ Adding in Default Colors to print outs (#381)

.changeset/empty-lamps-marry.md

@@ -0,0 +1,7 @@
+---
+"@layerzerolabs/ua-devtools-evm-hardhat-test": patch
+"@layerzerolabs/ua-devtools-evm-hardhat": patch
+"@layerzerolabs/io-devtools": patch
+---
+
+Adding in Default Colors to print outs

packages/io-devtools/package.json

@@ -37,6 +37,7 @@
     "test": "jest --ci"
   },
   "dependencies": {
+    "chalk": "^4.1.2",
     "cli-table3": "^0.6.3",
     "logform": "^2.6.0",
     "prompts": "^2.4.2",

packages/io-devtools/src/stdio/printer.ts

@@ -1,6 +1,16 @@
-import Table, { HorizontalTableRow } from 'cli-table3'
+import Table, { HorizontalAlignment, HorizontalTableRow } from 'cli-table3'
+import chalk from 'chalk'
 import type { ZodError } from 'zod'
 
+type Preprocess = (value: string) => string
+export const COLORS = {
+    TRUE: chalk.rgb(0, 153, 0), // GREEN
+    FALSE: chalk.rgb(255, 0, 0), // RED
+    NOT_APPLICABLE: chalk.rgb(255, 128, 0), // ORANGE
+    DEFAULT_KEY: chalk.rgb(255, 255, 255), // WHITE
+    DEFAULT_VALUE: chalk.rgb(167, 125, 255), // MAGENTA
+}
+
 /**
  * Returns a JSON-serialized version of a string, replacing all `BigInt`
  * instances with strings
@@ -29,28 +39,41 @@ export const printJson = (obj: unknown, pretty = true): string =>
  * @see {@link printRecord}
  *
  * @param value
+ * @param keyColor - color of keys in table (DEFAULT: WHITE)
+ * @param valueColor - color of values in table (DEFAULT: MAGENTA)
  * @returns
  */
-const printValue = (value: unknown): string => {
+const printValue = (
+    value: unknown,
+    keyColor: Preprocess = COLORS.DEFAULT_KEY,
+    valueColor: Preprocess = COLORS.DEFAULT_VALUE
+): string => {
     switch (true) {
         case value == null:
         case value instanceof Date:
         case typeof value !== 'object':
-            return String(value)
+            return valueColor(String(value))
 
         default:
-            return printRecord(value)
+            return printRecord(value, undefined, keyColor, valueColor)
     }
 }
 
-export const printRecord = <TRecord extends object>(obj: TRecord, title?: string | number): string => {
+export const printRecord = <TRecord extends object>(
+    obj: TRecord,
+    title?: string | number,
+    keyColor: Preprocess = COLORS.DEFAULT_KEY,
+    valueColor: Preprocess = COLORS.DEFAULT_VALUE
+): string => {
     const table = new Table({
         wordWrap: true,
         wrapOnWordBoundary: false,
     })
 
     const headers: HorizontalTableRow[] = title == null ? [] : [[{ content: title, colSpan: 2 }]]
-    const rows = Object.entries(obj).map(([key, value]): HorizontalTableRow => [key, printValue(value)])
+    const rows = Object.entries(obj).map(
+        ([key, value]): HorizontalTableRow => [keyColor(key), printValue(value, keyColor, valueColor)]
+    )
 
     return table.push(...headers, ...rows), table.toString()
 }
@@ -63,20 +86,30 @@ export const printRecord = <TRecord extends object>(obj: TRecord, title?: string
  * the property name.
  *
  * @param {Record<string | number, unknown>} records
- * @param {string[]} [header]
+ * @param {string[]} [headers] - header row if provided
+ * @param {boolean} [center] - center text if true
+ * @param {Preprocess} [keyColor=COLORS.DEFAULT_KEY] keyColor - color of keys in table
+ * @param {Preprocess} [valueColor=COLORS.DEFAULT_VALUE] valueColor - color of values in table
  * @returns {string}
  */
 export const printCrossTable = <TRecord extends Record<string | number, unknown>>(
     records: TRecord[],
-    header?: string[]
+    headers?: string[],
+    center?: boolean,
+    keyColor: Preprocess = COLORS.DEFAULT_KEY,
+    valueColor: Preprocess = COLORS.DEFAULT_VALUE
 ): string => {
     const table = new Table({
-        head: header ?? [],
         wordWrap: true,
         wrapOnWordBoundary: false,
-        style: { head: ['reset'] },
     })
 
+    // Set the colored headers if provided
+    const coloredHeaders = headers?.map((header) => keyColor(header)) ?? []
+    table.push(coloredHeaders)
+
+    table.options.colAligns = center ? (['left', ...records.map(() => 'center')] as HorizontalAlignment[]) : []
+
     // We'll gather all the properties of all the records in this array
     //
     // We do this in case some of the objects were missing any properties -
@@ -94,10 +127,10 @@ export const printCrossTable = <TRecord extends Record<string | number, unknown>
         propertiesLeft.delete(property)
 
         // Get all the values and print them
-        const values = records.map((record) => record[property]).map(printValue)
+        const values = records.map((record) => printValue(record[property], keyColor, valueColor))
 
         // Create a row with the property label first
-        const row = [property, ...values]
+        const row = [keyColor(property), ...values]
 
         // And add to the table
         table.push(row)
@@ -110,9 +143,17 @@ export const printCrossTable = <TRecord extends Record<string | number, unknown>
  * Helper utility for printing out boolean values
  *
  * @param {boolean | null | undefined} value
+ * @param {Preprocess} [nullColor=COLORS.NOT_APPLICABLE] nullColor
+ * @param {Preprocess} [trueColor=COLORS.TRUE] trueColor
+ * @param {Preprocess} [falseColor=COLORS.FALSE] falseColor
  * @returns {string}
  */
-export const printBoolean = (value: boolean | null | undefined): string => (value == null ? '∅' : value ? '✓' : '⤫')
+export const printBoolean = (
+    value: boolean | null | undefined,
+    nullColor: Preprocess = COLORS.NOT_APPLICABLE,
+    trueColor: Preprocess = COLORS.TRUE,
+    falseColor: Preprocess = COLORS.FALSE
+): string => (value == null ? nullColor('∅') : value ? trueColor('✓') : falseColor('⤫'))
 
 export const printZodErrors = (error: ZodError<unknown>): string => {
     // Here we will go through all the errors and prefix them with the name

packages/ua-devtools-evm-hardhat/src/tasks/oapp/peers.get.ts

@@ -67,11 +67,11 @@ const action: ActionType<TaskArgs> = async ({ oappConfig: oappConfigPath, logLev
         })
 
         console.log(
-            printCrossTable(peerNetworkMatrix, ['from → to', ...points.map(({ networkName }) => networkName)]),
-            `\n\t${printBoolean(true)} - Connected\n`,
-            `\t${printBoolean(false)} - Not Connected\n`,
-            `\t${printBoolean(undefined)} - Ignored`
+            printCrossTable(peerNetworkMatrix, ['from → to', ...points.map(({ networkName }) => networkName)], true)
         )
+        console.log(` ${printBoolean(true)} - Connected`)
+        console.log(` ${printBoolean(false)} - Not Connected`)
+        console.log(` ${printBoolean(undefined)} - Ignored`)
 
         return peers
     } catch (error) {