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 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 | 11x 11x 11x 11x 21x 21x 120x 68x 1x 47x 47x 47x 39x 33x 8x 41x 35x 35x 35x 35x 6x 6x 6x 6x 5x 6x 6x 5x 6x 6x 5x 6x 6x 5x 35x 29x 24x 1x 153x 16x 27x 22x 26x 22x | // Externals
import { strict as assert } from "assert";
import { promises } from "fs";
const { writeFile } = promises;
// Internals
import { INVALID_TYPE, NO_LOGS_PATH } from "./errors";
import { COLORS } from "./colors";
/**
*
* Array of all possible console log levels
*
*/
export const CONSOLE_LEVELS = ["log", "warn", "error"] as const;
/**
*
* The possible console log levels (log, warn, or error)
*
*/
export type ConsoleLevel = typeof CONSOLE_LEVELS[number];
/**
*
* Array of all possible log types
*
*/
export const LOG_TYPES = ["success", "info", "error", "warn"] as const;
/**
*
* The type of log (success, info, warn, or error)
*
*/
export type LogType = typeof LOG_TYPES[number];
/**
*
* Logger constructor options
*
*/
export type LoggerConstructorOptions = {
logsPath?: string;
};
/**
*
* The message to log
*
*/
export type LogMessage = unknown;
/**
*
* The timestamp (in ms) of the log
*
*/
export type LogTimestamp = number;
/**
*
* The index of the log (0-based)
*
*/
export type LogIndex = number;
/**
*
* The extra information to write to the output file (will not be logged)
*
*/
export type LogExtra = unknown;
/**
*
* Log options with writeToFile enabled
*
*/
export type LogOptionsWithWrite = {
writeToFile?: true;
type?: LogType;
extra?: LogExtra;
};
/**
*
* Log options with writeToFile disabled
*
*/
export type LogOptionsWithoutWrite = {
writeToFile: false;
type?: LogType;
};
/**
*
* Log options (writeToFile, type, extra)
*
*/
export type LogOptions = LogOptionsWithWrite | LogOptionsWithoutWrite;
/**
*
* Log options with writeToFile enabled and without type parameter
*
*/
export type LogOptionsWithWriteWithoutType = Omit<LogOptionsWithWrite, "type">;
/**
*
* Log options with writeToFile disabled and without type parameter
*
*/
export type LogOptionsWithoutWriteWithoutType = Omit<
LogOptionsWithoutWrite,
"type"
>;
/**
*
* Log options without type parameter (writeToFile, extra)
*
*/
export type LogOptionsWithoutType =
| LogOptionsWithWriteWithoutType
| LogOptionsWithoutWriteWithoutType;
/**
*
* Structure of all logs created by non-static log methods
*
*/
export type Log = {
message: LogMessage;
timestamp: LogTimestamp;
index: LogIndex;
type?: LogType;
extra?: LogExtra;
};
export class Logger {
/**
*
* ANSI Escape Sequences
*
* @example
* ```javascript
* console.log(Logger.COLORS.Dim + "Dim log" + Logger.COLORS.Reset);
* ```
*/
public static readonly COLORS = COLORS;
/**
*
* The output file path
*
*/
private _logsPath?: string;
/**
*
* All logs that have been output by this Logger instance
*
*/
private _logs: Log[];
/**
*
* Creates a new Logger instance
*
* @param logsPath - The output file path
* @example
* ```javascript
* const logger = new Logger({ logsPath: __dirname + "/logs.json" });
* ```
*/
constructor(options?: LoggerConstructorOptions) {
this._logsPath = options?.logsPath;
this._logs = [];
}
/**
*
* All logs that have been output by this Logger instance
*
* @example
* ```javascript
* const logs = logger.logs;
* ```
*/
public get logs(): Log[] {
return this._logs;
}
/**
*
* The output file path
*
* @example
* ```javascript
* const logsPath = logger.logsPath;
* ```
*/
public get logsPath(): InstanceType<typeof Logger>["_logsPath"] {
return this._logsPath;
}
/**
*
* The output file path
*
* @example
* ```javascript
* logger.logsPath = __dirname + "/logs.json";
* ```
*/
public set logsPath(logsPath: InstanceType<typeof Logger>["_logsPath"]) {
this._logsPath = logsPath;
}
/**
*
* Logs a message to the console and writes to the output file path
*
* @param message - The message to log
* @example
* ```javascript
* await logger.log("Hello");
* ```
* @example
* ```javascript
* await logger.log(2);
* ```
* @example
* ```javascript
* await logger.log(["hi!", 4, ["nested string"]]);
* ```
*/
public log(message: LogMessage): Promise<Log>;
/**
*
* Logs a message to the console and DOES NOT write to the output file path
*
* @param message - The message to log
* @param logOptions - Logging options
* @example
* ```javascript
* await logger.log(31, {
* writeToFile: false,
* });
* ```
* @example
* ```javascript
* await logger.log("Hello", {
* writeToFile: false,
* type: "error",
* });
* ```
*/
public log(message: LogMessage, logOptions: LogOptionsWithoutWrite): Log;
/**
*
* Logs a message to the console and writes to the output file path
*
* @param message - The message to log
* @param logOptions - Logging options
* @example
* ```javascript
* await logger.log("Hello", {
* writeToFile: true,
* });
* ```
* @example
* ```javascript
* await logger.log(["hi", "hello"], {
* writeToFile: true,
* type: "success",
* });
* ```
* @example
* ```javascript
* await logger.log(32, {
* type: "info",
* extra: "this part is not logged"
* });
* ```
*/
public log(
message: LogMessage,
logOptions: LogOptionsWithWrite
): Promise<Log>;
public log(message: LogMessage, logOptions?: LogOptions): Promise<Log> | Log {
const { type } = logOptions ?? {};
let log: Log = {
timestamp: Date.now(),
index: this.logs.length,
message,
type,
};
if (type) {
assert.ok(LOG_TYPES.includes(type), INVALID_TYPE);
Logger[type](message);
} else Logger.log(message);
if (!(logOptions && logOptions.writeToFile === false)) {
const { extra } = logOptions ?? {};
log = { ...log, extra };
this.logs.push(log);
return this.writeLogs().then(() => log);
}
this.logs.push(log);
return log;
}
/**
*
* Logs a success message to the console and writes to the output file path
*
* @param message - The success message to log
* @example
* ```javascript
* await logger.success("Hello");
* ```
* @example
* ```javascript
* await logger.success(2);
* ```
* @example
* ```javascript
* await logger.success(["hi!", 4, ["nested string"]]);
* ```
*/
public success(message: LogMessage): Promise<Log>;
/**
*
* Logs a success message to the console and DOES NOT write to the output file path
*
* @param message - The success message to log
* @param logOptions - Logging options
* @example
* ```javascript
* await logger.success("Hello", {
* writeToFile: false,
* });
* ```
*/
public success(
message: LogMessage,
logOptions: LogOptionsWithoutWriteWithoutType
): Log;
/**
*
* Logs a success message to the console and writes to the output file path
*
* @param message - The success message to log
* @param logOptions - Logging options
* @example
* ```javascript
* await logger.success("Hello", {
* writeToFile: true,
* });
* ```
* @example
* ```javascript
* await logger.success(32, {
* extra: "this part is not logged"
* });
* ```
*/
public success(
message: LogMessage,
logOptions: LogOptionsWithWriteWithoutType
): Promise<Log>;
public success(
message: LogMessage,
logOptions?: LogOptionsWithoutType
): Promise<Log> | Log {
const options: LogOptions = {
...logOptions,
type: "success",
};
if (options.writeToFile === false) return this.log(message, options);
return this.log(message, options); // Same as above, but different overload and return value
}
/**
*
* Logs a success message to the console and writes to the output file path
*
* @param message - The info message to log
* @example
* ```javascript
* await logger.info("Hello");
* ```
* @example
* ```javascript
* await logger.info(2);
* ```
* @example
* ```javascript
* await logger.info(["hi!", 4, ["nested string"]]);
* ```
*/
public info(message: LogMessage): Promise<Log>;
/**
*
* Logs an info message to the console and DOES NOT write to the output file path
*
* @param message - The info message to log
* @param logOptions - Logging options
* @example
* ```javascript
* await logger.info("Hello", {
* writeToFile: false,
* });
* ```
*/
public info(
message: LogMessage,
logOptions: LogOptionsWithoutWriteWithoutType
): Log;
/**
*
* Logs an info message to the console and writes to the output file path
*
* @param message - The info message to log
* @param logOptions - Logging options
* @example
* ```javascript
* await logger.info("Hello", {
* writeToFile: true,
* });
* ```
* @example
* ```javascript
* await logger.info(32, {
* extra: "this part is not logged"
* });
* ```
*/
public info(
message: LogMessage,
logOptions: LogOptionsWithWriteWithoutType
): Promise<Log>;
public info(
message: LogMessage,
logOptions?: LogOptionsWithoutType
): Promise<Log> | Log {
const options: LogOptions = {
...logOptions,
type: "info",
};
if (options.writeToFile === false) return this.log(message, options);
return this.log(message, options); // Same as above, but different overload and return value
}
/**
*
* Logs a success message to the console and writes to the output file path
*
* @param message - The warn message to log
* @example
* ```javascript
* await logger.warn("Hello");
* ```
* @example
* ```javascript
* await logger.warn(2);
* ```
* @example
* ```javascript
* await logger.warn(["hi!", 4, ["nested string"]]);
* ```
*/
public warn(message: LogMessage): Promise<Log>;
/**
*
* Logs a warning message to the console and DOES NOT write to the output file path
*
* @param message - The warning message to log
* @param logOptions - Logging options
* @example
* ```javascript
* await logger.warn("Hello", {
* writeToFile: false,
* });
* ```
*/
public warn(
message: LogMessage,
logOptions: LogOptionsWithoutWriteWithoutType
): Log;
/**
*
* Logs a warning message to the console and writes to the output file path
*
* @param message - The warning message to log
* @param logOptions - Logging options
* @example
* ```javascript
* await logger.warn("Hello", {
* writeToFile: true,
* });
* ```
* @example
* ```javascript
* await logger.warn(32, {
* extra: "this part is not logged"
* });
* ```
*/
public warn(
message: LogMessage,
logOptions: LogOptionsWithWriteWithoutType
): Promise<Log>;
public warn(
message: LogMessage,
logOptions?: LogOptionsWithoutType
): Promise<Log> | Log {
const options: LogOptions = {
...logOptions,
type: "warn",
};
if (options.writeToFile === false) return this.log(message, options);
return this.log(message, options); // Same as above, but different overload and return value
}
/**
*
* Logs a success message to the console and writes to the output file path
*
* @param message - The error message to log
* @example
* ```javascript
* await logger.error("Hello");
* ```
* @example
* ```javascript
* await logger.error(2);
* ```
* @example
* ```javascript
* await logger.error(["hi!", 4, ["nested string"]]);
* ```
*/
public error(message: LogMessage): Promise<Log>;
/**
*
* Logs an error message to the console and DOES NOT write to the output file path
*
* @param message - The error message to log
* @param logOptions - Logging options
* @example
* ```javascript
* await logger.error("Hello", {
* writeToFile: false,
* });
* ```
*/
public error(
message: LogMessage,
logOptions: LogOptionsWithoutWriteWithoutType
): Log;
/**
*
* Logs an error message to the console and writes to the output file path
*
* @param message - The error message to log
* @param logOptions - Logging options
* @example
* ```javascript
* await logger.error("Hello", {
* writeToFile: true,
* });
* ```
* @example
* ```javascript
* await logger.error(32, {
* extra: "this part is not logged"
* });
* ```
*/
public error(
message: LogMessage,
logOptions: LogOptionsWithWriteWithoutType
): Promise<Log>;
public error(
message: LogMessage,
logOptions?: LogOptionsWithoutType
): Promise<Log> | Log {
const options: LogOptions = {
...logOptions,
type: "error",
};
if (options.writeToFile === false) return this.log(message, options);
return this.log(message, options); // Same as above, but different overload and return value
}
/**
*
* Writes the logs stored in `this.logs` to the output file
*
* @example
* ```javascript
* await logger.writeLogs();
* ```
*/
public writeLogs(): Promise<void> {
if (!this.logsPath) throw NO_LOGS_PATH;
return writeFile(this.logsPath, JSON.stringify(this.logs), "utf-8");
}
/**
*
* Logs to the console
*
* @param message - The message to log
* @param optionalParams - Substitution strings
* @example
* ```javascript
* Logger.log("hi");
* ```
* @example
* ```javascript
* Logger.log("hi %s", "Bill");
* ```
*/
public static log(message?: unknown, ...optionalParams: any[]): void {
console.log(message, ...optionalParams);
}
/**
*
* Logs an empty line to the console
*
* @example
* ```javascript
* Logger.line();
* ```
*/
public static line(): void {
console.log();
}
/**
*
* Logs a colored message to the console
*
* @param color - The color to log in
* @param message - The message to log
* @param afterColored - The optional message after the colored message (on the same line)
* @param consoleLevel - The console level to use (log, warn, or error)
* @example
* ```javascript
* Logger.coloredLog("BgBlue", "hi");
* ```
* @example
* ```javascript
* Logger.coloredLog("FgYellow", "hi", "this string will not be colored");
* ```
* @example
* ```javascript
* Logger.coloredLog("FgRed", "error!!!", "not colored", "error");
* ```
*/
public static coloredLog(
color: keyof typeof Logger.COLORS,
message: LogMessage,
afterColored = "",
consoleLevel: ConsoleLevel = "log"
): void {
console[consoleLevel](
`${this.COLORS[color]}${message}${this.COLORS.Reset}${afterColored}`
);
}
/**
*
* Logs a bold message
*
* @param message - The bold message to log
* @param afterColored - The optional message after the bold message (on the same line)
* @example
* ```javascript
* Logger.bold("BOLD!");
* ```
* @example
* ```javascript
* Logger.bold("BOLD!", "this part is not bold");
* ```
*/
public static bold(message: LogMessage, afterColored = ""): void {
return this.coloredLog("Bright", message, afterColored);
}
/**
*
* Logs a success message in green
*
* @param message - The success message to log
* @param afterColored - The optional message after the success message (on the same line)
* @example
* ```javascript
* Logger.success("SUCCESS!");
* ```
* @example
* ```javascript
* Logger.success("SUCCESS!", "this part is not green");
* ```
*/
public static success(message: LogMessage, afterColored = ""): void {
return this.coloredLog("FgGreen", message, afterColored);
}
/**
*
* Logs an info message in blue
*
* @param message - The info message to log
* @param afterColored - The optional message after the info message (on the same line)
* @example
* ```javascript
* Logger.info("information...");
* ```
* @example
* ```javascript
* Logger.info("information...", "this part is not blue");
* ```
*/
public static info(message: LogMessage, afterColored = ""): void {
return this.coloredLog("FgBlue", message, afterColored);
}
/**
*
* Logs a warning message in yellow
*
* @param message - The warning message to log
* @param afterColored - The optional message after the warning message (on the same line)
* @example
* ```javascript
* Logger.warn("WARNING!");
* ```
* @example
* ```javascript
* Logger.warn("WARNING!", "this part is not yellow");
* ```
*/
public static warn(message: LogMessage, afterColored = ""): void {
return this.coloredLog("FgYellow", message, afterColored, "warn");
}
/**
*
* Logs an error message in red
*
* @param message - The error message to log
* @param afterColored - The optional message after the error message (on the same line)
* @example
* ```javascript
* Logger.error("ERROR!");
* ```
* @example
* ```javascript
* Logger.error("ERROR!", "this part is not red");
* ```
*/
public static error(message: LogMessage, afterColored = ""): void {
return this.coloredLog("FgRed", message, afterColored, "error");
}
}
export { Output, OutputMessage } from "./output";
export default Logger;
|