M1.11: English message catalog for every UI string
ui/src/i18n: en.json (20 flat dotted keys) and t(key, params?) with
{name} interpolation; a missing key warns in dev and returns the key.
All template text, title/aria-label attributes, notices and frontend
error texts go through t. ESLint vue/no-bare-strings-in-template is an
error. Catalog tests: interpolation, missing key, every t() key exists,
no unused keys. Engine messages stay English (G14). Docs updated.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
851d438e2a
commit
7c0fb312f6
21 changed files with 273 additions and 37 deletions
105
ui/tests/i18n/catalog.test.ts
Normal file
105
ui/tests/i18n/catalog.test.ts
Normal file
|
|
@ -0,0 +1,105 @@
|
|||
/**
|
||||
* 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, by file. */
|
||||
const usedKeys = sourceFiles(SRC).flatMap((file) =>
|
||||
[...readFileSync(file, "utf8").matchAll(/\bt\(\s*(["'`])([^"'`]*)\1/g)].map((m) => ({
|
||||
file,
|
||||
key: m[2] ?? "",
|
||||
})),
|
||||
);
|
||||
|
||||
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|project|editor|common)\.[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 no unused keys", () => {
|
||||
const used = new Set(usedKeys.map(({ key }) => key));
|
||||
expect(Object.keys(en).filter((key) => !used.has(key))).toEqual([]);
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue