-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtables.ts
More file actions
214 lines (191 loc) · 6.03 KB
/
tables.ts
File metadata and controls
214 lines (191 loc) · 6.03 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/**
* @fileoverview Table formatting utilities for CLI applications.
* Provides ASCII table rendering with borders, alignment, and colors.
*/
import colors from './external/yoctocolors-cjs'
import { stringWidth } from './strings'
import { ArrayPrototypePush, MathMax } from './primordials'
export type ColumnAlignment = 'left' | 'right' | 'center'
/**
* Table column configuration.
*/
export type TableColumn = {
key: string
header: string
align?: ColumnAlignment | undefined
width?: number | undefined
color?: ((value: string) => string) | undefined
}
/**
* Calculate display width accounting for ANSI codes, CJK, and emoji.
* Uses `stringWidth` so multi-cell glyphs (full-width CJK, emoji, combined
* code points) contribute their actual terminal column count to padding.
*/
function displayWidth(text: string): number {
return stringWidth(text)
}
/**
* Pad text to specified width with alignment.
*/
function padText(
text: string,
width: number,
align: ColumnAlignment = 'left',
): string {
const textWidth = displayWidth(text)
const padding = MathMax(0, width - textWidth)
switch (align) {
case 'right':
return ' '.repeat(padding) + text
case 'center': {
const leftPad = Math.floor(padding / 2)
const rightPad = padding - leftPad
return ' '.repeat(leftPad) + text + ' '.repeat(rightPad)
}
default:
return text + ' '.repeat(padding)
}
}
/**
* Format data as a simple table without borders.
* Lighter weight alternative to formatTable().
*
* @param data - Array of data objects
* @param columns - Column configuration
* @returns Formatted table string
*
* @example
* import { formatSimpleTable } from '@socketsecurity/lib/tables'
* import colors from 'yoctocolors-cjs'
*
* const data = [
* { name: 'lodash', version: '4.17.21' },
* { name: 'react', version: '18.2.0' },
* ]
* const columns = [
* { key: 'name', header: 'Package' },
* { key: 'version', header: 'Version' },
* ]
* console.log(formatSimpleTable(data, columns))
* // Output:
* // Package Version
* // ─────── ───────
* // lodash 4.17.21
* // react 18.2.0
*/
export function formatSimpleTable(
data: Array<Record<string, unknown>>,
columns: TableColumn[],
): string {
if (data.length === 0) {
return '(no data)'
}
// Calculate column widths
const widths = columns.map(col => {
const headerWidth = displayWidth(col.header)
const maxDataWidth = MathMax(
...data.map(row => displayWidth(String(row[col.key] ?? ''))),
)
return col.width ?? MathMax(headerWidth, maxDataWidth)
})
const lines: string[] = []
// Header row
const headerCells = columns.map((col, i) =>
padText(colors.bold(col.header), widths[i] as number, col.align),
)
ArrayPrototypePush(lines, headerCells.join(' '))
// Header separator
const separators = widths.map(w => colors.dim('─'.repeat(w)))
ArrayPrototypePush(lines, separators.join(' '))
// Data rows
for (const row of data) {
const cells = columns.map((col, i) => {
let value = String(row[col.key] ?? '')
if (col.color) {
value = col.color(value)
}
return padText(value, widths[i] as number, col.align)
})
ArrayPrototypePush(lines, cells.join(' '))
}
return lines.join('\n')
}
/**
* Format data as an ASCII table with borders.
*
* @param data - Array of data objects
* @param columns - Column configuration
* @returns Formatted table string
*
* @example
* import { formatTable } from '@socketsecurity/lib/tables'
* import colors from 'yoctocolors-cjs'
*
* const data = [
* { name: 'lodash', version: '4.17.21', issues: 0 },
* { name: 'react', version: '18.2.0', issues: 2 },
* ]
* const columns = [
* { key: 'name', header: 'Package' },
* { key: 'version', header: 'Version', align: 'center' },
* { key: 'issues', header: 'Issues', align: 'right', color: (v) => v === '0' ? colors.green(v) : colors.red(v) },
* ]
* console.log(formatTable(data, columns))
* // Output:
* // ┌─────────┬─────────┬────────┐
* // │ Package │ Version │ Issues │
* // ├─────────┼─────────┼────────┤
* // │ lodash │ 4.17.21 │ 0 │
* // │ react │ 18.2.0 │ 2 │
* // └─────────┴─────────┴────────┘
*/
export function formatTable(
data: Array<Record<string, unknown>>,
columns: TableColumn[],
): string {
if (data.length === 0) {
return '(no data)'
}
// Calculate column widths
const widths = columns.map(col => {
const headerWidth = displayWidth(col.header)
const maxDataWidth = MathMax(
...data.map(row => displayWidth(String(row[col.key] ?? ''))),
)
return col.width ?? MathMax(headerWidth, maxDataWidth)
})
const lines: string[] = []
// Top border
const topBorder = `┌─${widths.map(w => '─'.repeat(w)).join('─┬─')}─┐`
ArrayPrototypePush(lines, colors.dim(topBorder))
// Header row
const headerCells = columns.map((col, i) => {
const text = colors.bold(col.header)
return padText(text, widths[i] as number, col.align)
})
ArrayPrototypePush(
lines,
colors.dim('│ ') + headerCells.join(colors.dim(' │ ')) + colors.dim(' │'),
)
// Header separator
const headerSep = `├─${widths.map(w => '─'.repeat(w)).join('─┼─')}─┤`
ArrayPrototypePush(lines, colors.dim(headerSep))
// Data rows
for (const row of data) {
const cells = columns.map((col, i) => {
let value = String(row[col.key] ?? '')
if (col.color) {
value = col.color(value)
}
return padText(value, widths[i] as number, col.align)
})
ArrayPrototypePush(
lines,
colors.dim('│ ') + cells.join(colors.dim(' │ ')) + colors.dim(' │'),
)
}
// Bottom border
const bottomBorder = `└─${widths.map(w => '─'.repeat(w)).join('─┴─')}─┘`
ArrayPrototypePush(lines, colors.dim(bottomBorder))
return lines.join('\n')
}