feat(format): resolve and apply the date-format preference

Add a date-order resolver + formatter mirroring the hour-cycle path:
AUTO defers to the active locale, DMY/MDY/YMD pin the field order
through a canonical Intl locale. Thread it through makeFormatters and
expose useDateFormatPreference from the i18n context, backed by the
same localStorage mirror as the time-format preference.
This commit is contained in:
Marc-André Bombeck committed 2026-06-26 12:14:56 +02:00
1 parent d8ff18948f
commit 37e539d0bf
4 files changed
+338 -6

No files matched your search

+110
View File
@@ -0,0 +1,110 @@
/**
* Date-order preference resolver + formatter (v1.21.0).
*
* `formatDate` and `resolveDateLocale` are the single source of truth for the
* field order the `<DateField>` primitive and `useFormatters().date()` render.
* AUTO defers to the active locale; DMY / MDY / YMD pin the order regardless.
*/
import { describe, expect, it } from "vitest";
import {
formatDate,
parseIsoDate,
resolveDateLocale,
isDateFormatPreference,
DATE_FORMAT_PREFERENCES,
DATE_FORMAT_OPTIONS,
} from "../date-format";
const ISO = "2026-02-19";
describe("resolveDateLocale", () => {
it("AUTO follows the active locale", () => {
expect(resolveDateLocale("AUTO", "de")).toBe("de-DE");
expect(resolveDateLocale("AUTO", "en")).toBe("en-US");
expect(resolveDateLocale("AUTO", "fr")).toBe("fr-FR");
});
it("DMY / MDY / YMD pin a canonical order locale regardless of UI locale", () => {
expect(resolveDateLocale("DMY", "en")).toBe("de-DE");
expect(resolveDateLocale("MDY", "de")).toBe("en-US");
expect(resolveDateLocale("YMD", "de")).toBe("en-CA");
});
});
describe("formatDate", () => {
it("renders DMY as dd.MM.yyyy", () => {
expect(formatDate(ISO, "DMY", "en")).toBe("19.02.2026");
});
it("renders MDY as MM/dd/yyyy", () => {
expect(formatDate(ISO, "MDY", "de")).toBe("02/19/2026");
});
it("renders YMD as yyyy-MM-dd (ISO)", () => {
expect(formatDate(ISO, "YMD", "de")).toBe("2026-02-19");
});
it("AUTO follows the locale convention", () => {
// de → dd.MM.yyyy, en → MM/dd/yyyy
expect(formatDate(ISO, "AUTO", "de")).toBe("19.02.2026");
expect(formatDate(ISO, "AUTO", "en")).toBe("02/19/2026");
});
it("accepts a Date and an ISO string identically", () => {
const d = new Date(Date.UTC(2026, 1, 19));
expect(formatDate(d, "DMY", "en")).toBe(formatDate(ISO, "DMY", "en"));
});
it("does not drift across a timezone boundary (UTC calendar date)", () => {
// A bare yyyy-MM-dd is a calendar date; it must render the same day in
// every order, never the day before/after.
expect(formatDate("2026-01-01", "DMY", "en")).toBe("01.01.2026");
expect(formatDate("2026-12-31", "YMD", "en")).toBe("2026-12-31");
});
it("returns an empty string for empty / unparseable input", () => {
expect(formatDate("", "AUTO", "en")).toBe("");
expect(formatDate(null, "AUTO", "en")).toBe("");
expect(formatDate(undefined, "AUTO", "en")).toBe("");
expect(formatDate("not-a-date", "AUTO", "en")).toBe("");
});
});
describe("parseIsoDate", () => {
it("parses a valid ISO calendar date to a UTC midnight Date", () => {
const d = parseIsoDate("2026-02-19");
expect(d).not.toBeNull();
expect(d!.getUTCFullYear()).toBe(2026);
expect(d!.getUTCMonth()).toBe(1);
expect(d!.getUTCDate()).toBe(19);
});
it("rejects a non-ISO shape and an impossible date", () => {
expect(parseIsoDate("19.02.2026")).toBeNull();
expect(parseIsoDate("2026-02-31")).toBeNull();
expect(parseIsoDate("2026-13-01")).toBeNull();
});
});
describe("preference list", () => {
it("isDateFormatPreference is a strict guard", () => {
expect(isDateFormatPreference("AUTO")).toBe(true);
expect(isDateFormatPreference("DMY")).toBe(true);
expect(isDateFormatPreference("XYZ")).toBe(false);
expect(isDateFormatPreference(null)).toBe(false);
});
it("exposes all four preferences and matching options", () => {
expect(DATE_FORMAT_PREFERENCES).toEqual(["AUTO", "DMY", "MDY", "YMD"]);
expect(DATE_FORMAT_OPTIONS.map((o) => o.value)).toEqual([
"AUTO",
"DMY",
"MDY",
"YMD",
]);
for (const opt of DATE_FORMAT_OPTIONS) {
expect(opt.labelKey).toMatch(/^settings\.dateFormat\./);
}
});
});