@ricdotnet/logger 0.0.8 → 0.0.11

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.
Files changed (11) hide show
  1. package/Logs/29-8-2022-error.log +24 -0
  2. package/Logs/29-8-2022-info.log +27 -0
  3. package/Logs/29-8-2022-warn.log +33 -0
  4. package/Tests/Logger.spec.ts +55 -0
  5. package/dist/src/Logger.d.ts +1 -0
  6. package/dist/src/Logger.js +18 -8
  7. package/dist/src/Logger.js.map +1 -1
  8. package/dist/src/Types.d.ts +1 -0
  9. package/package.json +1 -1
  10. package/src/Logger.ts +18 -8
  11. package/src/Types.ts +1 -0
package/Logs/29-8-2022-error.log ADDED
@@ -0,0 +1,24 @@
1
+ Log Time: 11:13
2
+ hello world
3
+
4
+ Log Time: 11:13
5
+ hello world
6
+
7
+ Log Time: 11:14
8
+ hello world
9
+
10
+ Log Time: 11:15
11
+ hello world
12
+
13
+ Log Time: 11:18
14
+ hello world
15
+
16
+ Log Time: 11:19
17
+ hello world
18
+
19
+ Log Time: 11:19
20
+ hello world
21
+
22
+ Log Time: 11:20
23
+ hello world
24
+
package/Logs/29-8-2022-info.log ADDED
@@ -0,0 +1,27 @@
1
+ Log Time: 11:13
2
+ hello world
3
+
4
+ Log Time: 11:13
5
+ Logs folder generated.
6
+
7
+ Log Time: 11:13
8
+ hello world
9
+
10
+ Log Time: 11:14
11
+ hello world
12
+
13
+ Log Time: 11:15
14
+ hello world
15
+
16
+ Log Time: 11:18
17
+ hello world
18
+
19
+ Log Time: 11:19
20
+ hello world
21
+
22
+ Log Time: 11:19
23
+ hello world
24
+
25
+ Log Time: 11:20
26
+ hello world
27
+
package/Logs/29-8-2022-warn.log ADDED
@@ -0,0 +1,33 @@
1
+ Log Time: 11:13
2
+ hello world
3
+
4
+ Log Time: 11:13
5
+ hello world
6
+
7
+ Log Time: 11:14
8
+ hello world
9
+
10
+ Log Time: 11:15
11
+ hello world
12
+
13
+ Log Time: 11:17
14
+ hello world
15
+
16
+ Log Time: 11:17
17
+ hello world
18
+
19
+ Log Time: 11:17
20
+ hello world
21
+
22
+ Log Time: 11:18
23
+ hello world
24
+
25
+ Log Time: 11:19
26
+ hello world
27
+
28
+ Log Time: 11:19
29
+ hello world
30
+
31
+ Log Time: 11:20
32
+ hello world
33
+
package/Tests/Logger.spec.ts ADDED
@@ -0,0 +1,55 @@
1
+ import { Logger } from '../src/Logger';
2
+ import { Constants } from '../src/Constants';
3
+
4
+
5
+ // const loggerSpy = {
6
+ // info: jest.spyOn(Logger.getInstance(), 'info'),
7
+ // warn: jest.spyOn(Logger.getInstance(), 'warn'),
8
+ // error: jest.spyOn(Logger.getInstance(), 'error')
9
+ // };
10
+
11
+ const consoleSpy = {
12
+ info: jest.spyOn(console, 'log'),
13
+ warn: jest.spyOn(console, 'warn'),
14
+ error: jest.spyOn(console, 'error'),
15
+ };
16
+
17
+ describe('Logger test', () => {
18
+ let loggerInstance;
19
+ let loggerSpy;
20
+
21
+ beforeEach(() => {
22
+ loggerInstance = new Logger();
23
+
24
+ loggerSpy = {
25
+ info: jest.spyOn(loggerInstance, 'info'),
26
+ warn: jest.spyOn(loggerInstance, 'warn'),
27
+ error: jest.spyOn(loggerInstance, 'error')
28
+ };
29
+
30
+ loggerSpy.info.mockClear();
31
+ loggerSpy.warn.mockClear();
32
+ loggerSpy.error.mockClear();
33
+ });
34
+
35
+ it('can log an info', async () => {
36
+ await loggerInstance.info('hello world');
37
+
38
+ await expect(loggerSpy.info).toHaveBeenCalledWith('hello world');
39
+ await expect(consoleSpy.info).toHaveBeenCalledWith(`${Constants.TEXT_BLUE}[INFO]: hello world`);
40
+ });
41
+
42
+ it('can log a warning', () => {
43
+ loggerInstance.warn('hello world');
44
+
45
+ expect(loggerSpy.warn).toHaveBeenCalledWith('hello world');
46
+ // expect(consoleSpy.warn).toHaveBeenCalledWith(`${Constants.TEXT_YELLOW}[WARN]: hello world`);
47
+ });
48
+
49
+ it('can log an error', () => {
50
+ loggerInstance.error('hello world');
51
+
52
+ expect(loggerSpy.error).toHaveBeenCalledWith('hello world');
53
+ expect(consoleSpy.error).toHaveBeenCalledWith(`${Constants.TEXT_RED}[ERROR]: hello world`);
54
+ });
55
+ });
package/dist/src/Logger.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { ILogger, Primitives } from './Types';
2
2
  export declare class Logger {
3
3
  private readonly logDir;
4
+ private readonly logToConsole;
4
5
  constructor(options?: ILogger);
5
6
  checkLogDir(): Promise<void>;
6
7
  info<T = string>(message: T | Primitives): Promise<void>;
package/dist/src/Logger.js CHANGED
@@ -6,8 +6,10 @@ const path = require("path");
6
6
  const Constants_1 = require("./Constants");
7
7
  class Logger {
8
8
  logDir;
9
+ logToConsole;
9
10
  constructor(options) {
10
11
  this.logDir = path.join(process.cwd(), options?.directory ?? 'Logs');
12
+ this.logToConsole = options?.logToConsole ?? true;
11
13
  this.checkLogDir();
12
14
  }
13
15
  async checkLogDir() {
@@ -20,16 +22,22 @@ class Logger {
20
22
  }
21
23
  }
22
24
  async info(message) {
23
- await this.writeToFile(message, 'info');
24
- console.log(`${Constants_1.Constants.TEXT_BLUE}[INFO]: ${message}`);
25
+ await this.writeToFile(JSON.stringify(message), 'info');
26
+ if (this.logToConsole) {
27
+ console.log(`${Constants_1.Constants.TEXT_BLUE}[INFO]:${Constants_1.Constants.RESET} ${JSON.stringify(message)}`);
28
+ }
25
29
  }
26
30
  async warn(message) {
27
- await this.writeToFile(message, 'warn');
28
- console.warn(`${Constants_1.Constants.TEXT_YELLOW}[WARN]: ${message}`);
31
+ await this.writeToFile(JSON.stringify(message), 'warn');
32
+ if (this.logToConsole) {
33
+ console.warn(`${Constants_1.Constants.TEXT_YELLOW}[WARN]:${Constants_1.Constants.RESET} ${JSON.stringify(message)}`);
34
+ }
29
35
  }
30
36
  async error(message) {
31
- await this.writeToFile(message, 'error');
32
- console.error(`${Constants_1.Constants.TEXT_RED}[ERROR]: ${message}`);
37
+ await this.writeToFile(JSON.stringify(message), 'error');
38
+ if (this.logToConsole) {
39
+ console.error(`${Constants_1.Constants.TEXT_RED}[ERROR]:${Constants_1.Constants.RESET} ${JSON.stringify(message)}`);
40
+ }
33
41
  }
34
42
  async writeToFile(message, type) {
35
43
  const DAY = new Date().getDate();
@@ -47,8 +55,10 @@ class Logger {
47
55
  const data = 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
48
56
  await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
49
57
  }
50
- const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
51
- await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
58
+ if (logFile) {
59
+ const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
60
+ await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
61
+ }
52
62
  }
53
63
  }
54
64
  exports.Logger = Logger;
package/dist/src/Logger.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Logger.js","sourceRoot":"./","sources":["src/Logger.ts"],"names":[],"mappings":";;;AAAA,kCAAkC;AAClC,6BAA6B;AAC7B,2CAAwC;AAGxC,MAAa,MAAM;IAEA,MAAM,CAAS;IAEhC,YAAY,OAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,WAAW;QACf,IAAI;YACF,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,MAAM,IAAI,CAAC,IAAI,CAAC,sCAAsC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SACtE;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,CAAC,IAAI,CAAC,2CAA2C,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SAC3E;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAa,OAAuB;QAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,GAAG,qBAAS,CAAC,SAAS,WAAW,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,IAAI,CAAa,OAAuB;QAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,GAAG,qBAAS,CAAC,WAAW,WAAW,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,KAAK,CAAa,OAAuB;QAC7C,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzC,OAAO,CAAC,KAAK,CAAC,GAAG,qBAAS,CAAC,QAAQ,YAAY,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAY,EAAE,IAAY;QAC1C,MAAM,GAAG,GAAW,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACzC,MAAM,KAAK,GAAW,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAChD,MAAM,IAAI,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAW,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAW,IAAI,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;QAEhD,MAAM,SAAS,GAAW,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,SAAS,GAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAErD,IAAI,OAAO,CAAC;QACZ,IAAI;YACF,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC;SACjF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;YAChE,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;SAC9E;QAED,MAAM,IAAI,GAAG,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;QAC1E,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;IAC/E,CAAC;CAEF;AAvDD,wBAuDC"}
1
+ {"version":3,"file":"Logger.js","sourceRoot":"./","sources":["src/Logger.ts"],"names":[],"mappings":";;;AAAA,kCAAkC;AAClC,6BAA6B;AAC7B,2CAAwC;AAGxC,MAAa,MAAM;IAEA,MAAM,CAAS;IACf,YAAY,CAAU;IAEvC,YAAY,OAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,CAAC;QACrE,IAAI,CAAC,YAAY,GAAG,OAAO,EAAE,YAAY,IAAI,IAAI,CAAC;QAClD,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,WAAW;QACf,IAAI;YACF,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,MAAM,IAAI,CAAC,IAAI,CAAC,sCAAsC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SACtE;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,CAAC,IAAI,CAAC,2CAA2C,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SAC3E;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAa,OAAuB;QAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,GAAG,CAAC,GAAG,qBAAS,CAAC,SAAS,UAAU,qBAAS,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAC3F;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAa,OAAuB;QAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,IAAI,CAAC,GAAG,qBAAS,CAAC,WAAW,UAAU,qBAAS,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAC9F;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAa,OAAuB;QAC7C,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QACzD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,OAAO,CAAC,KAAK,CAAC,GAAG,qBAAS,CAAC,QAAQ,WAAW,qBAAS,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAC7F;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAY,EAAE,IAAY;QAC1C,MAAM,GAAG,GAAW,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACzC,MAAM,KAAK,GAAW,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAChD,MAAM,IAAI,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAW,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAW,IAAI,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;QAEhD,MAAM,SAAS,GAAW,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,SAAS,GAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAErD,IAAI,OAAO,CAAC;QACZ,IAAI;YACF,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC;SACjF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;YAChE,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;SAC9E;QAED,IAAI,OAAO,EAAE;YACX,MAAM,IAAI,GAAG,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;YAC1E,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,IAAI,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;SAC9E;IACH,CAAC;CAEF;AAjED,wBAiEC"}
package/dist/src/Types.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export declare type Primitives = string | number | object;
2
2
  export interface ILogger {
3
3
  directory?: string;
4
+ logToConsole?: boolean;
4
5
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ricdotnet/logger",
3
- "version": "0.0.8",
3
+ "version": "0.0.11",
4
4
  "description": "A logger utility for my personal projects.",
5
5
  "main": "index.js",
6
6
  "scripts": {
package/src/Logger.ts CHANGED
@@ -6,9 +6,11 @@ import { ILogger, Primitives } from './Types';
6
6
  export class Logger {
7
7
 
8
8
  private readonly logDir: string;
9
+ private readonly logToConsole: boolean;
9
10
 
10
11
  constructor(options?: ILogger) {
11
12
  this.logDir = path.join(process.cwd(), options?.directory ?? 'Logs');
13
+ this.logToConsole = options?.logToConsole ?? true;
12
14
  this.checkLogDir();
13
15
  }
14
16
 
@@ -22,18 +24,24 @@ export class Logger {
22
24
  }
23
25
 
24
26
  async info<T = string>(message: T | Primitives) {
25
- await this.writeToFile(message, 'info');
26
- console.log(`${Constants.TEXT_BLUE}[INFO]: ${message}`);
27
+ await this.writeToFile(JSON.stringify(message), 'info');
28
+ if (this.logToConsole) {
29
+ console.log(`${Constants.TEXT_BLUE}[INFO]:${Constants.RESET} ${JSON.stringify(message)}`);
30
+ }
27
31
  }
28
32
 
29
33
  async warn<T = string>(message: T | Primitives) {
30
- await this.writeToFile(message, 'warn');
31
- console.warn(`${Constants.TEXT_YELLOW}[WARN]: ${message}`);
34
+ await this.writeToFile(JSON.stringify(message), 'warn');
35
+ if (this.logToConsole) {
36
+ console.warn(`${Constants.TEXT_YELLOW}[WARN]:${Constants.RESET} ${JSON.stringify(message)}`);
37
+ }
32
38
  }
33
39
 
34
40
  async error<T = string>(message: T | Primitives) {
35
- await this.writeToFile(message, 'error');
36
- console.error(`${Constants.TEXT_RED}[ERROR]: ${message}`);
41
+ await this.writeToFile(JSON.stringify(message), 'error');
42
+ if (this.logToConsole) {
43
+ console.error(`${Constants.TEXT_RED}[ERROR]:${Constants.RESET} ${JSON.stringify(message)}`);
44
+ }
37
45
  }
38
46
 
39
47
  async writeToFile(message: any, type: string) {
@@ -54,8 +62,10 @@ export class Logger {
54
62
  await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
55
63
  }
56
64
 
57
- const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
58
- await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
65
+ if (logFile) {
66
+ const data = logFile + 'Log Time: ' + FULL_TIME + '\n' + message + '\n\n';
67
+ await fs.writeFile(path.join(this.logDir, `${FULL_DATE}-${type}.log`), data);
68
+ }
59
69
  }
60
70
 
61
71
  }
package/src/Types.ts CHANGED
@@ -2,4 +2,5 @@ export type Primitives = string | number | object;
2
2
 
3
3
  export interface ILogger {
4
4
  directory?: string;
5
+ logToConsole?: boolean;
5
6
  }