@andrew_l/pino-pretty 0.3.22 → 0.4.1
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/dist/index.d.mts +177 -179
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +527 -614
- package/dist/index.mjs.map +1 -1
- package/package.json +9 -8
- package/dist/index.cjs +0 -740
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.cts +0 -208
- package/dist/index.d.ts +0 -208
package/dist/index.d.mts
CHANGED
|
@@ -1,171 +1,170 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
|
|
1
|
+
import { Transform } from "node:stream";
|
|
2
|
+
import { Arrayable, DeepPartial } from "@andrew_l/toolkit";
|
|
3
|
+
import { StringWidth } from "@cto.af/string-width";
|
|
4
4
|
declare const colorDefs: {
|
|
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
|
-
|
|
5
|
+
reset: (string: string) => string;
|
|
6
|
+
bold: (string: string) => string;
|
|
7
|
+
dim: (string: string) => string;
|
|
8
|
+
italic: (string: string) => string;
|
|
9
|
+
underline: (string: string) => string;
|
|
10
|
+
inverse: (string: string) => string;
|
|
11
|
+
hidden: (string: string) => string;
|
|
12
|
+
strikethrough: (string: string) => string;
|
|
13
|
+
black: (string: string) => string;
|
|
14
|
+
red: (string: string) => string;
|
|
15
|
+
green: (string: string) => string;
|
|
16
|
+
yellow: (string: string) => string;
|
|
17
|
+
blue: (string: string) => string;
|
|
18
|
+
magenta: (string: string) => string;
|
|
19
|
+
cyan: (string: string) => string;
|
|
20
|
+
white: (string: string) => string;
|
|
21
|
+
gray: (string: string) => string;
|
|
22
|
+
bgBlack: (string: string) => string;
|
|
23
|
+
bgRed: (string: string) => string;
|
|
24
|
+
bgGreen: (string: string) => string;
|
|
25
|
+
bgYellow: (string: string) => string;
|
|
26
|
+
bgBlue: (string: string) => string;
|
|
27
|
+
bgMagenta: (string: string) => string;
|
|
28
|
+
bgCyan: (string: string) => string;
|
|
29
|
+
bgWhite: (string: string) => string;
|
|
30
|
+
blackBright: (string: string) => string;
|
|
31
|
+
redBright: (string: string) => string;
|
|
32
|
+
greenBright: (string: string) => string;
|
|
33
|
+
yellowBright: (string: string) => string;
|
|
34
|
+
blueBright: (string: string) => string;
|
|
35
|
+
magentaBright: (string: string) => string;
|
|
36
|
+
cyanBright: (string: string) => string;
|
|
37
|
+
whiteBright: (string: string) => string;
|
|
38
|
+
bgBlackBright: (string: string) => string;
|
|
39
|
+
bgRedBright: (string: string) => string;
|
|
40
|
+
bgGreenBright: (string: string) => string;
|
|
41
|
+
bgYellowBright: (string: string) => string;
|
|
42
|
+
bgBlueBright: (string: string) => string;
|
|
43
|
+
bgMagentaBright: (string: string) => string;
|
|
44
|
+
bgCyanBright: (string: string) => string;
|
|
45
|
+
bgWhiteBright: (string: string) => string;
|
|
46
|
+
orange: (string: string) => string;
|
|
47
|
+
purple: (string: string) => string;
|
|
48
|
+
pink: (string: string) => string;
|
|
49
|
+
lime: (string: string) => string;
|
|
50
|
+
teal: (string: string) => string;
|
|
51
|
+
indigo: (string: string) => string;
|
|
52
|
+
brown: (string: string) => string;
|
|
53
|
+
olive: (string: string) => string;
|
|
54
|
+
navy: (string: string) => string;
|
|
55
|
+
maroon: (string: string) => string;
|
|
56
|
+
silver: (string: string) => string;
|
|
57
|
+
gold: (string: string) => string;
|
|
58
|
+
bgOrange: (string: string) => string;
|
|
59
|
+
bgPurple: (string: string) => string;
|
|
60
|
+
bgPink: (string: string) => string;
|
|
61
|
+
bgLime: (string: string) => string;
|
|
62
|
+
bgTeal: (string: string) => string;
|
|
63
|
+
bgIndigo: (string: string) => string;
|
|
64
|
+
bgBrown: (string: string) => string;
|
|
65
|
+
bgOlive: (string: string) => string;
|
|
66
|
+
bgNavy: (string: string) => string;
|
|
67
|
+
bgMaroon: (string: string) => string;
|
|
68
|
+
bgSilver: (string: string) => string;
|
|
69
|
+
bgGold: (string: string) => string;
|
|
70
70
|
};
|
|
71
71
|
type ColorName = keyof typeof colorDefs;
|
|
72
|
-
|
|
73
72
|
type LevelConfig = {
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
73
|
+
/**
|
|
74
|
+
* Icon symbol displayed before the log message.
|
|
75
|
+
* @example '🔥' - Fire emoji for error level
|
|
76
|
+
* @example '✅' - Checkmark for success level
|
|
77
|
+
*/
|
|
78
|
+
icon: string;
|
|
79
|
+
color: ColorValue;
|
|
80
|
+
/**
|
|
81
|
+
* Level badge name displayed in log output.
|
|
82
|
+
* Typically uppercase abbreviation of the level name.
|
|
83
|
+
* @example 'INFO' - Information level
|
|
84
|
+
* @example 'ERROR' - Error level
|
|
85
|
+
* @example 'WARN' - Warning level
|
|
86
|
+
*/
|
|
87
|
+
badge: string;
|
|
89
88
|
};
|
|
90
89
|
type TypeConfig = {
|
|
91
|
-
|
|
90
|
+
color: ColorValue;
|
|
92
91
|
};
|
|
93
92
|
interface PrettyOptions {
|
|
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
|
-
|
|
93
|
+
/**
|
|
94
|
+
* Pino message key.
|
|
95
|
+
* @default 'regular'
|
|
96
|
+
*/
|
|
97
|
+
inspect: 'regular' | 'compact' | InspectFunction;
|
|
98
|
+
/**
|
|
99
|
+
* Pino message key.
|
|
100
|
+
*/
|
|
101
|
+
messageKey: string;
|
|
102
|
+
/**
|
|
103
|
+
* Pino nested key.
|
|
104
|
+
*/
|
|
105
|
+
nestedKey?: string;
|
|
106
|
+
/**
|
|
107
|
+
* The maximum number of columns to output, affects formatting and line wrapping.
|
|
108
|
+
* Should typically match the terminal width for optimal display.
|
|
109
|
+
* @example process.stdout.columns
|
|
110
|
+
* @default 80
|
|
111
|
+
*/
|
|
112
|
+
columns: number;
|
|
113
|
+
/**
|
|
114
|
+
* Quote style for string values in log output.
|
|
115
|
+
* @default 'single'
|
|
116
|
+
* @example 'single' - Uses single quotes: 'hello world'
|
|
117
|
+
* @example 'double' - Uses double quotes: "hello world"
|
|
118
|
+
*/
|
|
119
|
+
quoteStyle: 'single' | 'double';
|
|
120
|
+
/**
|
|
121
|
+
* Comma-separated list of log message fields to ignore/hide from output.
|
|
122
|
+
* Useful for reducing noise by hiding standard fields like hostname or PID.
|
|
123
|
+
* @example 'time,name' - Hides timestamp and logger name
|
|
124
|
+
* @default 'hostname,pid'
|
|
125
|
+
*/
|
|
126
|
+
ignore: string;
|
|
127
|
+
/**
|
|
128
|
+
* Number of spaces to use for indentation when formatting nested objects.
|
|
129
|
+
* @default 2
|
|
130
|
+
*/
|
|
131
|
+
indent: number;
|
|
132
|
+
/**
|
|
133
|
+
* Maximum depth to recurse when formatting nested objects and arrays.
|
|
134
|
+
* @default 5
|
|
135
|
+
*/
|
|
136
|
+
depth: number;
|
|
137
|
+
/**
|
|
138
|
+
* Minimum log level value at which to show the level badge.
|
|
139
|
+
* Levels below this threshold will not display their badge text.
|
|
140
|
+
* @default 40
|
|
141
|
+
* @example 30 - Show badges for levels 30 and above (info, warn, error, fatal)
|
|
142
|
+
* @example 50 - Show badges only for levels 50 and above (error, fatal)
|
|
143
|
+
*/
|
|
144
|
+
badgeMinLevel: number;
|
|
145
|
+
/**
|
|
146
|
+
* Maximum length for string values before they are truncated with ellipsis.
|
|
147
|
+
* @default 400
|
|
148
|
+
*/
|
|
149
|
+
maxStringLength: number;
|
|
150
|
+
/**
|
|
151
|
+
* When enabled, formats numbers like 1234567 as 1_234_567.
|
|
152
|
+
* @default false
|
|
153
|
+
*/
|
|
154
|
+
numericSeparator: boolean;
|
|
155
|
+
/**
|
|
156
|
+
* Whether to use ANSI colors in the output.
|
|
157
|
+
* @default true
|
|
158
|
+
*/
|
|
159
|
+
colorize: boolean;
|
|
160
|
+
/**
|
|
161
|
+
* Configuration mapping for log levels.
|
|
162
|
+
*/
|
|
163
|
+
levels: Record<number, LevelConfig>;
|
|
164
|
+
/**
|
|
165
|
+
* Configuration mapping for data types.
|
|
166
|
+
*/
|
|
167
|
+
types: Record<TypeName, TypeConfig>;
|
|
169
168
|
}
|
|
170
169
|
type TypeName = 'number' | 'boolean' | 'string' | 'object' | 'error' | 'errorStack' | 'time' | 'name';
|
|
171
170
|
/**
|
|
@@ -175,32 +174,31 @@ type TypeName = 'number' | 'boolean' | 'string' | 'object' | 'error' | 'errorSta
|
|
|
175
174
|
type ColorValue = 'rand' | Arrayable<ColorName>;
|
|
176
175
|
type InspectFunction = (obj: any, opts: InspectOptions) => string;
|
|
177
176
|
interface InspectOptions {
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
177
|
+
/** Maximum depth of the inspection @default 5 */
|
|
178
|
+
depth: number;
|
|
179
|
+
/** Quote style for strings @default 'single' */
|
|
180
|
+
quoteStyle: 'single' | 'double';
|
|
181
|
+
/** Maximum string length before truncation @default Infinity */
|
|
182
|
+
maxStringLength: number;
|
|
183
|
+
/** Indentation spaces @default 2 */
|
|
184
|
+
indent: number;
|
|
185
|
+
/** Add numeric separators (1_234.567_8) @default false */
|
|
186
|
+
numericSeparator: boolean;
|
|
187
|
+
/** Custom stringify functions for different types */
|
|
188
|
+
customStringify: {
|
|
189
|
+
[x: string]: InspectCustomStringify;
|
|
190
|
+
};
|
|
191
|
+
/** Available width columns */
|
|
192
|
+
columns: number;
|
|
194
193
|
}
|
|
195
194
|
type InspectCustomStringify = (value: any) => string;
|
|
196
|
-
|
|
197
195
|
declare namespace PinoPretty {
|
|
198
|
-
|
|
196
|
+
type Options = DeepPartial<PrettyOptions>;
|
|
199
197
|
}
|
|
200
198
|
/**
|
|
201
199
|
* Constructs a of stream to which the produced
|
|
202
200
|
* prettified log data will be written.
|
|
203
201
|
*/
|
|
204
202
|
declare function build(opts?: PinoPretty.Options): Promise<Transform>;
|
|
205
|
-
|
|
206
203
|
export { PinoPretty, build, build as default };
|
|
204
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":["reset","string","bold","dim","italic","underline","inverse","hidden","strikethrough","black","red","green","yellow","blue","magenta","cyan","white","gray","bgBlack","bgRed","bgGreen","bgYellow","bgBlue","bgMagenta","bgCyan","bgWhite","blackBright","redBright","greenBright","yellowBright","blueBright","magentaBright","cyanBright","whiteBright","bgBlackBright","bgRedBright","bgGreenBright","bgYellowBright","bgBlueBright","bgMagentaBright","bgCyanBright","bgWhiteBright","orange","purple","pink","lime","teal","indigo","brown","olive","navy","maroon","silver","gold","bgOrange","bgPurple","bgPink","bgLime","bgTeal","bgIndigo","bgBrown","bgOlive","bgNavy","bgMaroon","bgSilver","bgGold","Readonly","ColorName","colorDefs","text","Record","ColorFunction","color","fallback","icon","color","ColorValue","badge","inspect","InspectFunction","messageKey","nestedKey","columns","quoteStyle","ignore","indent","depth","badgeMinLevel","maxStringLength","numericSeparator","colorize","levels","Record","LevelConfig","types","TypeName","TypeConfig","Omit","PrettyOptions","sw","StringWidth","Set","ignoreAdditional","LevelConfigParsed","TypeConfigParsed","inspectFn","inspectOptions","InspectOptions","colorFallback","ColorizeFn","Arrayable","ColorName","value","colorBadge","level","time","msg","pid","hostname","key","obj","opts","customStringify","x","InspectCustomStringify","Options","DeepPartial","PinoPretty","opts","Promise","Transform"],"sources":["../src/utils/getColor.d.ts","../src/types.d.ts","../src/index.d.ts"],"mappings":";;;cAAc,SAAA;EACVA,KAAAA,GAAQC,MAAAA;EACRC,IAAAA,GAAOD,MAAAA;EACPE,GAAAA,GAAMF,MAAAA;EACNG,MAAAA,GAASH,MAAAA;EACTI,SAAAA,GAAYJ,MAAAA;EACZK,OAAAA,GAAUL,MAAAA;EACVM,MAAAA,GAASN,MAAAA;EACTO,aAAAA,GAAgBP,MAAAA;EAChBQ,KAAAA,GAAQR,MAAAA;EACRS,GAAAA,GAAMT,MAAAA;EACNU,KAAAA,GAAQV,MAAAA;EACRW,MAAAA,GAASX,MAAAA;EACTY,IAAAA,GAAOZ,MAAAA;EACPa,OAAAA,GAAUb,MAAAA;EACVc,IAAAA,GAAOd,MAAAA;EACPe,KAAAA,GAAQf,MAAAA;EACRgB,IAAAA,GAAOhB,MAAAA;EACPiB,OAAAA,GAAUjB,MAAAA;EACVkB,KAAAA,GAAQlB,MAAAA;EACRmB,OAAAA,GAAUnB,MAAAA;EACVoB,QAAAA,GAAWpB,MAAAA;EACXqB,MAAAA,GAASrB,MAAAA;EACTsB,SAAAA,GAAYtB,MAAAA;EACZuB,MAAAA,GAASvB,MAAAA;EACTwB,OAAAA,GAAUxB,MAAAA;EACVyB,WAAAA,GAAczB,MAAAA;EACd0B,SAAAA,GAAY1B,MAAAA;EACZ2B,WAAAA,GAAc3B,MAAAA;EACd4B,YAAAA,GAAe5B,MAAAA;EACf6B,UAAAA,GAAa7B,MAAAA;EACb8B,aAAAA,GAAgB9B,MAAAA;EAChB+B,UAAAA,GAAa/B,MAAAA;EACbgC,WAAAA,GAAchC,MAAAA;EACdiC,aAAAA,GAAgBjC,MAAAA;EAChBkC,WAAAA,GAAclC,MAAAA;EACdmC,aAAAA,GAAgBnC,MAAAA;EAChBoC,cAAAA,GAAiBpC,MAAAA;EACjBqC,YAAAA,GAAerC,MAAAA;EACfsC,eAAAA,GAAkBtC,MAAAA;EAClBuC,YAAAA,GAAevC,MAAAA;EACfwC,aAAAA,GAAgBxC,MAAAA;EAChByC,MAAAA,GAASzC,MAAAA;EACT0C,MAAAA,GAAS1C,MAAAA;EACT2C,IAAAA,GAAO3C,MAAAA;EACP4C,IAAAA,GAAO5C,MAAAA;EACP6C,IAAAA,GAAO7C,MAAAA;EACP8C,MAAAA,GAAS9C,MAAAA;EACT+C,KAAAA,GAAQ/C,MAAAA;EACRgD,KAAAA,GAAQhD,MAAAA;EACRiD,IAAAA,GAAOjD,MAAAA;EACPkD,MAAAA,GAASlD,MAAAA;EACTmD,MAAAA,GAASnD,MAAAA;EACToD,IAAAA,GAAOpD,MAAAA;EACPqD,QAAAA,GAAWrD,MAAAA;EACXsD,QAAAA,GAAWtD,MAAAA;EACXuD,MAAAA,GAASvD,MAAAA;EACTwD,MAAAA,GAASxD,MAAAA;EACTyD,MAAAA,GAASzD,MAAAA;EACT0D,QAAAA,GAAW1D,MAAAA;EACX2D,OAAAA,GAAU3D,MAAAA;EACV4D,OAAAA,GAAU5D,MAAAA;EACV6D,MAAAA,GAAS7D,MAAAA;EACT8D,QAAAA,GAAW9D,MAAAA;EACX+D,QAAAA,GAAW/D,MAAAA;EACXgE,MAAAA,GAAShE,MAAAA;AAAAA;AAAAA,KAGD,SAAA,gBAAyB,SAAS;AAAA,KCjElC,WAAA;EDHE;;;;;ECSVyE,IAAAA;EACAC,KAAAA,EAAO,UAAU;EDRV1E;;;;;;;ECgBP4E,KAAAA;AAAAA;AAAAA,KAEQ,UAAA;EACRF,KAAAA,EAAO,UAAU;AAAA;AAAA,UAEJ,aAAA;EDdblE;;;;ECmBAqE,OAAAA,0BAAiC,eAAA;EDjBzB7E;;;ECqBR+E,UAAAA;EDnBO/E;;;ECuBPgF,SAAAA;EDrBOhF;;;;;;EC4BPiF,OAAAA;EDxBA/D;;;;;;EC+BAgE,UAAAA;ED5BSlF;;;;;;ECmCTmF,MAAAA;ED/BA1D;;;;ECoCA2D,MAAAA;EDlCcpF;;;;ECuCdqF,KAAAA;EDpCAvD;;;;;;;EC4CAwD,aAAAA;EDxCApD;;;;EC6CAqD,eAAAA;ED3CiBvF;;;;ECgDjBwF,gBAAAA;ED7CAjD;;;;ECkDAkD,QAAAA;EDhDSzF;;;ECoDT0F,MAAAA,EAAQ,MAAA,SAAe,WAAA;EDlDhB1F;;;ECsDP6F,KAAAA,EAAO,MAAA,CAAO,QAAA,EAAU,UAAA;AAAA;AAAA,KAEhB,QAAA;;;;;KAeA,UAAA,YAAsB,SAAS,CAAC,SAAA;AAAA,KAiBhC,eAAA,IAAmB0B,GAAAA,OAAUC,IAAAA,EAAM,cAAc;AAAA,UAC5C,cAAA;EDrEbzD;ECuEAsB,KAAAA;EDtEArB;ECwEAkB,UAAAA;EDxEuB;EC0EvBK,eAAAA;EDvEQ;ECyERH,MAAAA;;EAEAI,gBAAAA;ED3E0C;EC6E1CiC,eAAAA;IAAAA,CACKC,CAAAA,WAAY,sBAAsB;EAAA;;EAGvCzC,OAAAA;AAAAA;AAAAA,KAEC,sBAAA,IAA0B8B,KAAU;AAAA,kBCrJhB,UAAA;EAAA,KAChBa,OAAAA,GAAU,WAAW,CADK,aAAA;AAAA;;;;;iBAOX,KAAA,CAAMG,IAAAA,GAAO,UAAA,CAAW,OAAA,GAAU,OAAA,CAAQ,SAAA"}
|