@checkdigit/time 4.0.0-PR.18-9134 → 4.0.0-PR.18-81a3

package/src/date-fns/formatDistance/index.ts

@@ -1,18 +1,17 @@
-import { compareAsc } from "../compareAsc/index";
-import { minutesInDay, minutesInMonth } from "../constants/index";
-import { differenceInMonths } from "../differenceInMonths/index";
-import { differenceInSeconds } from "../differenceInSeconds/index";
-import { toDate } from "../toDate/index";
-import type { LocalizedOptions } from "../types";
-import { defaultLocale } from "../_lib/defaultLocale/index";
-import { getDefaultOptions } from "../_lib/defaultOptions/index";
-import { getTimezoneOffsetInMilliseconds } from "../_lib/getTimezoneOffsetInMilliseconds/index";
+import { compareAsc } from '../compareAsc/index';
+import { minutesInDay, minutesInMonth } from '../constants/index';
+import { differenceInMonths } from '../differenceInMonths/index';
+import { differenceInSeconds } from '../differenceInSeconds/index';
+import { toDate } from '../toDate/index';
+import type { LocalizedOptions } from '../types';
+import { defaultLocale } from '../_lib/defaultLocale/index';
+import { getDefaultOptions } from '../_lib/defaultOptions/index';
+import { getTimezoneOffsetInMilliseconds } from '../_lib/getTimezoneOffsetInMilliseconds/index';
 
 /**
  * The {@link formatDistance} function options.
  */
-export interface FormatDistanceOptions
-  extends LocalizedOptions<"formatDistance"> {
+export interface FormatDistanceOptions extends LocalizedOptions<'formatDistance'> {
   /** Distances less than a minute are more detailed */
   includeSeconds?: boolean;
   /** Add "X ago"/"in X" in the locale language */
@@ -112,7 +111,7 @@ export function formatDistance<DateType extends Date>(
   const comparison = compareAsc(date, baseDate);
 
   if (isNaN(comparison)) {
-    throw new RangeError("Invalid time value");
+    throw new RangeError('Invalid time value');
   }
 
   const localizeOptions = Object.assign({}, options, {
@@ -132,9 +131,7 @@ export function formatDistance<DateType extends Date>(
 
   const seconds = differenceInSeconds(dateRight, dateLeft);
   const offsetInSeconds =
-    (getTimezoneOffsetInMilliseconds(dateRight) -
-      getTimezoneOffsetInMilliseconds(dateLeft)) /
-    1000;
+    (getTimezoneOffsetInMilliseconds(dateRight) - getTimezoneOffsetInMilliseconds(dateLeft)) / 1000;
   const minutes = Math.round((seconds - offsetInSeconds) / 60);
   let months;
 
@@ -142,52 +139,52 @@ export function formatDistance<DateType extends Date>(
   if (minutes < 2) {
     if (options?.includeSeconds) {
       if (seconds < 5) {
-        return locale.formatDistance("lessThanXSeconds", 5, localizeOptions);
+        return locale.formatDistance('lessThanXSeconds', 5, localizeOptions);
       } else if (seconds < 10) {
-        return locale.formatDistance("lessThanXSeconds", 10, localizeOptions);
+        return locale.formatDistance('lessThanXSeconds', 10, localizeOptions);
       } else if (seconds < 20) {
-        return locale.formatDistance("lessThanXSeconds", 20, localizeOptions);
+        return locale.formatDistance('lessThanXSeconds', 20, localizeOptions);
       } else if (seconds < 40) {
-        return locale.formatDistance("halfAMinute", 0, localizeOptions);
+        return locale.formatDistance('halfAMinute', 0, localizeOptions);
       } else if (seconds < 60) {
-        return locale.formatDistance("lessThanXMinutes", 1, localizeOptions);
+        return locale.formatDistance('lessThanXMinutes', 1, localizeOptions);
       } else {
-        return locale.formatDistance("xMinutes", 1, localizeOptions);
+        return locale.formatDistance('xMinutes', 1, localizeOptions);
       }
     } else {
       if (minutes === 0) {
-        return locale.formatDistance("lessThanXMinutes", 1, localizeOptions);
+        return locale.formatDistance('lessThanXMinutes', 1, localizeOptions);
       } else {
-        return locale.formatDistance("xMinutes", minutes, localizeOptions);
+        return locale.formatDistance('xMinutes', minutes, localizeOptions);
       }
     }
 
     // 2 mins up to 0.75 hrs
   } else if (minutes < 45) {
-    return locale.formatDistance("xMinutes", minutes, localizeOptions);
+    return locale.formatDistance('xMinutes', minutes, localizeOptions);
 
     // 0.75 hrs up to 1.5 hrs
   } else if (minutes < 90) {
-    return locale.formatDistance("aboutXHours", 1, localizeOptions);
+    return locale.formatDistance('aboutXHours', 1, localizeOptions);
 
     // 1.5 hrs up to 24 hrs
   } else if (minutes < minutesInDay) {
     const hours = Math.round(minutes / 60);
-    return locale.formatDistance("aboutXHours", hours, localizeOptions);
+    return locale.formatDistance('aboutXHours', hours, localizeOptions);
 
     // 1 day up to 1.75 days
   } else if (minutes < minutesInAlmostTwoDays) {
-    return locale.formatDistance("xDays", 1, localizeOptions);
+    return locale.formatDistance('xDays', 1, localizeOptions);
 
     // 1.75 days up to 30 days
   } else if (minutes < minutesInMonth) {
     const days = Math.round(minutes / minutesInDay);
-    return locale.formatDistance("xDays", days, localizeOptions);
+    return locale.formatDistance('xDays', days, localizeOptions);
 
     // 1 month up to 2 months
   } else if (minutes < minutesInMonth * 2) {
     months = Math.round(minutes / minutesInMonth);
-    return locale.formatDistance("aboutXMonths", months, localizeOptions);
+    return locale.formatDistance('aboutXMonths', months, localizeOptions);
   }
 
   months = differenceInMonths(dateRight, dateLeft);
@@ -195,7 +192,7 @@ export function formatDistance<DateType extends Date>(
   // 2 months up to 12 months
   if (months < 12) {
     const nearestMonth = Math.round(minutes / minutesInMonth);
-    return locale.formatDistance("xMonths", nearestMonth, localizeOptions);
+    return locale.formatDistance('xMonths', nearestMonth, localizeOptions);
 
     // 1 year up to max Date
   } else {
@@ -204,15 +201,15 @@ export function formatDistance<DateType extends Date>(
 
     // N years up to 1 years 3 months
     if (monthsSinceStartOfYear < 3) {
-      return locale.formatDistance("aboutXYears", years, localizeOptions);
+      return locale.formatDistance('aboutXYears', years, localizeOptions);
 
       // N years 3 months up to N years 9 months
     } else if (monthsSinceStartOfYear < 9) {
-      return locale.formatDistance("overXYears", years, localizeOptions);
+      return locale.formatDistance('overXYears', years, localizeOptions);
 
       // N years 9 months up to N year 12 months
     } else {
-      return locale.formatDistance("almostXYears", years + 1, localizeOptions);
+      return locale.formatDistance('almostXYears', years + 1, localizeOptions);
     }
   }
 }

package/src/date-fns/formatDistance/test.mts

@@ -1,253 +1,189 @@
-import { describe, expect, it } from "vitest";
-import type { FormatDistanceFn } from "../locale/types";
-import { formatDistance } from "./index";
-
-describe("formatDistance", () => {
-  describe("seconds", () => {
-    describe("when the includeSeconds option is true", () => {
-      it("less than 5 seconds", () => {
-        const result = formatDistance(
-          new Date(1986, 3, 4, 10, 32, 0),
-          new Date(1986, 3, 4, 10, 32, 3),
-          { includeSeconds: true },
-        );
-        expect(result).toBe("less than 5 seconds");
+import { describe, expect, it } from 'vitest';
+import type { FormatDistanceFn } from '../locale/types';
+import { formatDistance } from './index';
+
+describe('formatDistance', () => {
+  describe('seconds', () => {
+    describe('when the includeSeconds option is true', () => {
+      it('less than 5 seconds', () => {
+        const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 10, 32, 3), {
+          includeSeconds: true,
+        });
+        expect(result).toBe('less than 5 seconds');
       });
 
-      it("less than 10 seconds", () => {
-        const result = formatDistance(
-          new Date(1986, 3, 4, 10, 32, 0),
-          new Date(1986, 3, 4, 10, 32, 7),
-          { includeSeconds: true },
-        );
-        expect(result).toBe("less than 10 seconds");
+      it('less than 10 seconds', () => {
+        const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 10, 32, 7), {
+          includeSeconds: true,
+        });
+        expect(result).toBe('less than 10 seconds');
       });
 
-      it("less than 20 seconds", () => {
-        const result = formatDistance(
-          new Date(1986, 3, 4, 10, 32, 0),
-          new Date(1986, 3, 4, 10, 32, 15),
-          { includeSeconds: true },
-        );
-        expect(result).toBe("less than 20 seconds");
+      it('less than 20 seconds', () => {
+        const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 10, 32, 15), {
+          includeSeconds: true,
+        });
+        expect(result).toBe('less than 20 seconds');
       });
 
-      it("half a minute", () => {
-        const result = formatDistance(
-          new Date(1986, 3, 4, 10, 32, 0),
-          new Date(1986, 3, 4, 10, 32, 25),
-          { includeSeconds: true },
-        );
-        expect(result).toBe("half a minute");
+      it('half a minute', () => {
+        const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 10, 32, 25), {
+          includeSeconds: true,
+        });
+        expect(result).toBe('half a minute');
       });
 
-      it("less than a minute", () => {
-        const result = formatDistance(
-          new Date(1986, 3, 4, 10, 32, 0),
-          new Date(1986, 3, 4, 10, 32, 45),
-          { includeSeconds: true },
-        );
-        expect(result).toBe("less than a minute");
+      it('less than a minute', () => {
+        const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 10, 32, 45), {
+          includeSeconds: true,
+        });
+        expect(result).toBe('less than a minute');
       });
 
-      it("1 minute", () => {
-        const result = formatDistance(
-          new Date(1986, 3, 4, 10, 32, 0),
-          new Date(1986, 3, 4, 10, 33, 0),
-          { includeSeconds: true },
-        );
-        expect(result).toBe("1 minute");
+      it('1 minute', () => {
+        const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 10, 33, 0), {
+          includeSeconds: true,
+        });
+        expect(result).toBe('1 minute');
       });
     });
   });
 
-  describe("minutes", () => {
-    it("less than a minute", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1986, 3, 4, 10, 32, 20),
-      );
-      expect(result).toBe("less than a minute");
+  describe('minutes', () => {
+    it('less than a minute', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 10, 32, 20));
+      expect(result).toBe('less than a minute');
     });
 
-    it("1 minute", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1986, 3, 4, 10, 32, 50),
-      );
-      expect(result).toBe("1 minute");
+    it('1 minute', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 10, 32, 50));
+      expect(result).toBe('1 minute');
     });
 
-    it("n minutes", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1986, 3, 4, 10, 34, 50),
-      );
-      expect(result).toBe("3 minutes");
+    it('n minutes', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 10, 34, 50));
+      expect(result).toBe('3 minutes');
     });
   });
 
-  describe("hours", () => {
-    it("about 1 hour", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1986, 3, 4, 11, 32, 0),
-      );
-      expect(result).toBe("about 1 hour");
+  describe('hours', () => {
+    it('about 1 hour', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 11, 32, 0));
+      expect(result).toBe('about 1 hour');
     });
 
-    it("about n hours", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1986, 3, 4, 13, 32, 0),
-      );
-      expect(result).toBe("about 3 hours");
+    it('about n hours', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 13, 32, 0));
+      expect(result).toBe('about 3 hours');
     });
   });
 
-  describe("days", () => {
-    it("1 day", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1986, 3, 5, 10, 32, 0),
-      );
-      expect(result).toBe("1 day");
+  describe('days', () => {
+    it('1 day', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 5, 10, 32, 0));
+      expect(result).toBe('1 day');
     });
 
-    it("n days", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1986, 3, 7, 10, 32, 0),
-      );
-      expect(result).toBe("3 days");
+    it('n days', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 7, 10, 32, 0));
+      expect(result).toBe('3 days');
     });
   });
 
-  describe("months", () => {
-    it("about 1 month", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1986, 4, 4, 10, 32, 0),
-      );
-      expect(result).toBe("about 1 month");
+  describe('months', () => {
+    it('about 1 month', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 4, 4, 10, 32, 0));
+      expect(result).toBe('about 1 month');
     });
 
-    it("n months", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1986, 6, 4, 10, 32, 0),
-      );
-      expect(result).toBe("3 months");
+    it('n months', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 6, 4, 10, 32, 0));
+      expect(result).toBe('3 months');
     });
   });
 
-  describe("years", () => {
-    it("about 1 year", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1987, 3, 4, 10, 32, 0),
-      );
-      expect(result).toBe("about 1 year");
+  describe('years', () => {
+    it('about 1 year', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1987, 3, 4, 10, 32, 0));
+      expect(result).toBe('about 1 year');
     });
 
-    it("over 1 year", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1987, 9, 4, 10, 32, 0),
-      );
-      expect(result).toBe("over 1 year");
+    it('over 1 year', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1987, 9, 4, 10, 32, 0));
+      expect(result).toBe('over 1 year');
     });
 
-    it("almost n years", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1989, 2, 4, 10, 32, 0),
-      );
-      expect(result).toBe("almost 3 years");
+    it('almost n years', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1989, 2, 4, 10, 32, 0));
+      expect(result).toBe('almost 3 years');
     });
 
-    it("about n years", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1989, 3, 4, 10, 32, 0),
-      );
-      expect(result).toBe("about 3 years");
+    it('about n years', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1989, 3, 4, 10, 32, 0));
+      expect(result).toBe('about 3 years');
     });
 
-    it("over n years", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1989, 9, 4, 10, 32, 0),
-      );
-      expect(result).toBe("over 3 years");
+    it('over n years', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1989, 9, 4, 10, 32, 0));
+      expect(result).toBe('over 3 years');
     });
   });
 
-  it("accepts timestamps", () => {
-    const result = formatDistance(
-      new Date(1986, 3, 4, 10, 32, 0).getTime(),
-      new Date(1986, 3, 4, 11, 32, 0).getTime(),
-    );
-    expect(result).toBe("about 1 hour");
+  it('accepts timestamps', () => {
+    const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0).getTime(), new Date(1986, 3, 4, 11, 32, 0).getTime());
+    expect(result).toBe('about 1 hour');
   });
 
-  describe("when the addSuffix option is true", () => {
-    it("adds a past suffix", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 0),
-        new Date(1986, 3, 4, 10, 32, 25),
-        { includeSeconds: true, addSuffix: true },
-      );
-      expect(result).toBe("half a minute ago");
+  describe('when the addSuffix option is true', () => {
+    it('adds a past suffix', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 0), new Date(1986, 3, 4, 10, 32, 25), {
+        includeSeconds: true,
+        addSuffix: true,
+      });
+      expect(result).toBe('half a minute ago');
     });
 
-    it("adds a future suffix", () => {
-      const result = formatDistance(
-        new Date(1986, 3, 4, 11, 32, 0),
-        new Date(1986, 3, 4, 10, 32, 0),
-        { addSuffix: true },
-      );
-      expect(result).toBe("in about 1 hour");
+    it('adds a future suffix', () => {
+      const result = formatDistance(new Date(1986, 3, 4, 11, 32, 0), new Date(1986, 3, 4, 10, 32, 0), {
+        addSuffix: true,
+      });
+      expect(result).toBe('in about 1 hour');
     });
   });
 
-  describe("custom locale", () => {
-    it("can be passed to the function", () => {
+  describe('custom locale', () => {
+    it('can be passed to the function', () => {
       const localizeDistance: FormatDistanceFn = (token, count, options) => {
-        expect(token).toBe("lessThanXSeconds");
+        expect(token).toBe('lessThanXSeconds');
         expect(count).toBe(5);
         expect(options!.addSuffix).toBe(true);
         expect(options!.comparison!).toBeGreaterThan(0);
-        return "It works!";
+        return 'It works!';
       };
 
       const customLocale = {
         formatDistance: localizeDistance,
       };
 
-      const result = formatDistance(
-        new Date(1986, 3, 4, 10, 32, 3),
-        new Date(1986, 3, 4, 10, 32, 0),
-        {
-          includeSeconds: true,
-          addSuffix: true,
-          locale: customLocale,
-        },
-      );
+      const result = formatDistance(new Date(1986, 3, 4, 10, 32, 3), new Date(1986, 3, 4, 10, 32, 0), {
+        includeSeconds: true,
+        addSuffix: true,
+        locale: customLocale,
+      });
 
-      expect(result).toBe("It works!");
+      expect(result).toBe('It works!');
     });
   });
 
-  it("throws RangeError if the first date is `Invalid Date`", () => {
+  it('throws RangeError if the first date is `Invalid Date`', () => {
     expect(formatDistance.bind(null, new Date(NaN), new Date(1986, 3, 7, 10, 32, 0))).toThrow(RangeError);
   });
 
-  it("throws RangeError if the second date is `Invalid Date`", () => {
+  it('throws RangeError if the second date is `Invalid Date`', () => {
     expect(formatDistance.bind(null, new Date(1986, 3, 4, 10, 32, 0), new Date(NaN))).toThrow(RangeError);
   });
 
-  it("throws RangeError if the both dates are `Invalid Date`", () => {
+  it('throws RangeError if the both dates are `Invalid Date`', () => {
     expect(formatDistance.bind(null, new Date(NaN), new Date(NaN))).toThrow(RangeError);
   });
 });