feat(print): add style options for tables

docs/toolbox-print.md

@@ -193,3 +193,38 @@ Output:
 | Steve      | Kellock   | 43  |
 | Gary       | Busey     | 73  |
 ```
+
+You can also pass styles for the table (as specified in [cli-table3](https://github.com/cli-table/cli-table3)):
+
+```js
+const { table } = toolbox.print
+table(
+  [
+    ['First Name', 'Last Name', 'Age'],
+    ['Jamon', 'Holmgren', 35],
+    ['Gant', 'Laborde', 36],
+    ['Steve', 'Kellock', 43],
+    ['Gary', 'Busey', 73],
+  ],
+  {
+    format: 'lean',
+    style: { 'padding-left': 0 , 'padding-right': 8 }
+  },
+)
+```
+
+Output:
+
+```
+┌──────────────────┬─────────────────┬───────────┐
+│First Name        │Last Name        │Age        │
+├──────────────────┼─────────────────┼───────────┤
+│Jamon             │Holmgren         │35         │
+├──────────────────┼─────────────────┼───────────┤
+│Gant              │Laborde          │36         │
+├──────────────────┼─────────────────┼───────────┤
+│Steve             │Kellock          │43         │
+├──────────────────┼─────────────────┼───────────┤
+│Gary              │Busey            │73         │
+└──────────────────┴─────────────────┴───────────┘
+```

src/toolbox/__snapshots__/print-tools.test.ts.snap

@@ -73,5 +73,18 @@ Array [
 | matthew | 2 |",
     undefined,
   ],
+  Array [
+    "| liam        | 5     |
+| ----------- | ----- |
+| matthew     | 2     |",
+    undefined,
+  ],
+  Array [
+    "┌─────────┬───┐
+│ liam    │ 5 │
+│ matthew │ 2 │
+└─────────┴───┘",
+    undefined,
+  ],
 ]
 `;

src/toolbox/print-tools.test.ts

@@ -36,6 +36,20 @@ test('info', () => {
     ],
     { format: 'markdown' },
   )
+  print.table(
+    [
+      ['liam', '5'],
+      ['matthew', '2'],
+    ],
+    { format: 'markdown', style: { 'padding-left': 1, 'padding-right': 3 } },
+  )
+  print.table(
+    [
+      ['liam', '5'],
+      ['matthew', '2'],
+    ],
+    { format: 'lean', style: { compact: true } },
+  )
 
   expect(spyLogger).toMatchSnapshot()
 })

src/toolbox/print-tools.ts

@@ -3,7 +3,7 @@ import * as importedColors from 'colors/safe'
 import { commandInfo } from './meta-tools'
 import { Toolbox } from '../domain/toolbox'
 import { times } from './utils'
-import { GluegunPrint, GluegunPrintColors, GluegunPrintTableOptions } from './print-types'
+import { GluegunPrint, GluegunPrintColors, GluegunPrintTableOptions, TableStyle } from './print-types'
 
 // We're extending `colors` with a few more attributes
 const colors = importedColors as GluegunPrintColors
@@ -73,13 +73,30 @@ function findWidths(cliTable: CLITable): number[] {
 }
 
 /**
- * Returns an array of column dividers based on column widths.
+ * Returns an array of column dividers based on column widths, taking possible
+ * paddings into account.
  *
  * @param cliTable Data table.
  * @returns Array of properly sized column dividers.
  */
-function columnHeaderDivider(cliTable: CLITable): string[] {
-  return findWidths(cliTable).map(w => Array(w).join('-'))
+function columnHeaderDivider(cliTable: CLITable, style: TableStyle = {}): string[] {
+  const padding = (style['padding-left'] || 0) + (style['padding-right'] || 0)
+
+  return findWidths(cliTable).map(w => Array(w + padding).join('-'))
+}
+
+/**
+ * Resets the padding of a table.
+ *
+ * @param cliTable Data table.
+ */
+function resetTablePadding(cliTable: CLITable) {
+  const style = (cliTable as any).options.style
+
+  if (style) {
+    style['padding-left'] = 1
+    style['padding-right'] = 1
+  }
 }
 
 /**
@@ -97,17 +114,22 @@ function table(data: string[][], options: GluegunPrintTableOptions = {}): void {
       t = new CLITable({
         head: header,
         chars: CLI_TABLE_MARKDOWN,
+        style: options.style,
       })
       t.push(...data)
-      t.unshift(columnHeaderDivider(t))
+      t.unshift(columnHeaderDivider(t, options.style))
+      resetTablePadding(t)
       break
     case 'lean':
-      t = new CLITable()
+      t = new CLITable({
+        style: options.style,
+      })
       t.push(...data)
       break
     default:
       t = new CLITable({
         chars: CLI_TABLE_COMPACT,
+        style: options.style,
       })
       t.push(...data)
   }

src/toolbox/print-types.ts

@@ -14,8 +14,11 @@ export type GluegunPrintColors = typeof importedColors & {
   muted: (t: string) => string
 }
 
+export type TableStyle = Partial<CLITable.TableInstanceOptions['style']>
+
 export interface GluegunPrintTableOptions {
   format?: 'markdown' | 'lean' | 'default'
+  style?: TableStyle
 }
 
 export interface GluegunPrint {
@@ -46,7 +49,7 @@ export interface GluegunPrint {
   /* Finds the column widths for a table */
   findWidths: (cliTable: CLITable) => number[]
   /* Returns column header dividers for a table */
-  columnHeaderDivider: (cliTable: CLITable) => string[]
+  columnHeaderDivider: (cliTable: CLITable, style: TableStyle) => string[]
   /* Prints a newline. */
   newline: () => void
   /* Prints a table of data (usually a 2-dimensional array). */