hermodlog 1.8.0 → 1.9.0
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/package.json +3 -3
- package/src/Logger.js +9 -0
- package/src/Logger.spec.js +23 -23
- package/src/methods/submethod.js +0 -2
- package/src/methods/submodule.js +6 -0
- package/src/utils/log.js +12 -3
- package/usage.example.js +4 -1
package/package.json
CHANGED
@@ -1,11 +1,11 @@
|
|
1
1
|
{
|
2
2
|
"name": "hermodlog",
|
3
|
-
"version": "1.
|
3
|
+
"version": "1.9.0",
|
4
4
|
"description": "Simple contextual logger to simplify log display in heavy load context and provide easy parsing",
|
5
5
|
"main": "src/Logger.js",
|
6
6
|
"type": "module",
|
7
7
|
"scripts": {
|
8
|
-
"test": "
|
8
|
+
"test": "litest .",
|
9
9
|
"test:dev": "vitest --dir . --watch"
|
10
10
|
},
|
11
11
|
"repository": {
|
@@ -19,6 +19,6 @@
|
|
19
19
|
},
|
20
20
|
"homepage": "https://github.com/Alex-Werner/hermodlog#readme",
|
21
21
|
"devDependencies": {
|
22
|
-
"
|
22
|
+
"@scintilla-network/litest": "1.3.1"
|
23
23
|
}
|
24
24
|
}
|
package/src/Logger.js
CHANGED
@@ -14,6 +14,7 @@ import warn from "./methods/warn.js";
|
|
14
14
|
import fatal from "./methods/fatal.js";
|
15
15
|
import child from "./methods/child.js";
|
16
16
|
import submethod from "./methods/submethod.js";
|
17
|
+
import submodule from "./methods/submodule.js";
|
17
18
|
|
18
19
|
import LOG_COLORS from "./LOG_COLORS.js";
|
19
20
|
import object from "./methods/object.js";
|
@@ -60,6 +61,11 @@ class Logger {
|
|
60
61
|
writable: true,
|
61
62
|
enumerable: true
|
62
63
|
},
|
64
|
+
submoduleName: {
|
65
|
+
value: props.submoduleName ?? null,
|
66
|
+
writable: true,
|
67
|
+
enumerable: true
|
68
|
+
},
|
63
69
|
submethodName: {
|
64
70
|
value: props.submethodName ?? null,
|
65
71
|
writable: true,
|
@@ -99,6 +105,7 @@ class Logger {
|
|
99
105
|
const keepMethod = opts?.keepMethod ?? true;
|
100
106
|
const keepModule = opts?.keepModule ?? true;
|
101
107
|
const keepSubmethod = opts?.keepSubmethod ?? true;
|
108
|
+
const keepSubmodule = opts?.keepSubmodule ?? true;
|
102
109
|
const keepListener = opts?.keepListener ?? true;
|
103
110
|
const keepObject = opts?.keepObject ?? true;
|
104
111
|
|
@@ -110,6 +117,7 @@ class Logger {
|
|
110
117
|
contextName: (keepContext) ? this.contextName : opts.contextName ?? null,
|
111
118
|
methodName: (keepMethod) ? this.methodName : opts.methodName ?? null,
|
112
119
|
moduleName: (keepModule) ? this.moduleName : opts.moduleName ?? null,
|
120
|
+
submoduleName: (keepSubmodule) ? this.submoduleName : opts.submoduleName ?? null,
|
113
121
|
listenerName: (keepListener) ? this.listenerName : opts.listenerName ?? null,
|
114
122
|
submethodName: (keepSubmethod) ? this.submethodName : opts.submethodName ?? null,
|
115
123
|
objectName: (keepObject) ? this.objectName : opts.objectName ?? null,
|
@@ -156,6 +164,7 @@ Logger.prototype.log = log;
|
|
156
164
|
Logger.prototype.method = method;
|
157
165
|
Logger.prototype.object = object;
|
158
166
|
Logger.prototype.submethod = submethod;
|
167
|
+
Logger.prototype.submodule = submodule;
|
159
168
|
Logger.prototype.module = module;
|
160
169
|
Logger.prototype.trace = trace;
|
161
170
|
Logger.prototype.warn = warn;
|
package/src/Logger.spec.js
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import {
|
1
|
+
import {describe, expect, it} from '@scintilla-network/litest'
|
2
2
|
import Logger from "./Logger.js";
|
3
3
|
|
4
4
|
describe('Logger', () => {
|
@@ -7,51 +7,51 @@ describe('Logger', () => {
|
|
7
7
|
it('should create an logger', () => {
|
8
8
|
silentLogger = new Logger({date:new Date('2023-07-29T01:38:00.482Z')});
|
9
9
|
silentLogger._log = () => {}
|
10
|
-
|
10
|
+
expect(silentLogger.history.length).toBe(0)
|
11
11
|
silentLogger.log('Hello');
|
12
|
-
|
13
|
-
const expected = '[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] \u001b[32mHello\u001b[0m'
|
14
|
-
|
12
|
+
expect(silentLogger.history.length).toBe(1)
|
13
|
+
const expected = '[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] - \u001b[32mHello\u001b[0m'
|
14
|
+
expect(silentLogger.history[0]).toBe(expected)
|
15
15
|
})
|
16
16
|
it('should create an logger with module', () => {
|
17
17
|
silentModuleLogger = silentLogger.module('test-module')
|
18
18
|
silentModuleLogger.log('Hello');
|
19
|
-
|
20
|
-
const expected = '[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] module:\u001b[90mtest-module\u001b[0m \u001b[32mHello\u001b[0m'
|
21
|
-
|
19
|
+
expect(silentModuleLogger.history.length).toBe(1)
|
20
|
+
const expected = '[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] module:\u001b[90mtest-module\u001b[0m - \u001b[32mHello\u001b[0m'
|
21
|
+
expect(silentModuleLogger.history[0]).toBe(expected)
|
22
22
|
})
|
23
23
|
it('should create an logger with context', () => {
|
24
24
|
const silentContextLogger = silentModuleLogger.context('test-context')
|
25
25
|
silentContextLogger.log('Hello');
|
26
|
-
|
27
|
-
const expected = '[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] context: \u001b[94mtest-context\u001b[0m | module:\u001b[90mtest-module\u001b[0m \u001b[32mHello\u001b[0m'
|
28
|
-
|
26
|
+
expect(silentContextLogger.history.length).toBe(1)
|
27
|
+
const expected = '[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] context: \u001b[94mtest-context\u001b[0m | module:\u001b[90mtest-module\u001b[0m - \u001b[32mHello\u001b[0m'
|
28
|
+
expect(silentContextLogger.history[0]).toBe(expected)
|
29
29
|
})
|
30
30
|
it('should create an logger with listener', () => {
|
31
31
|
const silentListenerLogger = silentModuleLogger.listener('onTest')
|
32
32
|
silentListenerLogger.log('Hello');
|
33
|
-
|
34
|
-
const expected = '[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] module:\u001b[90mtest-module\u001b[0m | listener: \u001b[36monTest\u001b[0m \u001b[32mHello\u001b[0m'
|
35
|
-
|
33
|
+
expect(silentListenerLogger.history.length).toBe(1)
|
34
|
+
const expected = '[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] module:\u001b[90mtest-module\u001b[0m | listener: \u001b[36monTest\u001b[0m - \u001b[32mHello\u001b[0m'
|
35
|
+
expect(silentListenerLogger.history[0]).toBe(expected)
|
36
36
|
})
|
37
37
|
it('should create an logger with method', () => {
|
38
38
|
const silentMethodLogger = silentModuleLogger.method('test-method')
|
39
39
|
silentMethodLogger.log('Hello');
|
40
|
-
|
41
|
-
const expected = '[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] module:\u001b[90mtest-module\u001b[0m | method: \u001b[33mtest-method\u001b[0m \u001b[32mHello\u001b[0m'
|
42
|
-
|
40
|
+
expect(silentMethodLogger.history.length).toBe(1)
|
41
|
+
const expected = '[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] module:\u001b[90mtest-module\u001b[0m | method: \u001b[33mtest-method\u001b[0m - \u001b[32mHello\u001b[0m'
|
42
|
+
expect(silentMethodLogger.history[0]).toBe(expected)
|
43
43
|
})
|
44
44
|
it('should handle level', function () {
|
45
45
|
const levelLogger = new Logger({level: 'error'})
|
46
46
|
levelLogger._log = () => {}
|
47
47
|
levelLogger.error('Hello');
|
48
|
-
|
48
|
+
expect(levelLogger.history.length).toBe(1)
|
49
49
|
levelLogger.warn('Hello');
|
50
|
-
|
50
|
+
expect(levelLogger.history.length).toBe(1)
|
51
51
|
|
52
52
|
levelLogger.level = 'info'
|
53
53
|
levelLogger.trace('Hello');
|
54
|
-
|
54
|
+
expect(levelLogger.history.length).toBe(1)
|
55
55
|
});
|
56
56
|
|
57
57
|
it('should automatically beautify instead of [Object Object]', () => {
|
@@ -63,8 +63,8 @@ describe('Logger', () => {
|
|
63
63
|
req: 'getCar'
|
64
64
|
}
|
65
65
|
silentModuleLogger.log('Received from ws client', object)
|
66
|
-
|
67
|
-
const expected = `[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] module:\u001b[90mtest-module\u001b[0m \u001b[32mReceived from ws client\u001b[0m \u001b[32mObject(\u001b[0m\u001b[32m{\n \"x\": 42,\n \"y\": {\n \"b\": [\n 1,\n 2,\n 3\n ]\n },\n \"req\": \"getCar\"\n}\u001b[0m\u001b[32m)\u001b[0m`;
|
68
|
-
|
66
|
+
expect(silentModuleLogger.history.length).toBe(2)
|
67
|
+
const expected = `[\u001b[90m2023-07-29T01:38:00.482Z\u001b[0m] module:\u001b[90mtest-module\u001b[0m - \u001b[32mReceived from ws client\u001b[0m \u001b[32mObject(\u001b[0m\u001b[32m{\n \"x\": 42,\n \"y\": {\n \"b\": [\n 1,\n 2,\n 3\n ]\n },\n \"req\": \"getCar\"\n}\u001b[0m\u001b[32m)\u001b[0m`;
|
68
|
+
expect(silentModuleLogger.history[1]).toBe(expected)
|
69
69
|
});
|
70
70
|
})
|
package/src/methods/submethod.js
CHANGED
package/src/utils/log.js
CHANGED
@@ -37,11 +37,12 @@ export default function log(level, args, context) {
|
|
37
37
|
const hasListener = !!context.listenerName;
|
38
38
|
const hasMethod = !!context.methodName;
|
39
39
|
const hasSubmethod = !!context.submethodName;
|
40
|
+
const hasSubmodule = !!context.submoduleName;
|
40
41
|
const hasObject = !!context.objectName;
|
41
42
|
|
42
43
|
if (hasContext) {
|
43
44
|
message += ` context: ${colors[2](context.contextName)}`;
|
44
|
-
const hasNext = hasModule || hasListener || hasMethod || hasSubmethod;
|
45
|
+
const hasNext = hasModule || hasListener || hasMethod || hasSubmethod || hasSubmodule;
|
45
46
|
if (hasNext) {
|
46
47
|
message += ' |';
|
47
48
|
}
|
@@ -49,6 +50,14 @@ export default function log(level, args, context) {
|
|
49
50
|
|
50
51
|
if (hasModule) {
|
51
52
|
message += ` module:${colors[3](context.moduleName)}`;
|
53
|
+
const hasNext = hasListener || hasMethod || hasSubmethod || hasSubmodule;
|
54
|
+
if (hasNext) {
|
55
|
+
message += ' |';
|
56
|
+
}
|
57
|
+
}
|
58
|
+
|
59
|
+
if (hasSubmodule) {
|
60
|
+
message += ` submodule: ${colors[6](context.submoduleName)}`;
|
52
61
|
const hasNext = hasListener || hasMethod || hasSubmethod;
|
53
62
|
if (hasNext) {
|
54
63
|
message += ' |';
|
@@ -57,7 +66,7 @@ export default function log(level, args, context) {
|
|
57
66
|
|
58
67
|
if (hasMethod) {
|
59
68
|
message += ` method: ${colors[5](context.methodName)}`;
|
60
|
-
const hasNext = hasSubmethod;
|
69
|
+
const hasNext = hasSubmethod || hasSubmodule;
|
61
70
|
if (hasNext) {
|
62
71
|
message += ' |';
|
63
72
|
}
|
@@ -65,7 +74,7 @@ export default function log(level, args, context) {
|
|
65
74
|
|
66
75
|
if (hasSubmethod) {
|
67
76
|
message += ` submethod: ${colors[6](context.submethodName)}`;
|
68
|
-
const hasNext = hasListener || hasMethod;
|
77
|
+
const hasNext = hasListener || hasMethod || hasSubmodule;
|
69
78
|
if (hasNext) {
|
70
79
|
message += ' |';
|
71
80
|
}
|
package/usage.example.js
CHANGED