deno.land / std@0.166.0 / fmt / colors.ts

نووسراو ببینە
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.// A module to print ANSI terminal colors. Inspired by chalk, kleur, and colors// on npm.
/** * String formatters and utilities for dealing with ANSI color codes. * * This module is browser compatible. * * ```ts * import { bgBlue, red, bold } from "https://deno.land/std@$STD_VERSION/fmt/colors.ts"; * console.log(bgBlue(red(bold("Hello world!")))); * ``` * * This module supports `NO_COLOR` environmental variable disabling any coloring * if `NO_COLOR` is set. * * @module */
// deno-lint-ignore no-explicit-anyconst { Deno } = globalThis as any;const noColor = typeof Deno?.noColor === "boolean" ? Deno.noColor as boolean : true;
interface Code { open: string; close: string; regexp: RegExp;}
/** RGB 8-bits per channel. Each in range `0->255` or `0x00->0xff` */interface Rgb { r: number; g: number; b: number;}
let enabled = !noColor;
/** * Set changing text color to enabled or disabled * @param value */export function setColorEnabled(value: boolean) { if (noColor) { return; }
enabled = value;}
/** Get whether text color change is enabled or disabled. */export function getColorEnabled(): boolean { return enabled;}
/** * Builds color code * @param open * @param close */function code(open: number[], close: number): Code { return { open: `\x1b[${open.join(";")}m`, close: `\x1b[${close}m`, regexp: new RegExp(`\\x1b\\[${close}m`, "g"), };}
/** * Applies color and background based on color code and its associated text * @param str text to apply color settings to * @param code color code to apply */function run(str: string, code: Code): string { return enabled ? `${code.open}${str.replace(code.regexp, code.open)}${code.close}` : str;}
/** * Reset the text modified * @param str text to reset */export function reset(str: string): string { return run(str, code([0], 0));}
/** * Make the text bold. * @param str text to make bold */export function bold(str: string): string { return run(str, code([1], 22));}
/** * The text emits only a small amount of light. * @param str text to dim */export function dim(str: string): string { return run(str, code([2], 22));}
/** * Make the text italic. * @param str text to make italic */export function italic(str: string): string { return run(str, code([3], 23));}
/** * Make the text underline. * @param str text to underline */export function underline(str: string): string { return run(str, code([4], 24));}
/** * Invert background color and text color. * @param str text to invert its color */export function inverse(str: string): string { return run(str, code([7], 27));}
/** * Make the text hidden. * @param str text to hide */export function hidden(str: string): string { return run(str, code([8], 28));}
/** * Put horizontal line through the center of the text. * @param str text to strike through */export function strikethrough(str: string): string { return run(str, code([9], 29));}
/** * Set text color to black. * @param str text to make black */export function black(str: string): string { return run(str, code([30], 39));}
/** * Set text color to red. * @param str text to make red */export function red(str: string): string { return run(str, code([31], 39));}
/** * Set text color to green. * @param str text to make green */export function green(str: string): string { return run(str, code([32], 39));}
/** * Set text color to yellow. * @param str text to make yellow */export function yellow(str: string): string { return run(str, code([33], 39));}
/** * Set text color to blue. * @param str text to make blue */export function blue(str: string): string { return run(str, code([34], 39));}
/** * Set text color to magenta. * @param str text to make magenta */export function magenta(str: string): string { return run(str, code([35], 39));}
/** * Set text color to cyan. * @param str text to make cyan */export function cyan(str: string): string { return run(str, code([36], 39));}
/** * Set text color to white. * @param str text to make white */export function white(str: string): string { return run(str, code([37], 39));}
/** * Set text color to gray. * @param str text to make gray */export function gray(str: string): string { return brightBlack(str);}
/** * Set text color to bright black. * @param str text to make bright-black */export function brightBlack(str: string): string { return run(str, code([90], 39));}
/** * Set text color to bright red. * @param str text to make bright-red */export function brightRed(str: string): string { return run(str, code([91], 39));}
/** * Set text color to bright green. * @param str text to make bright-green */export function brightGreen(str: string): string { return run(str, code([92], 39));}
/** * Set text color to bright yellow. * @param str text to make bright-yellow */export function brightYellow(str: string): string { return run(str, code([93], 39));}
/** * Set text color to bright blue. * @param str text to make bright-blue */export function brightBlue(str: string): string { return run(str, code([94], 39));}
/** * Set text color to bright magenta. * @param str text to make bright-magenta */export function brightMagenta(str: string): string { return run(str, code([95], 39));}
/** * Set text color to bright cyan. * @param str text to make bright-cyan */export function brightCyan(str: string): string { return run(str, code([96], 39));}
/** * Set text color to bright white. * @param str text to make bright-white */export function brightWhite(str: string): string { return run(str, code([97], 39));}
/** * Set background color to black. * @param str text to make its background black */export function bgBlack(str: string): string { return run(str, code([40], 49));}
/** * Set background color to red. * @param str text to make its background red */export function bgRed(str: string): string { return run(str, code([41], 49));}
/** * Set background color to green. * @param str text to make its background green */export function bgGreen(str: string): string { return run(str, code([42], 49));}
/** * Set background color to yellow. * @param str text to make its background yellow */export function bgYellow(str: string): string { return run(str, code([43], 49));}
/** * Set background color to blue. * @param str text to make its background blue */export function bgBlue(str: string): string { return run(str, code([44], 49));}
/** * Set background color to magenta. * @param str text to make its background magenta */export function bgMagenta(str: string): string { return run(str, code([45], 49));}
/** * Set background color to cyan. * @param str text to make its background cyan */export function bgCyan(str: string): string { return run(str, code([46], 49));}
/** * Set background color to white. * @param str text to make its background white */export function bgWhite(str: string): string { return run(str, code([47], 49));}
/** * Set background color to bright black. * @param str text to make its background bright-black */export function bgBrightBlack(str: string): string { return run(str, code([100], 49));}
/** * Set background color to bright red. * @param str text to make its background bright-red */export function bgBrightRed(str: string): string { return run(str, code([101], 49));}
/** * Set background color to bright green. * @param str text to make its background bright-green */export function bgBrightGreen(str: string): string { return run(str, code([102], 49));}
/** * Set background color to bright yellow. * @param str text to make its background bright-yellow */export function bgBrightYellow(str: string): string { return run(str, code([103], 49));}
/** * Set background color to bright blue. * @param str text to make its background bright-blue */export function bgBrightBlue(str: string): string { return run(str, code([104], 49));}
/** * Set background color to bright magenta. * @param str text to make its background bright-magenta */export function bgBrightMagenta(str: string): string { return run(str, code([105], 49));}
/** * Set background color to bright cyan. * @param str text to make its background bright-cyan */export function bgBrightCyan(str: string): string { return run(str, code([106], 49));}
/** * Set background color to bright white. * @param str text to make its background bright-white */export function bgBrightWhite(str: string): string { return run(str, code([107], 49));}
/* Special Color Sequences */
/** * Clam and truncate color codes * @param n * @param max number to truncate to * @param min number to truncate from */function clampAndTruncate(n: number, max = 255, min = 0): number { return Math.trunc(Math.max(Math.min(n, max), min));}
/** * Set text color using paletted 8bit colors. * https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit * @param str text color to apply paletted 8bit colors to * @param color code */export function rgb8(str: string, color: number): string { return run(str, code([38, 5, clampAndTruncate(color)], 39));}
/** * Set background color using paletted 8bit colors. * https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit * @param str text color to apply paletted 8bit background colors to * @param color code */export function bgRgb8(str: string, color: number): string { return run(str, code([48, 5, clampAndTruncate(color)], 49));}
/** * Set text color using 24bit rgb. * `color` can be a number in range `0x000000` to `0xffffff` or * an `Rgb`. * * To produce the color magenta: * * ```ts * import { rgb24 } from "https://deno.land/std@$STD_VERSION/fmt/colors.ts"; * rgb24("foo", 0xff00ff); * rgb24("foo", {r: 255, g: 0, b: 255}); * ``` * @param str text color to apply 24bit rgb to * @param color code */export function rgb24(str: string, color: number | Rgb): string { if (typeof color === "number") { return run( str, code( [38, 2, (color >> 16) & 0xff, (color >> 8) & 0xff, color & 0xff], 39, ), ); } return run( str, code( [ 38, 2, clampAndTruncate(color.r), clampAndTruncate(color.g), clampAndTruncate(color.b), ], 39, ), );}
/** * Set background color using 24bit rgb. * `color` can be a number in range `0x000000` to `0xffffff` or * an `Rgb`. * * To produce the color magenta: * * ```ts * import { bgRgb24 } from "https://deno.land/std@$STD_VERSION/fmt/colors.ts"; * bgRgb24("foo", 0xff00ff); * bgRgb24("foo", {r: 255, g: 0, b: 255}); * ``` * @param str text color to apply 24bit rgb to * @param color code */export function bgRgb24(str: string, color: number | Rgb): string { if (typeof color === "number") { return run( str, code( [48, 2, (color >> 16) & 0xff, (color >> 8) & 0xff, color & 0xff], 49, ), ); } return run( str, code( [ 48, 2, clampAndTruncate(color.r), clampAndTruncate(color.g), clampAndTruncate(color.b), ], 49, ), );}
// https://github.com/chalk/ansi-regex/blob/02fa893d619d3da85411acc8fd4e2eea0e95a9d9/index.jsconst ANSI_PATTERN = new RegExp( [ "[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)", "(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]))", ].join("|"), "g",);
/** * Remove ANSI escape codes from the string. * @param string to remove ANSI escape codes from */export function stripColor(string: string): string { return string.replace(ANSI_PATTERN, "");}
std
Deno standard library
GitHub Repositorydenoland/deno_std
GitHub Stars
2448

Version Info

Tagged at
2 months ago