Files
kandev/apps/web/scripts/check-i18n-keys.test.ts
T
2026-08-04 21:51:32 +01:00

179 lines
6.3 KiB
TypeScript

import { copyFileSync, mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import path from "node:path";
import { spawnSync } from "node:child_process";
import { describe, expect, it } from "vitest";
type Namespace = Record<string, string | number>;
type Locale = Record<string, Namespace>;
type Fixture = Record<string, Locale>;
const ZH_CN = "zh-cn";
const SCRIPT = path.resolve(import.meta.dirname, "check-i18n-keys.mjs");
const CATALOG_HELPER = path.resolve(import.meta.dirname, "lib", "i18n-catalogs.mjs");
function runFixture(fixture: Fixture) {
const root = mkdtempSync(path.join(tmpdir(), "kandev-i18n-keys-"));
try {
const scriptsDir = path.join(root, "scripts");
mkdirSync(scriptsDir, { recursive: true });
const script = path.join(scriptsDir, "check-i18n-keys.mjs");
copyFileSync(SCRIPT, script);
const libDir = path.join(scriptsDir, "lib");
mkdirSync(libDir, { recursive: true });
copyFileSync(CATALOG_HELPER, path.join(libDir, "i18n-catalogs.mjs"));
for (const [locale, namespaces] of Object.entries(fixture)) {
const localeDir = path.join(root, "src", "locales", locale);
mkdirSync(localeDir, { recursive: true });
for (const [namespace, messages] of Object.entries(namespaces)) {
writeFileSync(path.join(localeDir, `${namespace}.json`), JSON.stringify(messages));
}
}
return spawnSync(process.execPath, [script], { encoding: "utf8" });
} finally {
rmSync(root, { recursive: true, force: true });
}
}
const completeFixture = (): Fixture => ({
en: { common: { first: "First", second: "Second" }, settings: { third: "Third" } },
pseudo: { common: { first: "Ƒîřśţ", second: "Śēćøńđ" }, settings: { third: "Ţĥîřđ" } },
[ZH_CN]: { common: { first: "第一", second: "第二" }, settings: { third: "第三" } },
});
describe("real locale catalog parity", () => {
it("accepts a complete real locale", () => {
const result = runFixture(completeFixture());
expect(result.status).toBe(0);
});
it("accepts an identical translated value for a technical literal", () => {
const fixture = completeFixture();
fixture.en.common.first = "Kandev";
fixture[ZH_CN].common.first = "Kandev";
const result = runFixture(fixture);
expect(result.status).toBe(0);
});
it("rejects a missing namespace", () => {
const fixture = completeFixture();
delete fixture[ZH_CN].settings;
const result = runFixture(fixture);
expect(result.status).toBe(1);
expect(result.stderr).toContain(ZH_CN);
expect(result.stderr).toContain("settings");
expect(result.stderr).toContain("missing namespace");
});
it("rejects an extra namespace", () => {
const fixture = completeFixture();
fixture[ZH_CN].extra = { surprise: "意外" };
const result = runFixture(fixture);
expect(result.status).toBe(1);
expect(result.stderr).toContain(ZH_CN);
expect(result.stderr).toContain("extra");
expect(result.stderr).toContain("extra namespace");
});
it("rejects a missing key", () => {
const fixture = completeFixture();
delete fixture[ZH_CN].common.second;
const result = runFixture(fixture);
expect(result.status).toBe(1);
expect(result.stderr).toContain(ZH_CN);
expect(result.stderr).toContain("common");
expect(result.stderr).toContain("missing key: second");
});
it("rejects an extra key", () => {
const fixture = completeFixture();
fixture[ZH_CN].common.surprise = "意外";
const result = runFixture(fixture);
expect(result.status).toBe(1);
expect(result.stderr).toContain(ZH_CN);
expect(result.stderr).toContain("common");
expect(result.stderr).toContain("extra key: surprise");
});
it("rejects a translation that drops an interpolation placeholder", () => {
const fixture = completeFixture();
fixture.en.common.first = "Open {{url}} as {{user}}";
fixture[ZH_CN].common.first = "以 {{user}} 身份打开";
const result = runFixture(fixture);
expect(result.status).toBe(1);
expect(result.stderr).toContain(ZH_CN);
expect(result.stderr).toContain("common");
expect(result.stderr).toContain("interpolation placeholder mismatch: first");
});
it("rejects a translation that drops numeric Trans tags", () => {
const fixture = completeFixture();
fixture.en.common.first = "Open <1>{{url}}</1>";
fixture[ZH_CN].common.first = "打开 {{url}}";
const result = runFixture(fixture);
expect(result.status).toBe(1);
expect(result.stderr).toContain(ZH_CN);
expect(result.stderr).toContain("common");
expect(result.stderr).toContain("Trans tag structure mismatch: first");
});
it("rejects a translation that changes a numeric Trans tag index", () => {
const fixture = completeFixture();
fixture.en.common.first = "Open <1>{{url}}</1>";
fixture[ZH_CN].common.first = "打开 <2>{{url}}</2>";
const result = runFixture(fixture);
expect(result.status).toBe(1);
expect(result.stderr).toContain(ZH_CN);
expect(result.stderr).toContain("common");
expect(result.stderr).toContain("Trans tag structure mismatch: first");
});
});
describe("translated value validation", () => {
it("rejects an empty translated value", () => {
const fixture = completeFixture();
fixture[ZH_CN].common.first = "";
const result = runFixture(fixture);
expect(result.status).toBe(1);
expect(result.stderr).toContain(ZH_CN);
expect(result.stderr).toContain("common");
expect(result.stderr).toContain("empty translated value: first");
});
it("rejects a whitespace-only translated value", () => {
const fixture = completeFixture();
fixture[ZH_CN].common.first = " \t\n ";
const result = runFixture(fixture);
expect(result.status).toBe(1);
expect(result.stderr).toContain(ZH_CN);
expect(result.stderr).toContain("common");
expect(result.stderr).toContain("empty translated value: first");
});
it("rejects a non-string translated value", () => {
const fixture = completeFixture();
fixture[ZH_CN].common.first = 42;
const result = runFixture(fixture);
expect(result.status).toBe(1);
expect(result.stderr).toContain(ZH_CN);
expect(result.stderr).toContain("common");
expect(result.stderr).toContain("non-string translated value: first");
expect(result.stderr).not.toContain("matchAll is not a function");
});
});