refactor: table library, unify calls (#2525)

Synced from monorepo@15018a01e31f1ccc2e396783821f1dc09e6994ef

Author: divyenduz

.sync-commit

@@ -1 +1 @@
-785e18f56f0be8a283e43249f728cdaec27f3402
+15018a01e31f1ccc2e396783821f1dc09e6994ef

package.json

@@ -38,14 +38,14 @@
     "zod-config": "1.4.0",
     "@xata.io/ai": "0.1.0",
     "@xata.io/api": "0.1.0",
+    "@xata.io/lang": "0.0.1",
     "@xata.io/config": "0.0.0",
     "@xata.io/pgroll": "0.9.0",
     "@xata.io/pgstream": "0.2.0",
     "@xata.io/sql": "0.1.3",
     "@xata.io/test-utils": "0.0.0",
     "@xata.io/tsconfig": "0.0.1",
-    "@xata.io/utils": "0.1.0",
-    "@xata.io/lang": "0.0.1"
+    "@xata.io/utils": "0.1.0"
   },
   "scripts": {
     "dev": "bun src/bin/cli.ts",

src/commands/ai/terminal-ui.ts

@@ -1,8 +1,7 @@
 import chalk from 'chalk';
 import { stdin, stdout } from 'node:process';
 import stripAnsi from 'strip-ansi';
-import Table from 'cli-table3';
-import { borderlessTableOptions } from '~/lib/table';
+import { createTable } from '~/lib/table';
 
 interface TerminalUIProps {
   schema: any[];
@@ -154,11 +153,9 @@ export class TerminalUI {
       const firstResult = results[0];
       const headers = Object.keys(firstResult);
 
-      const table = new Table({
-        ...borderlessTableOptions,
+      const table = createTable({
         head: headers.map((h) => chalk.cyan(h)),
         style: {
-          ...borderlessTableOptions.style,
           head: ['cyan'],
           border: ['grey']
         }

src/commands/branch/metrics.ts

@@ -17,9 +17,9 @@ import {
   type BranchMetricsReport
 } from '@xata.io/utils';
 import chalk from 'chalk';
-import Table from 'cli-table3';
 import type { LocalContext } from '~/context';
 import { getErrorMessage } from '~/lib/cli-utils';
+import { renderTable } from '~/lib/table';
 
 type OutputFormat = 'table' | 'json' | 'ndjson' | 'tui';
 
@@ -229,14 +229,12 @@ async function watchMetrics(
 }
 
 function renderSummaryTable(report: BranchMetricsReport, aggregation: BranchMetricAggregation): string {
-  const table = new Table({
-    head: ['Metric', 'Instance', 'Agg', 'Latest', 'Min', 'Max', 'Avg', 'Unit', 'Status']
-  });
+  const rows: string[][] = [];
 
   for (const metric of report.metrics) {
     const series = metric.series.filter((s) => s.aggregation === aggregation);
     if (series.length === 0) {
-      table.push([
+      rows.push([
         metric.key,
         '',
         aggregation,
@@ -251,7 +249,7 @@ function renderSummaryTable(report: BranchMetricsReport, aggregation: BranchMetr
     }
 
     for (const serie of series) {
-      table.push([
+      rows.push([
         metric.key,
         serie.instanceName,
         serie.aggregation,
@@ -265,9 +263,11 @@ function renderSummaryTable(report: BranchMetricsReport, aggregation: BranchMetr
     }
   }
 
+  const table = renderTable(['Metric', 'Instance', 'Agg', 'Latest', 'Min', 'Max', 'Avg', 'Unit', 'Status'], rows);
+
   return `${chalk.bold(`Metrics for ${report.target.branchName} (${report.target.branchId})`)}\n${chalk.dim(
     `${report.timeRange.start} → ${report.timeRange.end}`
-  )}\n${table.toString()}\n`;
+  )}\n${table}\n`;
 }
 
 function renderDashboard(report: BranchMetricsReport, aggregation: BranchMetricAggregation): string {

src/commands/branch/metrics.unit.test.ts

@@ -105,6 +105,18 @@ describe('branch metrics command', () => {
     });
   });
 
+  test('prints branch metrics as a compact borderless table', async () => {
+    const { context, stdout, branchMetrics } = buildContext();
+
+    await implementation.call(context, { ...baseFlags, output: 'table' });
+
+    expect(branchMetrics).toHaveBeenCalledTimes(1);
+    const output = stdout.join('');
+    expect(output).toContain('Metrics for main (branch)');
+    expect(output).toContain('Metric');
+    expect(output).toContain('Primary');
+  });
+
   test('shows the expected timestamp format for invalid start and end times', async () => {
     const { context: startContext } = buildContext();
     await expect(implementation.call(startContext, { ...baseFlags, start: '10' })).rejects.toThrow(

src/lib/cli-utils.ts

@@ -1,5 +1,4 @@
 import chalk from 'chalk';
-import Table from 'cli-table3';
 import invariant from 'tiny-invariant';
 import { decodeJwt } from 'jose';
 import type { LocalContext } from '~/context';
@@ -9,7 +8,7 @@ import { config } from './config';
 import { DEFAULT_DATABASE_NAME } from './constants';
 import { getProfile } from './profile';
 import { projectConfig } from './project-config';
-import { borderlessTableOptions } from './table';
+import { renderTable } from './table';
 
 export const print = (
   context: LocalContext,
@@ -23,15 +22,9 @@ export const print = (
     return JSON.stringify(data, null, 2);
   }
 
-  const table = new Table({
-    ...borderlessTableOptions,
-    head: headers
-  });
-  rows.forEach((row) => {
-    table.push(row);
-  });
-  context.process.stdout.write(`${table.toString()}\n`);
-  return table.toString();
+  const table = renderTable(headers, rows);
+  context.process.stdout.write(`${table}\n`);
+  return table;
 };
 
 type BaseOptions = {

src/lib/cli-utils.unit.test.ts

@@ -1,6 +1,7 @@
 import { describe, expect, it } from 'bun:test';
 import stripAnsi from 'strip-ansi';
 import { getErrorMessage, groupAndSortRegions, print } from './cli-utils';
+import { renderTable } from './table';
 
 type Region = {
   id: string;
@@ -209,7 +210,24 @@ describe('print', () => {
     );
 
     expect(writes).toEqual([`${result}\n`]);
-    expect(stripAnsi(result)).not.toMatch(/[─│]/);
+    expect(normalizeTableOutput(result)).toEqual([
+      ['name', 'status'],
+      ['alpha', 'ready'],
+      ['beta', 'paused']
+    ]);
+  });
+});
+
+describe('renderTable', () => {
+  it('should render compact borderless tables', () => {
+    const result = renderTable(
+      ['name', 'status'],
+      [
+        ['alpha', 'ready'],
+        ['beta', 'paused']
+      ]
+    );
+
     expect(normalizeTableOutput(result)).toEqual([
       ['name', 'status'],
       ['alpha', 'ready'],

src/lib/table.ts

@@ -1,4 +1,8 @@
-export const borderlessTableOptions = {
+import Table from 'cli-table3';
+
+export type TableOptions = NonNullable<ConstructorParameters<typeof Table>[0]>;
+
+const defaultTableOptions = {
   chars: {
     top: '',
     'top-mid': '',
@@ -20,4 +24,32 @@ export const borderlessTableOptions = {
     'padding-left': 0,
     'padding-right': 0
   }
-};
+} satisfies TableOptions;
+
+export function createTable(options: TableOptions = {}) {
+  return new Table({
+    ...defaultTableOptions,
+    ...options,
+    chars: {
+      ...defaultTableOptions.chars,
+      ...options.chars
+    },
+    style: {
+      ...defaultTableOptions.style,
+      ...options.style
+    }
+  });
+}
+
+export function renderTable(headers: string[], rows: string[][], options: TableOptions = {}) {
+  const table = createTable({
+    ...options,
+    head: headers
+  });
+
+  rows.forEach((row) => {
+    table.push(row);
+  });
+
+  return table.toString();
+}