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

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

@@ -1,10 +1,10 @@
-import { UTCDate } from "@date-fns/utc";
-import sinon from "sinon";
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import type { FormatDistanceFn } from "../locale/types";
-import { formatDistanceToNowStrict } from "./index";
+import { UTCDate } from '@date-fns/utc';
+import sinon from 'sinon';
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+import type { FormatDistanceFn } from '../locale/types';
+import { formatDistanceToNowStrict } from './index';
 
-describe("formatDistanceToNowStrict", () => {
+describe('formatDistanceToNowStrict', () => {
   let clock: sinon.SinonFakeTimers;
   beforeEach(() => {
     clock = sinon.useFakeTimers(new Date(1986, 3, 4, 10, 32, 0).getTime());
@@ -14,368 +14,280 @@ describe("formatDistanceToNowStrict", () => {
     clock.restore();
   });
 
-  describe("seconds", () => {
-    describe("when no unit is set", () => {
-      it("0 seconds", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 32, 0),
-        );
-        expect(result).toBe("0 seconds");
+  describe('seconds', () => {
+    describe('when no unit is set', () => {
+      it('0 seconds', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 32, 0));
+        expect(result).toBe('0 seconds');
       });
 
-      it("5 seconds", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 32, 5),
-        );
-        expect(result).toBe("5 seconds");
+      it('5 seconds', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 32, 5));
+        expect(result).toBe('5 seconds');
       });
     });
   });
 
-  describe("minutes", () => {
-    it("1 minute", () => {
+  describe('minutes', () => {
+    it('1 minute', () => {
       const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 33, 0));
-      expect(result).toBe("1 minute");
+      expect(result).toBe('1 minute');
     });
 
-    it("n minutes", () => {
+    it('n minutes', () => {
       const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 35, 0));
-      expect(result).toBe("3 minutes");
+      expect(result).toBe('3 minutes');
     });
   });
 
-  describe("hours", () => {
-    it("1 hour", () => {
+  describe('hours', () => {
+    it('1 hour', () => {
       const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 11, 32, 0));
-      expect(result).toBe("1 hour");
+      expect(result).toBe('1 hour');
     });
 
-    it("n hours", () => {
+    it('n hours', () => {
       const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 13, 32, 0));
-      expect(result).toBe("3 hours");
+      expect(result).toBe('3 hours');
     });
   });
 
-  describe("days", () => {
-    it("1 day", () => {
+  describe('days', () => {
+    it('1 day', () => {
       const result = formatDistanceToNowStrict(new Date(1986, 3, 5, 10, 32, 0));
-      expect(result).toBe("1 day");
+      expect(result).toBe('1 day');
     });
 
-    it("n days", () => {
+    it('n days', () => {
       const result = formatDistanceToNowStrict(new Date(1986, 3, 7, 10, 32, 0));
-      expect(result).toBe("3 days");
+      expect(result).toBe('3 days');
     });
   });
 
-  describe("months", () => {
-    it("1 month", () => {
+  describe('months', () => {
+    it('1 month', () => {
       const result = formatDistanceToNowStrict(new Date(1986, 4, 4, 10, 32, 0));
-      expect(result).toBe("1 month");
+      expect(result).toBe('1 month');
     });
 
-    it("n months", () => {
+    it('n months', () => {
       const result = formatDistanceToNowStrict(new Date(1986, 6, 4, 10, 32, 0));
-      expect(result).toBe("3 months");
+      expect(result).toBe('3 months');
     });
   });
 
-  describe("years", () => {
-    it("1 year", () => {
+  describe('years', () => {
+    it('1 year', () => {
       const result = formatDistanceToNowStrict(new Date(1987, 3, 4, 10, 32, 0));
-      expect(result).toBe("1 year");
+      expect(result).toBe('1 year');
     });
 
-    it("n years", () => {
+    it('n years', () => {
       const result = formatDistanceToNowStrict(new Date(1991, 3, 4, 10, 32, 0));
-      expect(result).toBe("5 years");
+      expect(result).toBe('5 years');
     });
   });
 
-  describe("when the unit option is supplied", () => {
-    describe("second", () => {
-      it("0 seconds", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 32, 0),
-          { unit: "second" },
-        );
-        expect(result).toBe("0 seconds");
+  describe('when the unit option is supplied', () => {
+    describe('second', () => {
+      it('0 seconds', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 32, 0), { unit: 'second' });
+        expect(result).toBe('0 seconds');
       });
 
-      it("5 seconds", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 32, 5),
-          { unit: "second" },
-        );
-        expect(result).toBe("5 seconds");
+      it('5 seconds', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 32, 5), { unit: 'second' });
+        expect(result).toBe('5 seconds');
       });
 
-      it("120 seconds", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 34, 0),
-          { unit: "second" },
-        );
-        expect(result).toBe("120 seconds");
+      it('120 seconds', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 34, 0), { unit: 'second' });
+        expect(result).toBe('120 seconds');
       });
     });
 
-    describe("minute", () => {
-      it("0 minutes", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 32, 0),
-          { unit: "minute" },
-        );
-        expect(result).toBe("0 minutes");
+    describe('minute', () => {
+      it('0 minutes', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 32, 0), { unit: 'minute' });
+        expect(result).toBe('0 minutes');
       });
 
-      it("5 minutes", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 37, 0),
-          { unit: "minute" },
-        );
-        expect(result).toBe("5 minutes");
+      it('5 minutes', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 37, 0), { unit: 'minute' });
+        expect(result).toBe('5 minutes');
       });
 
-      it("120 minutes", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 12, 32, 0),
-          { unit: "minute" },
-        );
-        expect(result).toBe("120 minutes");
+      it('120 minutes', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 12, 32, 0), { unit: 'minute' });
+        expect(result).toBe('120 minutes');
       });
     });
 
-    describe("hour", () => {
-      it("0 hours", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 32, 0),
-          { unit: "hour" },
-        );
-        expect(result).toBe("0 hours");
+    describe('hour', () => {
+      it('0 hours', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 32, 0), { unit: 'hour' });
+        expect(result).toBe('0 hours');
       });
 
-      it("5 hours", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 15, 32, 0),
-          { unit: "hour" },
-        );
-        expect(result).toBe("5 hours");
+      it('5 hours', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 15, 32, 0), { unit: 'hour' });
+        expect(result).toBe('5 hours');
       });
 
-      it("48 hours", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 6, 10, 32, 0),
-          { unit: "hour" },
-        );
-        expect(result).toBe("48 hours");
+      it('48 hours', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 6, 10, 32, 0), { unit: 'hour' });
+        expect(result).toBe('48 hours');
       });
     });
 
-    describe("day", () => {
-      it("0 days", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 32, 0),
-          { unit: "day" },
-        );
-        expect(result).toBe("0 days");
+    describe('day', () => {
+      it('0 days', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 32, 0), { unit: 'day' });
+        expect(result).toBe('0 days');
       });
 
-      it("5 days", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 9, 10, 32, 0),
-          { unit: "day" },
-        );
-        expect(result).toBe("5 days");
+      it('5 days', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 9, 10, 32, 0), { unit: 'day' });
+        expect(result).toBe('5 days');
       });
 
-      it("60 days", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 5, 3, 10, 32, 0),
-          { unit: "day" },
-        );
-        expect(result).toBe("60 days");
+      it('60 days', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 5, 3, 10, 32, 0), { unit: 'day' });
+        expect(result).toBe('60 days');
       });
     });
-    describe("month", () => {
-      it("0 months", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 32, 0),
-          { unit: "month" },
-        );
-        expect(result).toBe("0 months");
+    describe('month', () => {
+      it('0 months', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 32, 0), { unit: 'month' });
+        expect(result).toBe('0 months');
       });
 
-      it("5 months", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 7, 4, 10, 32, 0),
-          { unit: "month" },
-        );
-        expect(result).toBe("4 months");
+      it('5 months', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 7, 4, 10, 32, 0), { unit: 'month' });
+        expect(result).toBe('4 months');
       });
 
-      it("24 months", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1988, 3, 4, 10, 32, 0),
-          { unit: "month" },
-        );
-        expect(result).toBe("24 months");
+      it('24 months', () => {
+        const result = formatDistanceToNowStrict(new Date(1988, 3, 4, 10, 32, 0), { unit: 'month' });
+        expect(result).toBe('24 months');
       });
     });
 
-    describe("year", () => {
-      it("returns `1 year` - see issue 2388", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1985, 3, 4, 10, 32, 0),
-        );
-        expect(result).toBe("1 year");
+    describe('year', () => {
+      it('returns `1 year` - see issue 2388', () => {
+        const result = formatDistanceToNowStrict(new Date(1985, 3, 4, 10, 32, 0));
+        expect(result).toBe('1 year');
       });
 
-      it("returns `2 years` - see issue 2388", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1984, 3, 4, 10, 32, 0),
-        );
-        expect(result).toBe("2 years");
+      it('returns `2 years` - see issue 2388', () => {
+        const result = formatDistanceToNowStrict(new Date(1984, 3, 4, 10, 32, 0));
+        expect(result).toBe('2 years');
       });
 
-      it("0 years", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1986, 3, 4, 10, 32, 0),
-          { unit: "year" },
-        );
-        expect(result).toBe("0 years");
+      it('0 years', () => {
+        const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 32, 0), { unit: 'year' });
+        expect(result).toBe('0 years');
       });
 
-      it("5 years", () => {
-        const result = formatDistanceToNowStrict(
-          new Date(1991, 3, 4, 15, 32, 0),
-          { unit: "year" },
-        );
-        expect(result).toBe("5 years");
+      it('5 years', () => {
+        const result = formatDistanceToNowStrict(new Date(1991, 3, 4, 15, 32, 0), { unit: 'year' });
+        expect(result).toBe('5 years');
       });
     });
   });
 
-  it("accepts timestamps", () => {
-    const result = formatDistanceToNowStrict(
-      new Date(1986, 3, 4, 11, 32, 0).getTime(),
-    );
-    expect(result).toBe("1 hour");
+  it('accepts timestamps', () => {
+    const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 11, 32, 0).getTime());
+    expect(result).toBe('1 hour');
   });
 
-  describe("when the addSuffix option is true", () => {
-    it("adds a past suffix", () => {
-      const result = formatDistanceToNowStrict(
-        new Date(1986, 3, 4, 10, 31, 35),
-        {
-          addSuffix: true,
-        },
-      );
-      expect(result).toBe("25 seconds ago");
+  describe('when the addSuffix option is true', () => {
+    it('adds a past suffix', () => {
+      const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 31, 35), {
+        addSuffix: true,
+      });
+      expect(result).toBe('25 seconds ago');
     });
 
-    it("adds a future suffix", () => {
-      const result = formatDistanceToNowStrict(
-        new Date(1986, 3, 4, 11, 32, 0),
-        {
-          addSuffix: true,
-        },
-      );
-      expect(result).toBe("in 1 hour");
+    it('adds a future suffix', () => {
+      const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 11, 32, 0), {
+        addSuffix: true,
+      });
+      expect(result).toBe('in 1 hour');
     });
   });
 
-  describe("when the roundingMethod option is supplied", () => {
+  describe('when the roundingMethod option is supplied', () => {
     it('default is "round"', () => {
-      const result = formatDistanceToNowStrict(
-        new Date(1986, 3, 4, 10, 33, 59),
-      );
-      expect(result).toBe("2 minutes");
+      const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 33, 59));
+      expect(result).toBe('2 minutes');
     });
 
     it('"floor"', () => {
-      const result = formatDistanceToNowStrict(
-        new Date(1986, 3, 4, 10, 33, 59),
-        {
-          roundingMethod: "floor",
-        },
-      );
-      expect(result).toBe("1 minute");
+      const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 33, 59), {
+        roundingMethod: 'floor',
+      });
+      expect(result).toBe('1 minute');
     });
 
     it('"ceil"', () => {
-      const result = formatDistanceToNowStrict(
-        new Date(1986, 3, 4, 10, 33, 1),
-        {
-          roundingMethod: "ceil",
-        },
-      );
-      expect(result).toBe("2 minutes");
+      const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 33, 1), {
+        roundingMethod: 'ceil',
+      });
+      expect(result).toBe('2 minutes');
     });
 
     it('"round" (down)', () => {
-      const result = formatDistanceToNowStrict(
-        new Date(1986, 3, 4, 10, 33, 29),
-        {
-          roundingMethod: "round",
-        },
-      );
-      expect(result).toBe("1 minute");
+      const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 33, 29), {
+        roundingMethod: 'round',
+      });
+      expect(result).toBe('1 minute');
     });
 
     it('"round" (up)', () => {
-      const result = formatDistanceToNowStrict(
-        new Date(1986, 3, 4, 10, 33, 30),
-        {
-          roundingMethod: "round",
-        },
-      );
-      expect(result).toBe("2 minutes");
+      const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 33, 30), {
+        roundingMethod: 'round',
+      });
+      expect(result).toBe('2 minutes');
     });
   });
 
-  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("xSeconds");
+        expect(token).toBe('xSeconds');
         expect(count).toBe(15);
         expect(options!.addSuffix).toBe(true);
         expect(options!.comparison!).toBeLessThan(0);
-        return "It works!";
+        return 'It works!';
       };
 
       const customLocale = {
         formatDistance: localizeDistance,
       };
 
-      const result = formatDistanceToNowStrict(
-        new Date(1986, 3, 4, 10, 31, 45),
-        {
-          addSuffix: true,
-          locale: customLocale,
-        },
-      );
+      const result = formatDistanceToNowStrict(new Date(1986, 3, 4, 10, 31, 45), {
+        addSuffix: true,
+        locale: customLocale,
+      });
 
-      expect(result).toBe("It works!");
+      expect(result).toBe('It works!');
     });
   });
 
-  describe("edge cases", () => {
-    it("detects unit correctly for short months", () => {
+  describe('edge cases', () => {
+    it('detects unit correctly for short months', () => {
       const result = formatDistanceToNowStrict(new Date(1986, 2 /* Mar */, 7));
-      expect(result).toBe("28 days");
+      expect(result).toBe('28 days');
     });
   });
 
-  it("throws `RangeError` if the date is `Invalid Date`", () => {
-    expect(formatDistanceToNowStrict.bind(null, new Date(NaN))).toThrow(
-      RangeError,
-    );
+  it('throws `RangeError` if the date is `Invalid Date`', () => {
+    expect(formatDistanceToNowStrict.bind(null, new Date(NaN))).toThrow(RangeError);
   });
 
-  it("respects date extensions", () => {
-    const result = formatDistanceToNowStrict(
-      new UTCDate(+new Date(1986, 3, 4, 10, 32, 5)),
-    );
-    expect(result).toBe("5 seconds");
+  it('respects date extensions', () => {
+    const result = formatDistanceToNowStrict(new UTCDate(+new Date(1986, 3, 4, 10, 32, 5)));
+    expect(result).toBe('5 seconds');
   });
 });

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

@@ -1,13 +1,12 @@
-import type { FormatDistanceToken } from "../locale/types";
-import type { Duration, DurationUnit, LocalizedOptions } from "../types";
-import { defaultLocale } from "../_lib/defaultLocale/index";
-import { getDefaultOptions } from "../_lib/defaultOptions/index";
+import type { FormatDistanceToken } from '../locale/types';
+import type { Duration, DurationUnit, LocalizedOptions } from '../types';
+import { defaultLocale } from '../_lib/defaultLocale/index';
+import { getDefaultOptions } from '../_lib/defaultOptions/index';
 
 /**
  * The {@link formatDuration} function options.
  */
-export interface FormatDurationOptions
-  extends LocalizedOptions<"formatDistance"> {
+export interface FormatDurationOptions extends LocalizedOptions<'formatDistance'> {
   /** The array of units to format */
   format?: DurationUnit[];
   /** Should be zeros be included in the output? */
@@ -16,15 +15,7 @@ export interface FormatDurationOptions
   delimiter?: string;
 }
 
-const defaultFormat: DurationUnit[] = [
-  "years",
-  "months",
-  "weeks",
-  "days",
-  "hours",
-  "minutes",
-  "seconds",
-];
+const defaultFormat: DurationUnit[] = ['years', 'months', 'weeks', 'days', 'hours', 'minutes', 'seconds'];
 
 /**
  * @name formatDuration
@@ -86,25 +77,20 @@ const defaultFormat: DurationUnit[] = [
  * formatDuration({ years: 2, months: 9, weeks: 3 }, { delimiter: ', ' })
  * //=> '2 years, 9 months, 3 weeks'
  */
-export function formatDuration(
-  duration: Duration,
-  options?: FormatDurationOptions,
-): string {
+export function formatDuration(duration: Duration, options?: FormatDurationOptions): string {
   const defaultOptions = getDefaultOptions();
   const locale = options?.locale ?? defaultOptions.locale ?? defaultLocale;
   const format = options?.format ?? defaultFormat;
   const zero = options?.zero ?? false;
-  const delimiter = options?.delimiter ?? " ";
+  const delimiter = options?.delimiter ?? ' ';
 
   if (!locale.formatDistance) {
-    return "";
+    return '';
   }
 
   const result = format
     .reduce((acc, unit) => {
-      const token = `x${unit.replace(/(^.)/, (m) =>
-        m.toUpperCase(),
-      )}` as FormatDistanceToken;
+      const token = `x${unit.replace(/(^.)/, (m) => m.toUpperCase())}` as FormatDistanceToken;
       const value = duration[unit];
       if (value !== undefined && (zero || duration[unit])) {
         return acc.concat(locale.formatDistance(token, value));