Files
openidea/src/platform/dateFormat.ts
T
zhangdagouandPLZY b02964962b fix(vcs): show the time of older commits in the Git Log (#3206)
With pretty dates on, commits older than yesterday showed only the date; they now show date and time (numeric date, e.g. 2026/11/11 22:43), and the same format is used with pretty dates off. Today, Yesterday and N min ago are unchanged. The date column's default width grows from 120 to 140 px so a 12-hour date and time ("11/05/2026 02:30 PM", "Yesterday 09:07 AM") is no longer cut off.

Co-authored-by: PLZY <41029728+PLZY@users.noreply.github.com>
2026-11-14 00:52:49 +08:00

102 lines
4.3 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
* Date / time formatting per Settings › System Settings › Date Formats:
* "Override system date and time format" (pattern + 24-hour time) and
* "Use pretty formatting" (Today / Yesterday / N min ago). Used by the Git
* log, Local History, commit details and blame.
*/
import { tx } from "./i18n";
import { useProject } from "./project";
export interface DateFormatOptions {
overrideSystem: boolean;
/** `yyyy`, `yy`, `MMMM`, `MMM`, `MM`, `M`, `dd`, `d` placeholders. */
pattern: string;
use24Hour: boolean;
pretty: boolean;
}
export const DEFAULT_DATE_FORMAT: DateFormatOptions = {
overrideSystem: false,
pattern: "dd.MM.yyyy",
use24Hour: true,
pretty: true,
};
export function dateFormatOptions(): DateFormatOptions {
const raw = useProject.getState().settings?.general?.dateFormat as Partial<DateFormatOptions> | undefined;
return {
overrideSystem: typeof raw?.overrideSystem === "boolean" ? raw.overrideSystem : DEFAULT_DATE_FORMAT.overrideSystem,
pattern: typeof raw?.pattern === "string" && raw.pattern.trim() ? raw.pattern : DEFAULT_DATE_FORMAT.pattern,
use24Hour: typeof raw?.use24Hour === "boolean" ? raw.use24Hour : DEFAULT_DATE_FORMAT.use24Hour,
pretty: typeof raw?.pretty === "boolean" ? raw.pretty : DEFAULT_DATE_FORMAT.pretty,
};
}
const pad = (n: number, w = 2) => String(n).padStart(w, "0");
// `toLocale*String` with options builds a new `Intl.DateTimeFormat` on every call,
// far too slow for lists that format a date per row.
const formatters = new Map<string, Intl.DateTimeFormat>();
function formatter(locale: string | undefined, options: Intl.DateTimeFormatOptions): Intl.DateTimeFormat {
const key = `${locale ?? ""}|${JSON.stringify(options)}`;
let f = formatters.get(key);
if (!f) formatters.set(key, (f = new Intl.DateTimeFormat(locale, options)));
return f;
}
/** Formats the date part with a `dd.MM.yyyy`-style pattern. */
export function formatPattern(d: Date, pattern: string): string {
const tokens: Record<string, () => string> = {
yyyy: () => String(d.getFullYear()),
yy: () => pad(d.getFullYear() % 100),
MMMM: () => formatter("en", { month: "long" }).format(d),
MMM: () => formatter("en", { month: "short" }).format(d),
MM: () => pad(d.getMonth() + 1),
M: () => String(d.getMonth() + 1),
dd: () => pad(d.getDate()),
d: () => String(d.getDate()),
};
return pattern.replace(/yyyy|yy|MMMM|MMM|MM|M|dd|d/g, (m) => tokens[m]!());
}
export function formatClock(d: Date, o: DateFormatOptions = dateFormatOptions()): string {
if (!o.overrideSystem) return formatter(undefined, { hour: "2-digit", minute: "2-digit" }).format(d);
if (o.use24Hour) return `${pad(d.getHours())}:${pad(d.getMinutes())}`;
const h = d.getHours() % 12 || 12;
return `${h}:${pad(d.getMinutes())} ${d.getHours() < 12 ? "AM" : "PM"}`;
}
/** Date only (blame gutter, compact columns). */
export function formatDay(d: Date, o: DateFormatOptions = dateFormatOptions(), short = false): string {
if (o.overrideSystem) return formatPattern(d, o.pattern);
return short
? formatter(undefined, { year: "2-digit", month: "2-digit", day: "2-digit" }).format(d)
: formatter(undefined, { year: "numeric", month: "short", day: "numeric" }).format(d);
}
/** Numeric date and time (`2026/11/11 22:43`), IDEA's `formatDateTime`. */
export function formatDateTime(d: Date, o: DateFormatOptions = dateFormatOptions()): string {
const day = o.overrideSystem
? formatPattern(d, o.pattern)
: formatter(undefined, { year: "numeric", month: "2-digit", day: "2-digit" }).format(d);
return `${day} ${formatClock(d, o)}`;
}
/**
* Timestamp for lists: pretty ("Today 10:42", "5 min ago") when enabled, else date + time;
* older dates keep their time, as IDEA's `formatPrettyDateTime` does.
*/
export function formatTimestamp(ms: number, now = Date.now(), o: DateFormatOptions = dateFormatOptions()): string {
const d = new Date(ms);
if (o.pretty) {
const diff = now - ms;
const min = 60_000;
if (diff >= 0 && diff < min) return tx("Moments ago");
if (diff >= 0 && diff < 60 * min) return tx`${Math.floor(diff / min)} min ago`;
const today = new Date(now);
if (d.toDateString() === today.toDateString()) return tx`Today ${formatClock(d, o)}`;
if (d.toDateString() === new Date(now - 86_400_000).toDateString()) return tx`Yesterday ${formatClock(d, o)}`;
}
return formatDateTime(d, o);
}