Add a start date option to ignore old issues and PRs (#269)

* docs(readme): add a small precision about the operations-per-run

closes #230

* chore(lint): ignore the lib folder for prettier

* chore(date): add a function to check if a date is valid

* chore(date): add a function to get a humanized date

* chore(date): add a function to check if the date is more recent than

* feat(date): add a start date to ignore old issues and PRs

closes #174

* docs(readme): change the date to match the description

* chore(date): add a better type for the date

* docs(date): add missing JSDoc about the return type

* chore(rebase): fix issues due to rebase

* docs(readme): fix table formatting issues

src/functions/dates/get-humanized-date.spec.ts

@@ -0,0 +1,33 @@
+import {getHumanizedDate} from './get-humanized-date';
+
+describe('getHumanizedDate()', (): void => {
+  let date: Date;
+
+  describe('when the given date is the 1st of april 2020', (): void => {
+    beforeEach((): void => {
+      date = new Date(2020, 3, 1);
+    });
+
+    it('should return the date formatted as DD-MM-YYYY', (): void => {
+      expect.assertions(1);
+
+      const result = getHumanizedDate(date);
+
+      expect(result).toStrictEqual('01-04-2020');
+    });
+  });
+
+  describe('when the given date is the 18st of december 2020', (): void => {
+    beforeEach((): void => {
+      date = new Date(2020, 11, 18);
+    });
+
+    it('should return the date formatted as DD-MM-YYYY', (): void => {
+      expect.assertions(1);
+
+      const result = getHumanizedDate(date);
+
+      expect(result).toStrictEqual('18-12-2020');
+    });
+  });
+});

src/functions/dates/get-humanized-date.ts

@@ -0,0 +1,17 @@
+import {HumanizedDate} from '../../types/humanized-date';
+
+export function getHumanizedDate(date: Readonly<Date>): HumanizedDate {
+  const year: number = date.getFullYear();
+  let month = `${date.getMonth() + 1}`;
+  let day = `${date.getDate()}`;
+
+  if (month.length < 2) {
+    month = `0${month}`;
+  }
+
+  if (day.length < 2) {
+    day = `0${day}`;
+  }
+
+  return [day, month, year].join('-');
+}

src/functions/dates/is-date-more-recent-than.spec.ts

@@ -0,0 +1,51 @@
+import {isDateMoreRecentThan} from './is-date-more-recent-than';
+
+describe('isDateMoreRecentThan()', (): void => {
+  let date: Date;
+  let comparedDate: Date;
+
+  describe('when the given date is older than the compared date', (): void => {
+    beforeEach((): void => {
+      date = new Date(2020, 0, 20);
+      comparedDate = new Date(2021, 0, 20);
+    });
+
+    it('should return false', (): void => {
+      expect.assertions(1);
+
+      const result = isDateMoreRecentThan(date, comparedDate);
+
+      expect(result).toStrictEqual(false);
+    });
+  });
+
+  describe('when the given date is equal to the compared date', (): void => {
+    beforeEach((): void => {
+      date = new Date(2020, 0, 20);
+      comparedDate = new Date(2020, 0, 20);
+    });
+
+    it('should return false', (): void => {
+      expect.assertions(1);
+
+      const result = isDateMoreRecentThan(date, comparedDate);
+
+      expect(result).toStrictEqual(false);
+    });
+  });
+
+  describe('when the given date is more recent than the compared date', (): void => {
+    beforeEach((): void => {
+      date = new Date(2021, 0, 20);
+      comparedDate = new Date(2020, 0, 20);
+    });
+
+    it('should return true', (): void => {
+      expect.assertions(1);
+
+      const result = isDateMoreRecentThan(date, comparedDate);
+
+      expect(result).toStrictEqual(true);
+    });
+  });
+});

src/functions/dates/is-date-more-recent-than.ts

@@ -0,0 +1,6 @@
+export function isDateMoreRecentThan(
+  date: Readonly<Date>,
+  comparedDate: Readonly<Date>
+): boolean {
+  return date > comparedDate;
+}

src/functions/dates/is-valid-date.spec.ts

@@ -0,0 +1,61 @@
+import {isValidDate} from './is-valid-date';
+
+describe('isValidDate()', (): void => {
+  let date: Date;
+
+  describe('when the given date is an invalid date', (): void => {
+    beforeEach((): void => {
+      date = new Date('16-04-1994');
+    });
+
+    it('should return false', (): void => {
+      expect.assertions(1);
+
+      const result = isValidDate(date);
+
+      expect(result).toStrictEqual(false);
+    });
+  });
+
+  describe('when the given date is a new date', (): void => {
+    beforeEach((): void => {
+      date = new Date();
+    });
+
+    it('should return true', (): void => {
+      expect.assertions(1);
+
+      const result = isValidDate(date);
+
+      expect(result).toStrictEqual(true);
+    });
+  });
+
+  describe('when the given date is an ISO and valid date', (): void => {
+    beforeEach((): void => {
+      date = new Date('2011-04-22T13:33:48Z');
+    });
+
+    it('should return true', (): void => {
+      expect.assertions(1);
+
+      const result = isValidDate(date);
+
+      expect(result).toStrictEqual(true);
+    });
+  });
+
+  describe('when the given date is an ISO with ms and valid date', (): void => {
+    beforeEach((): void => {
+      date = new Date('2011-10-05T14:48:00.000Z');
+    });
+
+    it('should return true', (): void => {
+      expect.assertions(1);
+
+      const result = isValidDate(date);
+
+      expect(result).toStrictEqual(true);
+    });
+  });
+});

src/functions/dates/is-valid-date.ts

@@ -0,0 +1,18 @@
+/**
+ * @description
+ * Check if a date is valid
+ *
+ * @see
+ * https://stackoverflow.com/a/1353711/4440414
+ *
+ * @param {Readonly<Date>} date The date to check
+ *
+ * @returns {boolean} true when the given date is valid
+ */
+export function isValidDate(date: Readonly<Date>): boolean {
+  if (Object.prototype.toString.call(date) === '[object Date]') {
+    return !isNaN(date.getTime());
+  }
+
+  return false;
+}

src/functions/get-issue-type.ts

@@ -1,4 +1,4 @@
-import {IssueType} from '../enums/issue-type.enum';
+import {IssueType} from '../enums/issue-type';
 
 export function getIssueType(isPullRequest: Readonly<boolean>): IssueType {
   return isPullRequest ? IssueType.PullRequest : IssueType.Issue;

src/functions/is-labeled.ts

@@ -1,7 +1,6 @@
 import deburr from 'lodash.deburr';
 import {Issue, Label} from '../IssueProcessor';
-
-type CleanLabel = string;
+import {CleanLabel} from '../types/clean-label';
 
 /**
  * @description