feat: add column wrapping to table format in cli

Signed-off-by: Tomás Migone <[email protected]>

Author: tmigone

packages/indexer-cli/package.json

@@ -38,7 +38,8 @@
     "graphql-tag": "2.12.6",
     "isomorphic-fetch": "3.0.0",
     "table": "6.7.5",
-    "yaml": "1.10.2"
+    "yaml": "1.10.2",
+    "wrap-ansi": "9.0.0"
   },
   "devDependencies": {
     "@types/isomorphic-fetch": "0.0.36",

packages/indexer-cli/src/command-helpers.ts

@@ -27,6 +27,7 @@
 // parameters array and returns the result of that.
 
 import { table, getBorderCharacters } from 'table'
+import wrapAnsi from 'wrap-ansi'
 
 export enum OutputFormat {
   Table = 'table',
@@ -99,47 +100,63 @@ export function pickFields(
     }
   }
   for (const key of drop) {
-    delete obj[key]
+    delete obj[key] 
   }
   return obj
 }
 
-export function displayObjectData(outputFormat: OutputFormat, data: object): string {
-  return outputFormat === OutputFormat.Json
-    ? JSON.stringify(data, null, 2)
-    : outputFormat === OutputFormat.Yaml
-    ? yaml.stringify(data).trim()
-    : table([Object.keys(data), Object.values(data)], {
-        border: getBorderCharacters('norc'),
-      }).trim()
+export function displayObjectData(outputFormat: OutputFormat, data: object, wrapWidth: number): string {
+  if (outputFormat === OutputFormat.Json) {
+    return JSON.stringify(data, null, 2)
+  } else if (outputFormat === OutputFormat.Yaml) {
+    return yaml.stringify(data).trim()
+  } else {
+    const keys = Object.keys(data)
+    const values = Object.values(data).map(value => wrapCell(value, wrapWidth))
+
+    return table([keys, values], {
+      border: getBorderCharacters('norc'),
+    }).trim()
+  }
 }
 
 export function displayObjectArrayData(
   outputFormat: OutputFormat,
   data: object[],
+  wrapWidth: number,
 ): string {
-  return outputFormat === OutputFormat.Json
-    ? JSON.stringify(data, null, 2)
-    : outputFormat === OutputFormat.Yaml
-    ? yaml.stringify(data).trim()
-    : data.length === 0
-    ? 'No items found'
-    : table([Object.keys(data[0]), ...data.map(item => Object.values(item))], {
-        border: getBorderCharacters('norc'),
-      }).trim()
+  if (outputFormat === OutputFormat.Json) {
+    return JSON.stringify(data, null, 2)
+  } else if (outputFormat === OutputFormat.Yaml) {
+    return yaml.stringify(data).trim()
+  } else if (data.length === 0) {
+    return 'No items found'
+  } else {
+    const keys = Object.keys(data[0])
+
+    const tableData = [
+      keys,
+      ...data.map(item => keys.map(key => wrapCell((item as any)[key], wrapWidth))),
+    ]
+
+    return table(tableData, {
+      border: getBorderCharacters('norc'),
+    }).trim()
+  }
 }
 
 export function printObjectOrArray(
   print: GluegunPrint,
   outputFormat: OutputFormat,
   data: object | object[],
   keys: string[],
+  wrapWidth: number = 0,
 ): void {
   if (Array.isArray(data)) {
     const formatted = data.map(item => pickFields(item, keys))
-    print.info(displayObjectArrayData(outputFormat, formatted))
+    print.info(displayObjectArrayData(outputFormat, formatted, wrapWidth))
   } else if (data) {
-    print.info(displayObjectData(outputFormat, pickFields(data, keys)))
+    print.info(displayObjectData(outputFormat, pickFields(data, keys), wrapWidth))
   } else {
     print.error(`No items returned`)
   }
@@ -251,3 +268,10 @@ export function requireProtocolNetworkOption(options: { [key: string]: any }): s
   }
   return protocolNetwork
 }
+
+
+export function wrapCell(value: unknown, wrapWidth: number): string {
+  return wrapWidth > 0
+    ? wrapAnsi(String(value), wrapWidth, { hard: true })
+    : String(value)
+}

yarn.lock

@@ -3289,7 +3289,7 @@ ansi-styles@^5.0.0:
   resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-5.2.0.tgz#07449690ad45777d1924ac2abb2fc8895dba836b"
   integrity sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==
 
-ansi-styles@^6.1.0:
+ansi-styles@^6.1.0, ansi-styles@^6.2.1:
   version "6.2.1"
   resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-6.2.1.tgz#0e62320cf99c21afff3b3012192546aacbfb05c5"
   integrity sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==
@@ -4951,6 +4951,11 @@ emittery@^0.13.1:
   resolved "https://registry.yarnpkg.com/emittery/-/emittery-0.13.1.tgz#c04b8c3457490e0847ae51fced3af52d338e3dad"
   integrity sha512-DeWwawk6r5yR9jFgnDKYt4sLS0LmHJJi3ZOnb5/JdbYwj3nW+FxQnHIjhBKz8YLC7oRNPVM9NQ47I3CVx34eqQ==
 
+emoji-regex@^10.3.0:
+  version "10.4.0"
+  resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-10.4.0.tgz#03553afea80b3975749cfcb36f776ca268e413d4"
+  integrity sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==
+
 emoji-regex@^8.0.0:
   version "8.0.0"
   resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37"
@@ -5894,6 +5899,11 @@ get-caller-file@^2.0.5:
   resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e"
   integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==
 
+get-east-asian-width@^1.0.0:
+  version "1.3.0"
+  resolved "https://registry.yarnpkg.com/get-east-asian-width/-/get-east-asian-width-1.3.0.tgz#21b4071ee58ed04ee0db653371b55b4299875389"
+  integrity sha512-vpeMIQKxczTD/0s2CdEWHcb0eeJe6TFjxb+J5xgX7hScxqrGuyjmv4c1D4A/gelKfyox0gJJwIHF+fLjeaM8kQ==
+
 get-intrinsic@^1.2.5, get-intrinsic@^1.2.6, get-intrinsic@^1.3.0:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/get-intrinsic/-/get-intrinsic-1.3.0.tgz#743f0e3b6964a93a5491ed1bffaae054d7f98d01"
@@ -10371,6 +10381,15 @@ string-width@^5.0.1, string-width@^5.1.2:
     emoji-regex "^9.2.2"
     strip-ansi "^7.0.1"
 
+string-width@^7.0.0:
+  version "7.2.0"
+  resolved "https://registry.yarnpkg.com/string-width/-/string-width-7.2.0.tgz#b5bb8e2165ce275d4d43476dd2700ad9091db6dc"
+  integrity sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==
+  dependencies:
+    emoji-regex "^10.3.0"
+    get-east-asian-width "^1.0.0"
+    strip-ansi "^7.1.0"
+
 string_decoder@^1.1.1:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.3.0.tgz#42f114594a46cf1a8e30b0a84f56c78c3edac21e"
@@ -10413,7 +10432,7 @@ strip-ansi@^6.0.0, strip-ansi@^6.0.1:
   dependencies:
     ansi-regex "^5.0.1"
 
-strip-ansi@^7.0.1:
+strip-ansi@^7.0.1, strip-ansi@^7.1.0:
   version "7.1.0"
   resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-7.1.0.tgz#d5b6568ca689d8561370b0707685d22434faff45"
   integrity sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==
@@ -11228,6 +11247,15 @@ workerpool@^6.5.1:
     string-width "^4.1.0"
     strip-ansi "^6.0.0"
 
+[email protected]:
+  version "9.0.0"
+  resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-9.0.0.tgz#1a3dc8b70d85eeb8398ddfb1e4a02cd186e58b3e"
+  integrity sha512-G8ura3S+3Z2G+mkgNRq8dqaFZAuxfsxpBB8OCTGRTCtp+l/v9nbFNmCUP1BZMts3G1142MsZfn6eeUKrr4PD1Q==
+  dependencies:
+    ansi-styles "^6.2.1"
+    string-width "^7.0.0"
+    strip-ansi "^7.1.0"
+
 wrap-ansi@^6.0.1:
   version "6.2.0"
   resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53"