-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Calculcate column widths so that the table will not overflow the terminal anymore. Switch back to 'table' library which now has newline support and not the rendering bug that 'cli-table' had.
- Loading branch information
Showing
3 changed files
with
119 additions
and
47 deletions.
There are no files selected for viewing
111 changes: 111 additions & 0 deletions
111
packages/@aws-cdk/cloudformation-diff/lib/format-table.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| import colors = require('colors/safe'); | ||
| import stringWidth = require('string-width'); | ||
| import table = require('table'); | ||
|
|
||
| /** | ||
| * Render a two-dimensional array to a visually attractive table | ||
| * | ||
| * First row is considered the table header. | ||
| */ | ||
| export function formatTable(cells: string[][], columns: number | undefined): string { | ||
| return table.table(cells, { | ||
| border: TABLE_BORDER_CHARACTERS, | ||
| columns: buildColumnConfig(calculcateColumnWidths(cells, columns)), | ||
| drawHorizontalLine: (line) => { | ||
| // Numbering like this: [line 0] [header = row[0]] [line 1] [row 1] [line 2] [content 2] [line 3] | ||
| return (line < 2 || line === cells.length) || lineBetween(cells[line - 1], cells[line]); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Whether we should draw a line between two rows | ||
| * | ||
| * Draw horizontal line if 2nd column values are different. | ||
| */ | ||
| function lineBetween(rowA: string[], rowB: string[]) { | ||
| return rowA[1] !== rowB[1]; | ||
| } | ||
|
|
||
| function buildColumnConfig(widths: Array<number | undefined>): { [index: number]: table.ColumnConfig } { | ||
| const ret: { [index: number]: table.ColumnConfig } = {}; | ||
| widths.forEach((width, i) => { | ||
| ret[i] = { width, useWordWrap: true } as any; // 'useWordWrap' is not in @types/table | ||
| if (width === undefined) { | ||
| delete ret[i].width; | ||
| } | ||
| }); | ||
|
|
||
| return ret; | ||
| } | ||
|
|
||
| /** | ||
| * Calculate column widths given a terminal width | ||
| * | ||
| * We do this by calculating a fair share for every column. Extra width smaller | ||
| * than the fair share is evenly distributed over all columns that exceed their | ||
| * fair share. | ||
| */ | ||
| function calculcateColumnWidths(rows: string[][], terminalWidth: number | undefined): Array<number | undefined> { | ||
| // use 'string-width' to not count ANSI chars as actual character width | ||
| const columns = rows[0].map((_, i) => Math.max(...rows.map(row => stringWidth(row[i])))); | ||
|
|
||
| // If we have no terminal width, do nothing | ||
| if (terminalWidth === undefined) { return columns.map(_ => undefined); } | ||
|
|
||
| const contentWidth = terminalWidth - 2 - columns.length * 3; | ||
|
|
||
| // If we don't exceed the terminal width, do nothing | ||
| if (sum(columns) <= contentWidth) { return columns.map(_ => undefined); } | ||
|
|
||
| const fairShare = Math.min(contentWidth / columns.length); | ||
| const smallColumns = columns.filter(w => w < fairShare); | ||
|
|
||
| let distributableWidth = contentWidth - sum(smallColumns); | ||
| const fairDistributable = Math.floor(distributableWidth / (columns.length - smallColumns.length)); | ||
|
|
||
| const ret = new Array<number>(); | ||
| for (const requestedWidth of columns) { | ||
| if (requestedWidth < fairShare) { | ||
| // Small column gets what they want | ||
| ret.push(requestedWidth); | ||
| } else { | ||
| // Last column gets all remaining, otherwise get fair redist share | ||
| const width = distributableWidth < 2 * fairDistributable ? distributableWidth : fairDistributable; | ||
| ret.push(width); | ||
| distributableWidth -= width; | ||
| } | ||
| } | ||
|
|
||
| return ret; | ||
| } | ||
|
|
||
| function sum(xs: number[]): number { | ||
| let total = 0; | ||
| for (const x of xs) { | ||
| total += x; | ||
| } | ||
| return total; | ||
| } | ||
|
|
||
| // What color the table is going to be | ||
| const tableColor = colors.gray; | ||
|
|
||
| // Unicode table characters with a color | ||
| const TABLE_BORDER_CHARACTERS = { | ||
| topBody: tableColor('─'), | ||
| topJoin: tableColor('┬'), | ||
| topLeft: tableColor('┌'), | ||
| topRight: tableColor('┐'), | ||
| bottomBody: tableColor('─'), | ||
| bottomJoin: tableColor('┴'), | ||
| bottomLeft: tableColor('└'), | ||
| bottomRight: tableColor('┘'), | ||
| bodyLeft: tableColor('│'), | ||
| bodyRight: tableColor('│'), | ||
| bodyJoin: tableColor('│'), | ||
| joinBody: tableColor('─'), | ||
| joinLeft: tableColor('├'), | ||
| joinRight: tableColor('┤'), | ||
| joinJoin: tableColor('┼') | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters