fix(logs): coloured logs (#465)

* refactor(logs): replace chalk by ansi-styles

* test(logs): fix the failing tests due to ansi styles

I was not able to disable or mock ansi-styles so instead I found a way to make the tests pass
it's not perfect but it's still nice because the logs will keep their trustful colour when running through the tests

* refactor(logs): simplify the syntax to colour the logs

* chore(rebase): update files due to rebase

* refactor(logger): reduce code duplication

src/classes/loggers/issue-logger.spec.ts

@@ -26,12 +26,17 @@ describe('IssueLogger', (): void => {
     });
 
     it('should log a warning with the given message and with the issue number as prefix', (): void => {
-      expect.assertions(2);
+      expect.assertions(3);
 
       issueLogger.warning(message);
 
       expect(coreWarningSpy).toHaveBeenCalledTimes(1);
-      expect(coreWarningSpy).toHaveBeenCalledWith('[#8] dummy-message');
+      expect(coreWarningSpy).toHaveBeenCalledWith(
+        expect.stringContaining('[#8]')
+      );
+      expect(coreWarningSpy).toHaveBeenCalledWith(
+        expect.stringContaining('dummy-message')
+      );
     });
   });
 
@@ -52,12 +57,15 @@ describe('IssueLogger', (): void => {
     });
 
     it('should log an information with the given message and with the issue number as prefix', (): void => {
-      expect.assertions(2);
+      expect.assertions(3);
 
       issueLogger.info(message);
 
       expect(coreInfoSpy).toHaveBeenCalledTimes(1);
-      expect(coreInfoSpy).toHaveBeenCalledWith('[#8] dummy-message');
+      expect(coreInfoSpy).toHaveBeenCalledWith(expect.stringContaining('[#8]'));
+      expect(coreInfoSpy).toHaveBeenCalledWith(
+        expect.stringContaining('dummy-message')
+      );
     });
   });
 
@@ -78,17 +86,22 @@ describe('IssueLogger', (): void => {
     });
 
     it('should log an error with the given message and with the issue number as prefix', (): void => {
-      expect.assertions(2);
+      expect.assertions(3);
 
       issueLogger.error(message);
 
       expect(coreErrorSpy).toHaveBeenCalledTimes(1);
-      expect(coreErrorSpy).toHaveBeenCalledWith('[#8] dummy-message');
+      expect(coreErrorSpy).toHaveBeenCalledWith(
+        expect.stringContaining('[#8]')
+      );
+      expect(coreErrorSpy).toHaveBeenCalledWith(
+        expect.stringContaining('dummy-message')
+      );
     });
   });
 
   it('should prefix the message with the issue number', (): void => {
-    expect.assertions(2);
+    expect.assertions(3);
     message = 'dummy-message';
     issue = new Issue(
       DefaultProcessorOptions,
@@ -102,7 +115,12 @@ describe('IssueLogger', (): void => {
     issueLogger.warning(message);
 
     expect(coreWarningSpy).toHaveBeenCalledTimes(1);
-    expect(coreWarningSpy).toHaveBeenCalledWith('[#123] dummy-message');
+    expect(coreWarningSpy).toHaveBeenCalledWith(
+      expect.stringContaining('[#123]')
+    );
+    expect(coreWarningSpy).toHaveBeenCalledWith(
+      expect.stringContaining('dummy-message')
+    );
   });
 
   it.each`
@@ -114,7 +132,7 @@ describe('IssueLogger', (): void => {
   `(
     'should replace the special tokens "$$type" with the corresponding type',
     ({pull_request, replacement}): void => {
-      expect.assertions(2);
+      expect.assertions(3);
       message = 'The $$type will stale! $$type will soon be closed!';
       issue = new Issue(
         DefaultProcessorOptions,
@@ -130,7 +148,12 @@ describe('IssueLogger', (): void => {
 
       expect(coreWarningSpy).toHaveBeenCalledTimes(1);
       expect(coreWarningSpy).toHaveBeenCalledWith(
-        `[#8] The ${replacement} will stale! ${replacement} will soon be closed!`
+        expect.stringContaining(`[#8]`)
+      );
+      expect(coreWarningSpy).toHaveBeenCalledWith(
+        expect.stringContaining(
+          `The ${replacement} will stale! ${replacement} will soon be closed!`
+        )
       );
     }
   );
@@ -144,7 +167,7 @@ describe('IssueLogger', (): void => {
   `(
     'should replace the special token "$$type" with the corresponding type with first letter as uppercase',
     ({pull_request, replacement}): void => {
-      expect.assertions(2);
+      expect.assertions(3);
       message = '$$type will stale';
       issue = new Issue(
         DefaultProcessorOptions,
@@ -160,7 +183,10 @@ describe('IssueLogger', (): void => {
 
       expect(coreWarningSpy).toHaveBeenCalledTimes(1);
       expect(coreWarningSpy).toHaveBeenCalledWith(
-        `[#8] ${replacement} will stale`
+        expect.stringContaining(`[#8]`)
+      );
+      expect(coreWarningSpy).toHaveBeenCalledWith(
+        expect.stringContaining(`${replacement} will stale`)
       );
     }
   );

src/classes/loggers/issue-logger.ts

@@ -1,6 +1,6 @@
-import chalk from 'chalk';
 import {Issue} from '../issue';
 import {Logger} from './logger';
+import {LoggerService} from '../../services/logger.service';
 
 /**
  * @description
@@ -70,10 +70,10 @@ export class IssueLogger extends Logger {
   }
 
   private _getIssuePrefix(): string {
-    return chalk.red(`[#${this._getIssueNumber()}]`);
+    return LoggerService.red(`[#${this._getIssueNumber()}]`);
   }
 
   private _getPullRequestPrefix(): string {
-    return chalk.blue(`[#${this._getIssueNumber()}]`);
+    return LoggerService.blue(`[#${this._getIssueNumber()}]`);
   }
 }

src/classes/loggers/logger.spec.ts

@@ -25,7 +25,9 @@ describe('Logger', (): void => {
       logger.warning(message);
 
       expect(coreWarningSpy).toHaveBeenCalledTimes(1);
-      expect(coreWarningSpy).toHaveBeenCalledWith('dummy-message');
+      expect(coreWarningSpy).toHaveBeenCalledWith(
+        expect.stringContaining('dummy-message')
+      );
     });
   });
 
@@ -46,7 +48,9 @@ describe('Logger', (): void => {
       logger.info(message);
 
       expect(coreInfoSpy).toHaveBeenCalledTimes(1);
-      expect(coreInfoSpy).toHaveBeenCalledWith('dummy-message');
+      expect(coreInfoSpy).toHaveBeenCalledWith(
+        expect.stringContaining('dummy-message')
+      );
     });
   });
 
@@ -67,7 +71,9 @@ describe('Logger', (): void => {
       logger.error(message);
 
       expect(coreErrorSpy).toHaveBeenCalledTimes(1);
-      expect(coreErrorSpy).toHaveBeenCalledWith('dummy-message');
+      expect(coreErrorSpy).toHaveBeenCalledWith(
+        expect.stringContaining('dummy-message')
+      );
     });
   });
 });

src/classes/loggers/logger.ts

@@ -1,19 +1,19 @@
 import * as core from '@actions/core';
-import chalk from 'chalk';
 import terminalLink from 'terminal-link';
 import {Option} from '../../enums/option';
+import {LoggerService} from '../../services/logger.service';
 
 export class Logger {
   warning(...message: string[]): void {
-    core.warning(chalk.whiteBright(...message));
+    core.warning(LoggerService.whiteBright(message.join(' ')));
   }
 
   info(...message: string[]): void {
-    core.info(chalk.whiteBright(...message));
+    core.info(LoggerService.whiteBright(message.join(' ')));
   }
 
   error(...message: string[]): void {
-    core.error(chalk.whiteBright(...message));
+    core.error(LoggerService.whiteBright(message.join(' ')));
   }
 
   createLink(name: Readonly<string>, link: Readonly<string>): string {
@@ -21,7 +21,7 @@ export class Logger {
   }
 
   createOptionLink(option: Readonly<Option>): string {
-    return chalk.magenta(
+    return LoggerService.magenta(
       this.createLink(option, `https://github.com/actions/stale#${option}`)
     );
   }