tty-table 5.0.0 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +38 -228
- package/adapters/automattic-cli-table.js +1 -1
- package/adapters/default-adapter.js +1 -1
- package/adapters/terminal-adapter.js +3 -2
- package/dist/browser/tty-table.global.js +4411 -0
- package/dist/browser/tty-table.global.js.map +1 -0
- package/dist/browser-BC4npgub.d.mts +128 -0
- package/dist/browser-BC4npgub.d.ts +128 -0
- package/dist/browser.d.mts +1 -0
- package/dist/browser.d.ts +1 -0
- package/dist/browser.js +1020 -0
- package/dist/browser.js.map +1 -0
- package/dist/browser.mjs +1016 -0
- package/dist/browser.mjs.map +1 -0
- package/dist/cli.d.mts +1 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +1113 -0
- package/dist/cli.js.map +1 -0
- package/dist/cli.mjs +1118 -0
- package/dist/cli.mjs.map +1 -0
- package/dist/index.d.mts +6 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +1020 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +1016 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +38 -59
- package/src/defaults.js +0 -70
- package/src/factory.d.ts +0 -67
- package/src/factory.js +0 -137
- package/src/format.js +0 -282
- package/src/main.js +0 -8
- package/src/render.js +0 -411
- package/src/style.js +0 -62
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
interface Formatter$1 {
|
|
2
|
+
(cellValue: any, columnIndex: number, rowIndex: number, rowData: any, inputData: any): string;
|
|
3
|
+
}
|
|
4
|
+
interface Header {
|
|
5
|
+
alias?: string;
|
|
6
|
+
align?: string;
|
|
7
|
+
color?: string;
|
|
8
|
+
footerAlign?: string;
|
|
9
|
+
footerColor?: string;
|
|
10
|
+
formatter?: Formatter$1;
|
|
11
|
+
headerAlign?: string;
|
|
12
|
+
headerColor?: string;
|
|
13
|
+
marginLeft?: number;
|
|
14
|
+
marginTop?: number;
|
|
15
|
+
paddingBottom?: number;
|
|
16
|
+
paddingLeft?: number;
|
|
17
|
+
paddingRight?: number;
|
|
18
|
+
paddingTop?: number;
|
|
19
|
+
value: string;
|
|
20
|
+
width?: string | number;
|
|
21
|
+
}
|
|
22
|
+
interface Options {
|
|
23
|
+
borderStyle?: string;
|
|
24
|
+
borderColor?: string;
|
|
25
|
+
color?: string;
|
|
26
|
+
compact?: boolean;
|
|
27
|
+
defaultErrorValue?: string;
|
|
28
|
+
defaultValue?: string;
|
|
29
|
+
errorOnNull?: boolean;
|
|
30
|
+
truncate?: string | boolean;
|
|
31
|
+
width?: string | number;
|
|
32
|
+
footerColor?: string;
|
|
33
|
+
[key: string]: unknown;
|
|
34
|
+
}
|
|
35
|
+
interface TtyTableFactory {
|
|
36
|
+
(headers: (string | Header | Formatter$1)[], body: unknown[], footers: (string | Header | Formatter$1)[], config?: Options): Table;
|
|
37
|
+
(header: (string | Header | Formatter$1)[], body: unknown[], config?: Options): Table;
|
|
38
|
+
(body: unknown[], config?: Options): Table;
|
|
39
|
+
resetStyle(str: string): string;
|
|
40
|
+
style(str: string, ...colors: string[]): string;
|
|
41
|
+
}
|
|
42
|
+
interface Table extends Array<any> {
|
|
43
|
+
render(): string;
|
|
44
|
+
height?: number;
|
|
45
|
+
[key: string]: any;
|
|
46
|
+
}
|
|
47
|
+
declare const Table: TtyTableFactory;
|
|
48
|
+
|
|
49
|
+
type Scalar = string | number | boolean | bigint | null | undefined;
|
|
50
|
+
type CellValue = Scalar | object;
|
|
51
|
+
type Alignment = "left" | "center" | "right";
|
|
52
|
+
type BorderStyle = "solid" | "dashed" | "none" | "invisible" | 0 | 1 | 2;
|
|
53
|
+
type Width = "auto" | "100%" | `${number}%` | `${number}` | number;
|
|
54
|
+
interface BorderCharacters {
|
|
55
|
+
v: string;
|
|
56
|
+
l: string;
|
|
57
|
+
j: string;
|
|
58
|
+
h: string;
|
|
59
|
+
r: string;
|
|
60
|
+
}
|
|
61
|
+
interface ColumnOptions {
|
|
62
|
+
value?: string;
|
|
63
|
+
alias?: string;
|
|
64
|
+
width?: Width;
|
|
65
|
+
align?: Alignment;
|
|
66
|
+
alignment?: Alignment;
|
|
67
|
+
headerAlign?: Alignment;
|
|
68
|
+
headerAlignment?: Alignment;
|
|
69
|
+
color?: string | false;
|
|
70
|
+
headerColor?: string | false;
|
|
71
|
+
footerColor?: string | false;
|
|
72
|
+
formatter?: Formatter;
|
|
73
|
+
paddingLeft?: number;
|
|
74
|
+
paddingRight?: number;
|
|
75
|
+
paddingTop?: number;
|
|
76
|
+
paddingBottom?: number;
|
|
77
|
+
truncate?: false | true | string;
|
|
78
|
+
defaultValue?: string;
|
|
79
|
+
defaultErrorValue?: string;
|
|
80
|
+
errorOnNull?: boolean;
|
|
81
|
+
reset?: boolean;
|
|
82
|
+
}
|
|
83
|
+
interface TableOptions extends ColumnOptions {
|
|
84
|
+
borderCharacters?: Record<string, BorderCharacters[]>;
|
|
85
|
+
borderColor?: string | false;
|
|
86
|
+
borderStyle?: BorderStyle;
|
|
87
|
+
COLUMNS?: number;
|
|
88
|
+
compact?: boolean;
|
|
89
|
+
FIXED_WIDTH?: boolean;
|
|
90
|
+
GUTTER?: number;
|
|
91
|
+
marginLeft?: number;
|
|
92
|
+
marginTop?: number;
|
|
93
|
+
showHeader?: boolean | null;
|
|
94
|
+
footerAlign?: Alignment;
|
|
95
|
+
table?: Record<string, unknown>;
|
|
96
|
+
terminalAdapter?: boolean;
|
|
97
|
+
columnSettings?: ColumnOptions[];
|
|
98
|
+
}
|
|
99
|
+
interface FormatterContext {
|
|
100
|
+
value: unknown;
|
|
101
|
+
columnIndex: number;
|
|
102
|
+
rowIndex: number | null;
|
|
103
|
+
row: unknown[];
|
|
104
|
+
input: unknown[];
|
|
105
|
+
configure(options: Partial<ColumnOptions>): void;
|
|
106
|
+
style(value: string, ...styles: string[]): string;
|
|
107
|
+
resetStyle(value: string): string;
|
|
108
|
+
}
|
|
109
|
+
type Formatter = ((value: unknown, columnIndex: number, rowIndex: number | null, row: unknown[], input: unknown[]) => unknown) & {
|
|
110
|
+
modern?: (context: FormatterContext) => unknown;
|
|
111
|
+
};
|
|
112
|
+
interface RenderConfig extends Required<Pick<TableOptions, "align" | "borderStyle" | "compact" | "COLUMNS" | "marginLeft" | "marginTop" | "paddingLeft" | "paddingRight" | "paddingTop" | "paddingBottom" | "GUTTER" | "width" | "defaultValue" | "defaultErrorValue" | "errorOnNull">> {
|
|
113
|
+
headerAlign: Alignment;
|
|
114
|
+
footerAlign: Alignment;
|
|
115
|
+
color: string | false;
|
|
116
|
+
headerColor: string | false;
|
|
117
|
+
footerColor: string | false;
|
|
118
|
+
borderColor: string | false;
|
|
119
|
+
truncate: false | string;
|
|
120
|
+
showHeader: boolean | null;
|
|
121
|
+
FIXED_WIDTH: boolean;
|
|
122
|
+
borderCharacters: Record<string, BorderCharacters[]>;
|
|
123
|
+
columnSettings: ColumnOptions[];
|
|
124
|
+
height: number;
|
|
125
|
+
tableId: number;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
export { type Alignment as A, type BorderCharacters as B, type CellValue as C, type Formatter$1 as F, type Header as H, type Options as O, type RenderConfig as R, type Scalar as S, Table as T, type Width as W, type BorderStyle as a, type ColumnOptions as b, type FormatterContext as c, type TableOptions as d, type Formatter as e };
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
interface Formatter$1 {
|
|
2
|
+
(cellValue: any, columnIndex: number, rowIndex: number, rowData: any, inputData: any): string;
|
|
3
|
+
}
|
|
4
|
+
interface Header {
|
|
5
|
+
alias?: string;
|
|
6
|
+
align?: string;
|
|
7
|
+
color?: string;
|
|
8
|
+
footerAlign?: string;
|
|
9
|
+
footerColor?: string;
|
|
10
|
+
formatter?: Formatter$1;
|
|
11
|
+
headerAlign?: string;
|
|
12
|
+
headerColor?: string;
|
|
13
|
+
marginLeft?: number;
|
|
14
|
+
marginTop?: number;
|
|
15
|
+
paddingBottom?: number;
|
|
16
|
+
paddingLeft?: number;
|
|
17
|
+
paddingRight?: number;
|
|
18
|
+
paddingTop?: number;
|
|
19
|
+
value: string;
|
|
20
|
+
width?: string | number;
|
|
21
|
+
}
|
|
22
|
+
interface Options {
|
|
23
|
+
borderStyle?: string;
|
|
24
|
+
borderColor?: string;
|
|
25
|
+
color?: string;
|
|
26
|
+
compact?: boolean;
|
|
27
|
+
defaultErrorValue?: string;
|
|
28
|
+
defaultValue?: string;
|
|
29
|
+
errorOnNull?: boolean;
|
|
30
|
+
truncate?: string | boolean;
|
|
31
|
+
width?: string | number;
|
|
32
|
+
footerColor?: string;
|
|
33
|
+
[key: string]: unknown;
|
|
34
|
+
}
|
|
35
|
+
interface TtyTableFactory {
|
|
36
|
+
(headers: (string | Header | Formatter$1)[], body: unknown[], footers: (string | Header | Formatter$1)[], config?: Options): Table;
|
|
37
|
+
(header: (string | Header | Formatter$1)[], body: unknown[], config?: Options): Table;
|
|
38
|
+
(body: unknown[], config?: Options): Table;
|
|
39
|
+
resetStyle(str: string): string;
|
|
40
|
+
style(str: string, ...colors: string[]): string;
|
|
41
|
+
}
|
|
42
|
+
interface Table extends Array<any> {
|
|
43
|
+
render(): string;
|
|
44
|
+
height?: number;
|
|
45
|
+
[key: string]: any;
|
|
46
|
+
}
|
|
47
|
+
declare const Table: TtyTableFactory;
|
|
48
|
+
|
|
49
|
+
type Scalar = string | number | boolean | bigint | null | undefined;
|
|
50
|
+
type CellValue = Scalar | object;
|
|
51
|
+
type Alignment = "left" | "center" | "right";
|
|
52
|
+
type BorderStyle = "solid" | "dashed" | "none" | "invisible" | 0 | 1 | 2;
|
|
53
|
+
type Width = "auto" | "100%" | `${number}%` | `${number}` | number;
|
|
54
|
+
interface BorderCharacters {
|
|
55
|
+
v: string;
|
|
56
|
+
l: string;
|
|
57
|
+
j: string;
|
|
58
|
+
h: string;
|
|
59
|
+
r: string;
|
|
60
|
+
}
|
|
61
|
+
interface ColumnOptions {
|
|
62
|
+
value?: string;
|
|
63
|
+
alias?: string;
|
|
64
|
+
width?: Width;
|
|
65
|
+
align?: Alignment;
|
|
66
|
+
alignment?: Alignment;
|
|
67
|
+
headerAlign?: Alignment;
|
|
68
|
+
headerAlignment?: Alignment;
|
|
69
|
+
color?: string | false;
|
|
70
|
+
headerColor?: string | false;
|
|
71
|
+
footerColor?: string | false;
|
|
72
|
+
formatter?: Formatter;
|
|
73
|
+
paddingLeft?: number;
|
|
74
|
+
paddingRight?: number;
|
|
75
|
+
paddingTop?: number;
|
|
76
|
+
paddingBottom?: number;
|
|
77
|
+
truncate?: false | true | string;
|
|
78
|
+
defaultValue?: string;
|
|
79
|
+
defaultErrorValue?: string;
|
|
80
|
+
errorOnNull?: boolean;
|
|
81
|
+
reset?: boolean;
|
|
82
|
+
}
|
|
83
|
+
interface TableOptions extends ColumnOptions {
|
|
84
|
+
borderCharacters?: Record<string, BorderCharacters[]>;
|
|
85
|
+
borderColor?: string | false;
|
|
86
|
+
borderStyle?: BorderStyle;
|
|
87
|
+
COLUMNS?: number;
|
|
88
|
+
compact?: boolean;
|
|
89
|
+
FIXED_WIDTH?: boolean;
|
|
90
|
+
GUTTER?: number;
|
|
91
|
+
marginLeft?: number;
|
|
92
|
+
marginTop?: number;
|
|
93
|
+
showHeader?: boolean | null;
|
|
94
|
+
footerAlign?: Alignment;
|
|
95
|
+
table?: Record<string, unknown>;
|
|
96
|
+
terminalAdapter?: boolean;
|
|
97
|
+
columnSettings?: ColumnOptions[];
|
|
98
|
+
}
|
|
99
|
+
interface FormatterContext {
|
|
100
|
+
value: unknown;
|
|
101
|
+
columnIndex: number;
|
|
102
|
+
rowIndex: number | null;
|
|
103
|
+
row: unknown[];
|
|
104
|
+
input: unknown[];
|
|
105
|
+
configure(options: Partial<ColumnOptions>): void;
|
|
106
|
+
style(value: string, ...styles: string[]): string;
|
|
107
|
+
resetStyle(value: string): string;
|
|
108
|
+
}
|
|
109
|
+
type Formatter = ((value: unknown, columnIndex: number, rowIndex: number | null, row: unknown[], input: unknown[]) => unknown) & {
|
|
110
|
+
modern?: (context: FormatterContext) => unknown;
|
|
111
|
+
};
|
|
112
|
+
interface RenderConfig extends Required<Pick<TableOptions, "align" | "borderStyle" | "compact" | "COLUMNS" | "marginLeft" | "marginTop" | "paddingLeft" | "paddingRight" | "paddingTop" | "paddingBottom" | "GUTTER" | "width" | "defaultValue" | "defaultErrorValue" | "errorOnNull">> {
|
|
113
|
+
headerAlign: Alignment;
|
|
114
|
+
footerAlign: Alignment;
|
|
115
|
+
color: string | false;
|
|
116
|
+
headerColor: string | false;
|
|
117
|
+
footerColor: string | false;
|
|
118
|
+
borderColor: string | false;
|
|
119
|
+
truncate: false | string;
|
|
120
|
+
showHeader: boolean | null;
|
|
121
|
+
FIXED_WIDTH: boolean;
|
|
122
|
+
borderCharacters: Record<string, BorderCharacters[]>;
|
|
123
|
+
columnSettings: ColumnOptions[];
|
|
124
|
+
height: number;
|
|
125
|
+
tableId: number;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
export { type Alignment as A, type BorderCharacters as B, type CellValue as C, type Formatter$1 as F, type Header as H, type Options as O, type RenderConfig as R, type Scalar as S, Table as T, type Width as W, type BorderStyle as a, type ColumnOptions as b, type FormatterContext as c, type TableOptions as d, type Formatter as e };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { A as Alignment, B as BorderCharacters, a as BorderStyle, C as CellValue, b as ColumnOptions, e as Formatter, c as FormatterContext, R as RenderConfig, S as Scalar, d as TableOptions, W as Width, T as default } from './browser-BC4npgub.mjs';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { A as Alignment, B as BorderCharacters, a as BorderStyle, C as CellValue, b as ColumnOptions, e as Formatter, c as FormatterContext, R as RenderConfig, S as Scalar, d as TableOptions, W as Width, T as default } from './browser-BC4npgub.js';
|