Skip to content

Record your screen, ship a demo. Free and open-source, GPU-accelerated, no watermarks, no subscriptions. Windows, macOS, Linux. Actively maintained.

test(i18n): guard tooltip placeholders and length in every locale

EtienneLescotbfa091ea8ad4
diff --git a/src/i18n/__tests__/tooltipCopy.test.ts b/src/i18n/__tests__/tooltipCopy.test.ts
new file mode 100644
index 000000000..105baddc5
--- /dev/null
+++ b/src/i18n/__tests__/tooltipCopy.test.ts
@@ -0,0 +1,77 @@
+// The two things `npm run i18n:check` cannot see in a tooltip string.
+//
+// It only compares key sets, so a locale that renames `{{language}}` or drops it passes, and at
+// runtime shows the raw `{{raccourci}}` (or the untouched `{{language}}`). Nor does it look at
+// length: a tooltip is capped at 260px wide and reads best in at most four lines. Add a key here
+// when a tooltip (or the accessible name of an icon-only control) gets one.
+//
+// See technical-documentation/engineering/tooltips.md.
+
+import { readdirSync, readFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { describe, expect, it } from "vitest";
+
+const LOCALES_DIR = resolve(process.cwd(), "src/i18n/locales");
+const MAX_LENGTH = 130;
+
+const TOOLTIP_KEYS: Record<string, string[]> = {
+ launch: [
+ "tooltips.hideHUD",
+ "tooltips.hideHUDTip",
+ "tooltips.closeApp",
+ "tooltips.restartRecording",
+ "tooltips.cancelRecording",
+ "tooltips.pauseRecording",
+ "tooltips.resumeRecording",
+ "tooltips.useVerticalTray",
+ "tooltips.useHorizontalTray",
+ "tooltips.changeSource",
+ "tooltips.systemAudio",
+ "tooltips.microphone",
+ "tooltips.camera",
+ "tooltips.openStudio",
+ "tooltips.openNotes",
+ "cursor.name",
+ "cursor.editableTip",
+ "cursor.systemTip",
+ "recording.selectSource",
+ "recording.systemPicker",
+ "recording.start",
+ "recording.stop",
+ "languageWithName",
+ "deviceSettings.title",
+ "deviceSettings.close",
+ ],
+};
+
+function read(locale: string, namespace: string, key: string): string {
+ const file = JSON.parse(readFileSync(`${LOCALES_DIR}/${locale}/${namespace}.json`, "utf8"));
+ const value = key.split(".").reduce((node, part) => node?.[part], file);
+ if (typeof value !== "string") throw new Error(`${locale}/${namespace}: ${key} is not a string`);
+ return value;
+}
+
+const placeholders = (text: string) =>
+ [...text.matchAll(/\{\{\s*\w+\s*\}\}/g)].map((m) => m[0]).sort();
+// en included: it is the source, and its own length is held to the same cap.
+const locales = readdirSync(LOCALES_DIR);
+const entries = Object.entries(TOOLTIP_KEYS).flatMap(([namespace, keys]) =>
+ keys.map((key) => [namespace, key] as const),
+);
+
+describe("tooltip strings", () => {
+ it.each(locales)("%s keeps the placeholders of en and stays short", (locale) => {
+ const placeholderDrift: string[] = [];
+ const tooLong: string[] = [];
+ for (const [namespace, key] of entries) {
+ const text = read(locale, namespace, key);
+ const source = read("en", namespace, key);
+ if (placeholders(text).join() !== placeholders(source).join()) {
+ placeholderDrift.push(`${namespace}.${key}: ${text}`);
+ }
+ if (text.length > MAX_LENGTH) tooLong.push(`${namespace}.${key} (${text.length})`);
+ }
+ expect(placeholderDrift).toEqual([]);
+ expect(tooLong).toEqual([]);
+ });
+});