/** * Tests of the message catalog: the `t` helper (lookup, interpolation, * missing keys) and a scan of the frontend source that every literal key * passed to `t` exists in `en.json`. */ import { readdirSync, readFileSync } from "node:fs"; import { join } from "node:path"; import { afterEach, describe, expect, it, vi } from "vitest"; import en from "../../src/i18n/en.json"; import { hasMessage, t } from "../../src/i18n"; /** Root of the frontend source tree. */ const SRC = join(import.meta.dirname, "..", "..", "src"); /** * Lists the `.ts` and `.vue` files below a directory. * * @param dir - the directory. */ function sourceFiles(dir: string): string[] { return readdirSync(dir, { withFileTypes: true }).flatMap((entry) => { const path = join(dir, entry.name); if (entry.isDirectory()) { return sourceFiles(path); } return /\.(ts|vue)$/.test(entry.name) ? [path] : []; }); } /** * Every call of `t` with a literal first argument, and every literal * `labelKey` (UI commands, whose labels the palette looks up), by file. */ const usedKeys = sourceFiles(SRC).flatMap((file) => [...readFileSync(file, "utf8").matchAll(/(?:\bt\(|\blabelKey:)\s*(["'`])([^"'`]*)\1/g)].map((m) => ({ file, key: m[2] ?? "", })), ); /** * Keys the source never passes to `t` literally because they arrive at * runtime: theme labels from `theme.list`, the settings' `labelKey`, * `descriptionKey`, section names and enum value names from * `settings.list`, the `messageKey` of * `notification` events (engine and desktop host), and the keys the * notifications store passes through a constant. */ const RUNTIME_KEYS = new Set([ "notification.command.failed", "notification.project.notLocal", "notification.project.openFailed", "notification.project.unsavedChanges", "notification.recovery.corrupt", "notification.recovery.unavailable", "notification.recovery.writeFailed", "notification.save.failed", "notification.settings.corrupt", "notification.settings.corruptNotMoved", "notification.settings.unavailable", "notification.toolchain.downloadDone", "notification.toolchain.downloadFailed", "notification.toolchain.downloadStarted", "notification.toolchain.phpMissing", "notification.vfs.pumpFailed", "notification.watch.failed", "settings.appearance.theme.description", "settings.appearance.theme.label", "settings.appearance.theme.value.lutraDark", "settings.appearance.theme.value.lutraLight", "settings.appearance.theme.value.system", "settings.editor.autosave.idleSeconds.description", "settings.editor.autosave.idleSeconds.label", "settings.editor.autosave.onBlur.description", "settings.editor.autosave.onBlur.label", "settings.editor.autosave.onTabSwitch.description", "settings.editor.autosave.onTabSwitch.label", "settings.editor.fontSize.description", "settings.editor.fontSize.label", "settings.php.executable.description", "settings.php.executable.label", "settings.phpactor.autoDownload.description", "settings.phpactor.autoDownload.label", "settings.phpactor.path.description", "settings.phpactor.path.label", "settings.section.appearance", "settings.section.editor", "settings.section.php", "settings.ui.language.description", "settings.ui.language.label", "settings.ui.language.value.en", "theme.lutraDark", "theme.lutraLight", ]); afterEach(() => { vi.restoreAllMocks(); }); describe("t", () => { it("returns the message of a key", () => { expect(t("common.cancel")).toBe("Cancel"); }); it("fills in placeholders", () => { expect(t("editor.tabs.close", { name: "index.php" })).toBe("Close index.php"); expect(t("app.statusBar.version", { name: "Lutra", version: "0.1.0" })).toBe("Lutra 0.1.0"); }); it("formats numbers", () => { expect(t("common.toolWindow.hide", { title: 3 })).toBe("Hide 3"); }); it("keeps a placeholder without a value", () => { expect(t("editor.tabs.close")).toBe("Close {name}"); expect(t("editor.tabs.close", { other: "x" })).toBe("Close {name}"); }); it("does not resolve placeholders from the prototype", () => { expect(t("editor.tabs.close", {})).toBe("Close {name}"); expect(t("common.error.unexpectedResult", { command: "{name}" })).toBe( "unexpected result of {name}", ); }); it("returns the key and warns on a missing key", () => { const warn = vi.spyOn(console, "warn").mockImplementation(() => undefined); expect(t("no.such.key")).toBe("no.such.key"); expect(warn).toHaveBeenCalledWith(expect.stringContaining("no.such.key")); }); it("does not treat prototype names as keys", () => { vi.spyOn(console, "warn").mockImplementation(() => undefined); expect(hasMessage("toString")).toBe(false); expect(t("toString")).toBe("toString"); }); }); describe("en.json", () => { it("uses flat dotted keys of known areas with string values", () => { for (const [key, value] of Object.entries(en)) { expect(key).toMatch( /^(app|command|project|editor|common|palette|theme|recovery|notification|settings|find|goto|structure|menu)\.[A-Za-z0-9]+(\.[A-Za-z0-9]+)*$/, ); expect(typeof value).toBe("string"); expect(value.trim()).not.toBe(""); } }); it("is sorted by key", () => { const keys = Object.keys(en); expect(keys).toEqual([...keys].sort()); }); it("contains every key the source passes to t", () => { expect(usedKeys.length).toBeGreaterThan(0); const missing = usedKeys.filter(({ key }) => !hasMessage(key)); expect(missing).toEqual([]); }); it("has every runtime key", () => { expect([...RUNTIME_KEYS].filter((key) => !hasMessage(key))).toEqual([]); }); it("has no unused keys", () => { const used = new Set([...usedKeys.map(({ key }) => key), ...RUNTIME_KEYS]); expect(Object.keys(en).filter((key) => !used.has(key))).toEqual([]); }); });