feat(assignees): add 6 new options to avoid stale for assignees (#327)

* feat(assignees): add new option to avoid stale for assignees

closes #271

* test: add more coverage

* docs: fix readme format issue

* docs: reorder and enhance typo

* docs(contributing): add more information about the npm scripts

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

@@ -1,3 +1,5 @@
+import {DefaultProcessorOptions} from '../../../__tests__/constants/default-processor-options';
+import {generateIIssue} from '../../../__tests__/functions/generate-iissue';
 import {Issue} from '../issue';
 import {IssueLogger} from './issue-logger';
 import * as core from '@actions/core';
@@ -5,21 +7,20 @@ import * as core from '@actions/core';
 describe('IssueLogger', (): void => {
   let issue: Issue;
   let issueLogger: IssueLogger;
+  let message: string;
 
-  beforeEach((): void => {
-    issue = {
-      number: 8
-    } as Issue;
-    issueLogger = new IssueLogger(issue);
-  });
+  let coreWarningSpy: jest.SpyInstance;
 
   describe('warning()', (): void => {
-    let message: string;
-
-    let coreWarningSpy: jest.SpyInstance;
-
     beforeEach((): void => {
       message = 'dummy-message';
+      issue = new Issue(
+        DefaultProcessorOptions,
+        generateIIssue({
+          number: 8
+        })
+      );
+      issueLogger = new IssueLogger(issue);
 
       coreWarningSpy = jest.spyOn(core, 'warning').mockImplementation();
     });
@@ -35,12 +36,17 @@ describe('IssueLogger', (): void => {
   });
 
   describe('info()', (): void => {
-    let message: string;
-
     let coreInfoSpy: jest.SpyInstance;
 
     beforeEach((): void => {
       message = 'dummy-message';
+      issue = new Issue(
+        DefaultProcessorOptions,
+        generateIIssue({
+          number: 8
+        })
+      );
+      issueLogger = new IssueLogger(issue);
 
       coreInfoSpy = jest.spyOn(core, 'info').mockImplementation();
     });
@@ -56,12 +62,17 @@ describe('IssueLogger', (): void => {
   });
 
   describe('error()', (): void => {
-    let message: string;
-
     let coreErrorSpy: jest.SpyInstance;
 
     beforeEach((): void => {
       message = 'dummy-message';
+      issue = new Issue(
+        DefaultProcessorOptions,
+        generateIIssue({
+          number: 8
+        })
+      );
+      issueLogger = new IssueLogger(issue);
 
       coreErrorSpy = jest.spyOn(core, 'error').mockImplementation();
     });
@@ -75,4 +86,82 @@ describe('IssueLogger', (): void => {
       expect(coreErrorSpy).toHaveBeenCalledWith('[#8] dummy-message');
     });
   });
+
+  it('should prefix the message with the issue number', (): void => {
+    expect.assertions(2);
+    message = 'dummy-message';
+    issue = new Issue(
+      DefaultProcessorOptions,
+      generateIIssue({
+        number: 123
+      })
+    );
+    issueLogger = new IssueLogger(issue);
+    coreWarningSpy = jest.spyOn(core, 'warning').mockImplementation();
+
+    issueLogger.warning(message);
+
+    expect(coreWarningSpy).toHaveBeenCalledTimes(1);
+    expect(coreWarningSpy).toHaveBeenCalledWith('[#123] dummy-message');
+  });
+
+  it.each`
+    pull_request      | replacement
+    ${{key: 'value'}} | ${'pull request'}
+    ${{}}             | ${'pull request'}
+    ${null}           | ${'issue'}
+    ${undefined}      | ${'issue'}
+  `(
+    'should replace the special tokens "$$type" with the corresponding type',
+    ({pull_request, replacement}): void => {
+      expect.assertions(2);
+      message = 'The $$type will stale! $$type will soon be closed!';
+      issue = new Issue(
+        DefaultProcessorOptions,
+        generateIIssue({
+          number: 8,
+          pull_request
+        })
+      );
+      issueLogger = new IssueLogger(issue);
+      coreWarningSpy = jest.spyOn(core, 'warning').mockImplementation();
+
+      issueLogger.warning(message);
+
+      expect(coreWarningSpy).toHaveBeenCalledTimes(1);
+      expect(coreWarningSpy).toHaveBeenCalledWith(
+        `[#8] The ${replacement} will stale! ${replacement} will soon be closed!`
+      );
+    }
+  );
+
+  it.each`
+    pull_request      | replacement
+    ${{key: 'value'}} | ${'Pull request'}
+    ${{}}             | ${'Pull request'}
+    ${null}           | ${'Issue'}
+    ${undefined}      | ${'Issue'}
+  `(
+    'should replace the special token "$$type" with the corresponding type with first letter as uppercase',
+    ({pull_request, replacement}): void => {
+      expect.assertions(2);
+      message = '$$type will stale';
+      issue = new Issue(
+        DefaultProcessorOptions,
+        generateIIssue({
+          number: 8,
+          pull_request
+        })
+      );
+      issueLogger = new IssueLogger(issue);
+      coreWarningSpy = jest.spyOn(core, 'warning').mockImplementation();
+
+      issueLogger.warning(message);
+
+      expect(coreWarningSpy).toHaveBeenCalledTimes(1);
+      expect(coreWarningSpy).toHaveBeenCalledWith(
+        `[#8] ${replacement} will stale`
+      );
+    }
+  );
 });

src/classes/loggers/issue-logger.ts

@@ -2,6 +2,19 @@ import * as core from '@actions/core';
 import {Issue} from '../issue';
 import {Logger} from './logger';
 
+/**
+ * @description
+ * Each log will prefix the message with the issue number
+ *
+ * @example
+ * warning('No stale') => "[#123] No stale"
+ *
+ * Each log method can have special tokens:
+ * - $$type => will replace this by either "pull request" or "issue" depending of the type of issue
+ *
+ * @example
+ * warning('The $$type will stale') => "The pull request will stale"
+ */
 export class IssueLogger implements Logger {
   private readonly _issue: Issue;
 
@@ -10,15 +23,31 @@ export class IssueLogger implements Logger {
   }
 
   warning(message: Readonly<string>): void {
-    core.warning(this._prefixWithIssueNumber(message));
+    core.warning(this._format(message));
   }
 
   info(message: Readonly<string>): void {
-    core.info(this._prefixWithIssueNumber(message));
+    core.info(this._format(message));
   }
 
   error(message: Readonly<string>): void {
-    core.error(this._prefixWithIssueNumber(message));
+    core.error(this._format(message));
+  }
+
+  private _replaceTokens(message: Readonly<string>): string {
+    return this._replaceTypeToken(message);
+  }
+
+  private _replaceTypeToken(message: Readonly<string>): string {
+    return message
+      .replace(
+        /^\$\$type/,
+        this._issue.isPullRequest ? 'Pull request' : 'Issue'
+      )
+      .replace(
+        /\$\$type/g,
+        this._issue.isPullRequest ? 'pull request' : 'issue'
+      );
   }
 
   private _prefixWithIssueNumber(message: Readonly<string>): string {
@@ -28,4 +57,8 @@ export class IssueLogger implements Logger {
   private _getIssueNumber(): number {
     return this._issue.number;
   }
+
+  private _format(message: Readonly<string>): string {
+    return this._prefixWithIssueNumber(this._replaceTokens(message));
+  }
 }