Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 2x 2x 2x 2000030x 2000030x 16000240x 9000009x 2000030x 16000240x 8000008x 2000030x 16000240x 8000008x 2000030x 16000240x 8000008x 2000030x 34000510x 17000019x 2x 2x 1x 1x 17000020x 17000020x 16000019x 16000019x 17000023x 1x 1x 17000022x 17000022x 5x 5x 5x 5x 10x 10x 10x 10x 1x 2x 2000030x | import {
BrightBackgroundColors,
BrightForegroundColors,
StandardBackgroundColors,
StandardForegroundColors,
styles,
} from "./constants";
import {
clear,
colorize256,
colorizeANSI,
colorizeRGB,
raw,
applyStyle,
} from "./colors";
/**
* @typedef ColorizeOptions
* @description Options for text colorization using ANSI codes.
* @summary This type defines the structure of the object returned by the colorize function.
* It includes methods for applying various color and style options to text using ANSI escape codes.
*
* @property {StyledString} StandardForegroundColors Getter for each standard foreground color.
* @property {StyledString} BrightForegroundColors Getter for each bright foreground color.
* @property {StyledString} StandardBackgroundColors Getter for each standard background color.
* @property {StyledString} BrightBackgroundColors Getter for each bright background color.
* @property {StyledString} styles Getter for each text style.
* @property {function(): StyledString} clear Removes all styling from the text.
* @property {function(string): StyledString} raw Applies raw ANSI codes to the text.
* @property {function(number): StyledString} foreground Applies a foreground color using ANSI codes.
* @property {function(number): StyledString} background Applies a background color using ANSI codes.
* @property {function(string): StyledString} style Applies a text style using ANSI codes.
* @property {function(number): StyledString} color256 Applies a 256-color foreground color.
* @property {function(number): StyledString} bgColor256 Applies a 256-color background color.
* @property {function(number, number, number): StyledString} rgb Applies an RGB foreground color.
* @property {function(number, number, number): StyledString} bgRgb Applies an RGB background color.
* @property {string} text The underlying text content.
*
* @memberOf module:StyledString
*/
export type ColorizeOptions = {
[k in keyof typeof StandardForegroundColors]: StyledString;
} & { [k in keyof typeof BrightForegroundColors]: StyledString } & {
[k in keyof typeof StandardBackgroundColors]: StyledString;
} & { [k in keyof typeof BrightBackgroundColors]: StyledString } & {
[k in keyof typeof styles]: StyledString;
} & {
clear: () => StyledString;
raw: (raw: string) => StyledString;
foreground: (n: number) => StyledString;
background: (n: number) => StyledString;
style: (n: number | keyof typeof styles) => StyledString;
color256: (n: number) => StyledString;
bgColor256: (n: number) => StyledString;
rgb: (r: number, g: number, b: number) => StyledString;
bgRgb: (r: number, g: number, b: number) => StyledString;
text: string;
};
/**
* @class StyledString
* @description A class that extends string functionality with ANSI color and style options.
* @summary StyledString provides methods to apply various ANSI color and style options to text strings.
* It implements the ColorizeOptions interface and proxies native string methods to the underlying text.
* This class allows for chaining of styling methods and easy application of colors and styles to text.
*
* @implements {ColorizeOptions}
* @param {string} text - The initial text string to be styled.
*/
export class StyledString implements ColorizeOptions {
/**
* @description Applies black color to the text.
* @summary Getter that returns a new StyledString with black foreground color.
*/
black!: StyledString;
/**
* @description Applies red color to the text.
* @summary Getter that returns a new StyledString with red foreground color.
*/
red!: StyledString;
/**
* @description Applies green color to the text.
* @summary Getter that returns a new StyledString with green foreground color.
*/
green!: StyledString;
/**
* @description Applies yellow color to the text.
* @summary Getter that returns a new StyledString with yellow foreground color.
*/
yellow!: StyledString;
/**
* @description Applies blue color to the text.
* @summary Getter that returns a new StyledString with blue foreground color.
*/
blue!: StyledString;
/**
* @description Applies magenta color to the text.
* @summary Getter that returns a new StyledString with magenta foreground color.
*/
magenta!: StyledString;
/**
* @description Applies cyan color to the text.
* @summary Getter that returns a new StyledString with cyan foreground color.
*/
cyan!: StyledString;
/**
* @description Applies white color to the text.
* @summary Getter that returns a new StyledString with white foreground color.
*/
white!: StyledString;
/**
* @description Applies bright black (gray) color to the text.
* @summary Getter that returns a new StyledString with bright black foreground color.
*/
brightBlack!: StyledString;
/**
* @description Applies bright red color to the text.
* @summary Getter that returns a new StyledString with bright red foreground color.
*/
brightRed!: StyledString;
/**
* @description Applies bright green color to the text.
* @summary Getter that returns a new StyledString with bright green foreground color.
*/
brightGreen!: StyledString;
/**
* @description Applies bright yellow color to the text.
* @summary Getter that returns a new StyledString with bright yellow foreground color.
*/
brightYellow!: StyledString;
/**
* @description Applies bright blue color to the text.
* @summary Getter that returns a new StyledString with bright blue foreground color.
*/
brightBlue!: StyledString;
/**
* @description Applies bright magenta color to the text.
* @summary Getter that returns a new StyledString with bright magenta foreground color.
*/
brightMagenta!: StyledString;
/**
* @description Applies bright cyan color to the text.
* @summary Getter that returns a new StyledString with bright cyan foreground color.
*/
brightCyan!: StyledString;
/**
* @description Applies bright white color to the text.
* @summary Getter that returns a new StyledString with bright white foreground color.
*/
brightWhite!: StyledString;
/**
* @description Applies black background color to the text.
* @summary Getter that returns a new StyledString with black background color.
*/
bgBlack!: StyledString;
/**
* @description Applies red background color to the text.
* @summary Getter that returns a new StyledString with red background color.
*/
bgRed!: StyledString;
/**
* @description Applies green background color to the text.
* @summary Getter that returns a new StyledString with green background color.
*/
bgGreen!: StyledString;
/**
* @description Applies yellow background color to the text.
* @summary Getter that returns a new StyledString with yellow background color.
*/
bgYellow!: StyledString;
/**
* @description Applies blue background color to the text.
* @summary Getter that returns a new StyledString with blue background color.
*/
bgBlue!: StyledString;
/**
* @description Applies magenta background color to the text.
* @summary Getter that returns a new StyledString with magenta background color.
*/
bgMagenta!: StyledString;
/**
* @description Applies cyan background color to the text.
* @summary Getter that returns a new StyledString with cyan background color.
*/
bgCyan!: StyledString;
/**
* @description Applies white background color to the text.
* @summary Getter that returns a new StyledString with white background color.
*/
bgWhite!: StyledString;
/**
* @description Applies bright black (gray) background color to the text.
* @summary Getter that returns a new StyledString with bright black background color.
*/
bgBrightBlack!: StyledString;
/**
* @description Applies bright red background color to the text.
* @summary Getter that returns a new StyledString with bright red background color.
*/
bgBrightRed!: StyledString;
/**
* @description Applies bright green background color to the text.
* @summary Getter that returns a new StyledString with bright green background color.
*/
bgBrightGreen!: StyledString;
/**
* @description Applies bright yellow background color to the text.
* @summary Getter that returns a new StyledString with bright yellow background color.
*/
bgBrightYellow!: StyledString;
/**
* @description Applies bright blue background color to the text.
* @summary Getter that returns a new StyledString with bright blue background color.
*/
bgBrightBlue!: StyledString;
/**
* @description Applies bright magenta background color to the text.
* @summary Getter that returns a new StyledString with bright magenta background color.
*/
bgBrightMagenta!: StyledString;
/**
* @description Applies bright cyan background color to the text.
* @summary Getter that returns a new StyledString with bright cyan background color.
*/
bgBrightCyan!: StyledString;
/**
* @description Applies bright white background color to the text.
* @summary Getter that returns a new StyledString with bright white background color.
*/
bgBrightWhite!: StyledString;
/**
* @description Resets all styling applied to the text.
* @summary Getter that returns a new StyledString with all styling reset.
*/
reset!: StyledString;
/**
* @description Applies bold style to the text.
* @summary Getter that returns a new StyledString with bold style.
*/
bold!: StyledString;
/**
* @description Applies dim (decreased intensity) style to the text.
* @summary Getter that returns a new StyledString with dim style.
*/
dim!: StyledString;
/**
* @description Applies italic style to the text.
* @summary Getter that returns a new StyledString with italic style.
*/
italic!: StyledString;
/**
* @description Applies underline style to the text.
* @summary Getter that returns a new StyledString with underline style.
*/
underline!: StyledString;
/**
* @description Applies blinking style to the text.
* @summary Getter that returns a new StyledString with blinking style.
*/
blink!: StyledString;
/**
* @description Inverts the foreground and background colors of the text.
* @summary Getter that returns a new StyledString with inverted colors.
*/
inverse!: StyledString;
/**
* @description Hides the text (same color as background).
* @summary Getter that returns a new StyledString with hidden text.
*/
hidden!: StyledString;
/**
* @description Applies strikethrough style to the text.
* @summary Getter that returns a new StyledString with strikethrough style.
*/
strikethrough!: StyledString;
/**
* @description Applies double underline style to the text.
* @summary Getter that returns a new StyledString with double underline style.
*/
doubleUnderline!: StyledString;
/**
* @description Resets the text color to normal intensity.
* @summary Getter that returns a new StyledString with normal color intensity.
*/
normalColor!: StyledString;
/**
* @description Removes italic or fraktur style from the text.
* @summary Getter that returns a new StyledString with italic or fraktur style removed.
*/
noItalicOrFraktur!: StyledString;
/**
* @description Removes underline style from the text.
* @summary Getter that returns a new StyledString with underline style removed.
*/
noUnderline!: StyledString;
/**
* @description Removes blinking style from the text.
* @summary Getter that returns a new StyledString with blinking style removed.
*/
noBlink!: StyledString;
/**
* @description Removes color inversion from the text.
* @summary Getter that returns a new StyledString with color inversion removed.
*/
noInverse!: StyledString;
/**
* @description Removes hidden style from the text.
* @summary Getter that returns a new StyledString with hidden style removed.
*/
noHidden!: StyledString;
/**
* @description Removes strikethrough style from the text.
* @summary Getter that returns a new StyledString with strikethrough style removed.
*/
noStrikethrough!: StyledString;
/**
* @description The text
* @summary The styled text as a regular string.
*/
text!: string;
constructor(text: string) {
this.text = text;
// Basic colors
Object.entries(StandardForegroundColors).forEach(([name, code]) => {
Object.defineProperty(this, name, {
get: () => this.foreground(code),
});
});
Object.entries(BrightForegroundColors).forEach(([name, code]) => {
Object.defineProperty(this, name, {
get: () => this.foreground(code),
});
});
// Background colors
Object.entries(StandardBackgroundColors).forEach(([name, code]) => {
Object.defineProperty(this, name, {
get: () => this.background(code),
});
});
Object.entries(BrightBackgroundColors).forEach(([name, code]) => {
Object.defineProperty(this, name, {
get: () => this.background(code),
});
});
// Styles
Object.entries(styles).forEach(([name, code]) => {
Object.defineProperty(this, name, {
get: () => this.style(code),
});
});
}
/**
* @description Clears all styling from the text.
* @summary Removes all ANSI color and style codes from the text.
* @return {StyledString} The StyledString instance with cleared styling.
*/
clear(): StyledString {
this.text = clear(this.text);
return this;
}
/**
* @description Applies raw ANSI codes to the text.
* @summary Allows direct application of ANSI escape sequences to the text.
* @param {string} rawAnsi - The raw ANSI escape sequence to apply.
* @return {StyledString} The StyledString instance with the raw ANSI code applied.
*/
raw(rawAnsi: string): StyledString {
this.text = raw(this.text, rawAnsi);
return this;
}
/**
* @description Applies a foreground color to the text.
* @summary Sets the text color using ANSI color codes.
* @param {number} n - The ANSI color code for the foreground color.
* @return {StyledString} The StyledString instance with the foreground color applied.
*/
foreground(n: number): StyledString {
this.text = colorizeANSI(this.text, n);
return this;
}
/**
* @description Applies a background color to the text.
* @summary Sets the background color of the text using ANSI color codes.
* @param {number} n - The ANSI color code for the background color.
* @return {StyledString} The StyledString instance with the background color applied.
*/
background(n: number): StyledString {
this.text = colorizeANSI(this.text, n, true);
return this;
}
/**
* @description Applies a text style to the string.
* @summary Sets text styles such as bold, italic, or underline using ANSI style codes.
* @param {number | string} n - The style code or key from the styles object.
* @return {StyledString} The StyledString instance with the style applied.
*/
style(n: number | keyof typeof styles): StyledString {
if (typeof n === "string" && !(n in styles)) {
console.warn(`Invalid style: ${n}`);
return this;
}
this.text = applyStyle(this.text, n);
return this;
}
/**
* @description Applies a 256-color foreground color to the text.
* @summary Sets the text color using the extended 256-color palette.
* @param {number} n - The color number from the 256-color palette.
* @return {StyledString} The StyledString instance with the 256-color foreground applied.
*/
color256(n: number): StyledString {
this.text = colorize256(this.text, n);
return this;
}
/**
* @description Applies a 256-color background color to the text.
* @summary Sets the background color using the extended 256-color palette.
* @param {number} n - The color number from the 256-color palette.
* @return {StyledString} The StyledString instance with the 256-color background applied.
*/
bgColor256(n: number): StyledString {
this.text = colorize256(this.text, n, true);
return this;
}
/**
* @description Applies an RGB foreground color to the text.
* @summary Sets the text color using RGB values.
* @param {number} r - The red component (0-255).
* @param {number} g - The green component (0-255).
* @param {number} b - The blue component (0-255).
* @return {StyledString} The StyledString instance with the RGB foreground color applied.
*/
rgb(r: number, g: number, b: number): StyledString {
this.text = colorizeRGB(this.text, r, g, b);
return this;
}
/**
* @description Applies an RGB background color to the text.
* @summary Sets the background color using RGB values.
* @param {number} r - The red component (0-255).
* @param {number} g - The green component (0-255).
* @param {number} b - The blue component (0-255).
* @return {StyledString} The StyledString instance with the RGB background color applied.
*/
bgRgb(r: number, g: number, b: number): StyledString {
this.text = colorizeRGB(this.text, r, g, b, true);
return this;
}
/**
* @description Converts the StyledString to a regular string.
* @summary Returns the underlying text with all applied styling.
* @return {string} The styled text as a regular string.
*/
toString(): string {
return this.text;
}
}
/**
* @description Applies styling to a given text string.
* @summary This function takes a string and returns a StyledString object, which is an enhanced
* version of the original string with additional methods for applying various ANSI color and style
* options. It sets up a mapper object with methods for different styling operations and then
* defines properties on the text string to make these methods accessible.
*
* @param {string[]} t The input text to be styled.
* @return {StyledString} A StyledString object with additional styling methods.
*
* @function style
*
* @memberOf StyledString
*/
export function style(...t: string[]): StyledString {
return new StyledString(t.join(" "));
} |