Another logger in JS. This one offers a console.log-like API and formatting, colored lines and timestamps (or not if desired), all that with 0 dependencies.

Commit 560ca4a8

560ca4a8826cMerged

Maxence Lecanu <[email protected]> · 1 year ago · 1 file · ~1 modified

Description

feat: add method and docstrings to hellog class

Details

Commit
560ca4a8826c
Parent
0b301598e020

lib/hellog.tsmodifiedView file

@@ -15,7 +15,42 @@
1515 meta?: Record<string, string>;
1616 }
1717
18+/**
19+ * A simple logger.
20+ *
21+ * See {@link HellogOptions} for configuration options.
22+ *
23+ * See {@link HellogPlugin} for plugin interface.
24+ *
25+ * @example
26+ * ```typescript
27+ * import { Hellog } from './hellog.js';
28+ * const logger = new Hellog({maxLevel: HellogLevel.ERROR});
29+ *
30+ * logger.trace('This is a trace message.');
31+ * logger.info('Hello, world!');
32+ * ```
33+ * @example
34+ * ```typescript
35+ * import { Hellog } from './hellog.js';
36+ *
37+ * const logger = new Hellog({
38+ * level: HellogLevel.ERROR,
39+ * plugins: [
40+ * new HellogLineBreakDefaultPlugin(),
41+ * new HellogPrettyDefaultPlugin(),
42+ * new HellogColorizeDefaultPlugin(),
43+ * new HellogStdoutDefaultPlugin(),
44+ * ],
45+ * meta: {
46+ * service: 'my-service',
47+ * },
48+ * });
49+ */
1850 export class Hellog {
51+ /**
52+ * Default plugins used by the logger when none are provided.
53+ */
1954 static DefaultPlugins = [
2055 new HellogLineBreakDefaultPlugin(),
2156 new HellogPrettyDefaultPlugin(),
@@ -37,12 +72,25 @@
3772 return this.options?.meta ?? {};
3873 }
3974
40- private _log(data: unknown, level: HellogLevel): void {
75+ /**
76+ * Add a plugin to the logger.
77+ *
78+ * @param plugin {@link HellogPlugin} The plugin to add to the logger.
79+ * @returns
80+ */
81+ with(plugin: HellogPlugin): Hellog {
82+ return new Hellog({
83+ ...this.options,
84+ plugins: [...this.plugins, plugin],
85+ });
86+ }
87+
88+ private _log(data: unknown[], level: HellogLevel): void {
4189 if (HellogLevelOrder[level] < HellogLevelOrder[this.maxLevel]) return;
4290
4391 let messages: HellogMessage[] = [
4492 {
45- content: format(data),
93+ content: format(...data),
4694 timestamp: new Date(),
4795 level,
4896 meta: this.meta,
@@ -60,23 +108,23 @@
60108 }
61109 }
62110
63- trace(data: unknown): void {
111+ trace(...data: unknown[]): void {
64112 this._log(data, HellogLevel.TRACE);
65113 }
66114
67- debug(data: unknown): void {
115+ debug(...data: unknown[]): void {
68116 this._log(data, HellogLevel.DEBUG);
69117 }
70118
71- info(data: unknown): void {
119+ info(...data: unknown[]): void {
72120 this._log(data, HellogLevel.INFO);
73121 }
74122
75- warn(data: unknown): void {
123+ warn(...data: unknown[]): void {
76124 this._log(data, HellogLevel.WARN);
77125 }
78126
79- error(data: unknown): void {
127+ error(...data: unknown[]): void {
80128 this._log(data, HellogLevel.ERROR);
81129 }
82130 }