- Badges that react to sharks, anchors, crocodiles and llamas read the English text of the incident again, so they unlock in every language. - Scenario names are looked up when shown, so they follow a language switch. - Fall back to English (and lang="en") when the dictionary did not load, and version the dictionary URL so a release never pairs with a stale one. - Share the segmented-button helper between settings and the title screen, merge keys that only differed in a placeholder name, and slim the check script. - Tests: guard the hooks the tour patches into fireFailure/fireEvent, and cover the dictionary fallback and the scenario name.
72 lines
3.2 KiB
JavaScript
72 lines
3.2 KiB
JavaScript
#!/usr/bin/env node
|
|
// Checks a translation against the English text in site/index.html: every tr()/trn()/N_() literal and
|
|
// every data-i18n text, aria-label and title in the static markup should have an entry, no stale entry
|
|
// should linger, and each translation must keep the {placeholders} and HTML tags of its English key.
|
|
// Usage: node scripts/i18n-check.js [lang ...] (default: every site/i18n/*.js)
|
|
const fs = require('node:fs');
|
|
const path = require('node:path');
|
|
const vm = require('node:vm');
|
|
|
|
const SITE = path.join(__dirname, '..', 'site');
|
|
const LIT = String.raw`'(?:[^'\\\n]|\\.)*'|"(?:[^"\\\n]|\\.)*"|\x60(?:[^\x60\\$]|\\.|\$(?!\{))*\x60`;
|
|
const CALL = new RegExp(String.raw`(?<![\w$.])(tr|trn|N_)\(\s*(${LIT})(?:\s*,\s*(${LIT}))?`, 'g');
|
|
const CTX = vm.createContext({});
|
|
const literal = (s) => vm.runInContext(s, CTX);
|
|
|
|
// English keys used by the game. Calls whose text is not a literal cannot be checked and are skipped.
|
|
function sourceKeys(html) {
|
|
const keys = new Set();
|
|
const scripts = [...html.matchAll(/<script>([\s\S]*?)<\/script>/g)].map((m) => m[1]).join('\n');
|
|
for (const m of scripts.matchAll(CALL)) {
|
|
keys.add(literal(m[2]));
|
|
if (m[1] === 'trn' && m[3]) keys.add(literal(m[3]));
|
|
}
|
|
const { JSDOM } = require('jsdom');
|
|
const doc = new JSDOM(html).window.document;
|
|
for (const el of doc.querySelectorAll('[data-i18n]')) keys.add(el.textContent);
|
|
for (const a of ['aria-label', 'title']) for (const el of doc.querySelectorAll(`[${a}]`)) keys.add(el.getAttribute(a));
|
|
return keys;
|
|
}
|
|
|
|
function loadDict(file) {
|
|
const window = {};
|
|
vm.runInNewContext(fs.readFileSync(file, 'utf8'), { window });
|
|
const lang = path.basename(file, '.js');
|
|
return (window.I18N || {})[lang] || {};
|
|
}
|
|
|
|
const placeholders = (s) => (s.match(/\{\w+\}/g) || []).sort().join(' ');
|
|
const tags = (s) => (s.match(/<\/?[a-z][a-z0-9]*/gi) || []).map((t) => t.toLowerCase()).sort().join(' ');
|
|
|
|
// Entries whose translation drops or invents a {placeholder} or an HTML tag, or is empty.
|
|
function brokenEntries(dict) {
|
|
return Object.entries(dict).filter(([en, xx]) => typeof xx !== 'string' || !xx.trim() ||
|
|
placeholders(en) !== placeholders(xx) || tags(en) !== tags(xx)).map(([en]) => en);
|
|
}
|
|
|
|
function check(keys, dict) {
|
|
return {
|
|
missing: [...keys].filter((k) => !(k in dict)),
|
|
unused: Object.keys(dict).filter((k) => !keys.has(k)),
|
|
broken: brokenEntries(dict),
|
|
};
|
|
}
|
|
|
|
module.exports = { loadDict, brokenEntries };
|
|
|
|
if (require.main === module) {
|
|
const keys = sourceKeys(fs.readFileSync(path.join(SITE, 'index.html'), 'utf8'));
|
|
const langs = process.argv.slice(2);
|
|
const files = (langs.length ? langs.map((l) => `${l}.js`) : fs.readdirSync(path.join(SITE, 'i18n')))
|
|
.map((f) => path.join(SITE, 'i18n', f));
|
|
let bad = false;
|
|
for (const file of files) {
|
|
const r = check(keys, loadDict(file));
|
|
console.log(`${path.basename(file)}: ${r.missing.length} missing, ${r.unused.length} unused, ${r.broken.length} broken`);
|
|
for (const [label, list] of [['missing', r.missing], ['unused', r.unused], ['broken', r.broken]]) {
|
|
for (const k of list) console.log(` ${label}: ${JSON.stringify(k)}`);
|
|
}
|
|
bad ||= r.missing.length + r.unused.length + r.broken.length > 0;
|
|
}
|
|
process.exit(bad ? 1 : 0);
|
|
}
|