mirror of
https://github.com/maziggy/bambuddy.git
synced 2026-09-30 03:01:21 +02:00
* fix(i18n): sync zh-CN to match en structure
- Add 74 missing keys covering login.resetPassword, printers.firmwareModal
badges, settings.spoolbuddy device management, settings.tabs.spoolbuddy,
spoolbuddy.settings system config
- Fix fileManager.uploadFailed placeholder bug (had stray {{count}} copied
from zipFilesFailed; en value is plain "Upload failed")
Refs #1017
* feat(i18n): add zh-TW locale and enforce 3-way parity
- Add frontend/src/i18n/locales/zh-TW.ts (Traditional Chinese, Taiwan usage)
with full key set aligned to en.ts
- Register zh-TW in frontend/src/i18n/index.ts: import, resources,
supportedLngs, availableLanguages
- Add frontend/scripts/check-i18n-parity.mjs: TypeScript Compiler API-based
3-way gate checking key set equality, placeholder equality, and legacy
_plural / _one+_other suffix handling across en / zh-CN / zh-TW
- Wire check:i18n into test:run npm script so frontend-tests CI job
(ci.yml:227) gates future locale drift
Fixes #1017
This commit is contained in:
Minidoracat
@@ -0,0 +1,174 @@
|
||||
#!/usr/bin/env node
|
||||
// Verifies parity across locale files (en / zh-CN / zh-TW):
|
||||
// 1. Leaf-key sets are identical
|
||||
// 2. Each leaf's {{placeholder}} set is identical
|
||||
// 3. Plural suffixes: every en key ending in _plural / _one / _other must
|
||||
// exist in every other locale, and other locales must not introduce an
|
||||
// _one key that en does not have.
|
||||
// Malformed input (missing `export default`, parse errors, non-string leaves,
|
||||
// unsupported property kinds) fails loudly instead of silently passing the gate.
|
||||
// Exits 1 with a diagnostic report on any failure, else exits 0.
|
||||
|
||||
import fs from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import url from 'node:url';
|
||||
|
||||
const scriptDir = path.dirname(url.fileURLToPath(import.meta.url));
|
||||
const frontendDir = path.resolve(scriptDir, '..');
|
||||
const localesDir = path.join(frontendDir, 'src/i18n/locales');
|
||||
const tsPath = path.join(frontendDir, 'node_modules/typescript/lib/typescript.js');
|
||||
|
||||
const tsModule = await import(url.pathToFileURL(tsPath).href);
|
||||
const ts = tsModule.default ?? tsModule;
|
||||
|
||||
function collectLeaves(node, prefix, leaves) {
|
||||
if (!ts.isObjectLiteralExpression(node)) return;
|
||||
for (const prop of node.properties) {
|
||||
if (!ts.isPropertyAssignment(prop)) {
|
||||
console.error(
|
||||
`Unsupported property kind ${ts.SyntaxKind[prop.kind]} at "${prefix}" ` +
|
||||
`(locale files must use plain \`key: value\` assignments — no spread, shorthand, methods, or accessors).`,
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
let name;
|
||||
if (ts.isIdentifier(prop.name)) name = prop.name.text;
|
||||
else if (ts.isStringLiteral(prop.name) || ts.isNoSubstitutionTemplateLiteral(prop.name)) name = prop.name.text;
|
||||
else if (ts.isComputedPropertyName(prop.name)) {
|
||||
console.error(`ComputedPropertyName not allowed in locale file at path "${prefix}"`);
|
||||
process.exit(1);
|
||||
} else {
|
||||
console.error(`Unsupported property-name kind ${ts.SyntaxKind[prop.name.kind]} at "${prefix}"`);
|
||||
process.exit(1);
|
||||
}
|
||||
const p = prefix ? `${prefix}.${name}` : name;
|
||||
if (ts.isObjectLiteralExpression(prop.initializer)) {
|
||||
collectLeaves(prop.initializer, p, leaves);
|
||||
} else {
|
||||
const value = extractStringValue(prop.initializer, p);
|
||||
leaves.set(p, value);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function extractStringValue(node, keyPath) {
|
||||
if (ts.isStringLiteral(node) || ts.isNoSubstitutionTemplateLiteral(node)) return node.text;
|
||||
if (ts.isTemplateExpression(node)) {
|
||||
let out = node.head.text;
|
||||
for (const span of node.templateSpans) {
|
||||
out += '${' + span.expression.getText() + '}';
|
||||
out += span.literal.text;
|
||||
}
|
||||
return out;
|
||||
}
|
||||
console.error(
|
||||
`Non-string leaf at "${keyPath}" (kind=${ts.SyntaxKind[node.kind]}): ${node.getText()}\n` +
|
||||
`Locale files must only contain string or template literals as leaf values.`,
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
function loadLocale(filePath) {
|
||||
const src = fs.readFileSync(filePath, 'utf8');
|
||||
const sf = ts.createSourceFile(filePath, src, ts.ScriptTarget.Latest, true);
|
||||
if (sf.parseDiagnostics && sf.parseDiagnostics.length > 0) {
|
||||
console.error(`${filePath}: ${sf.parseDiagnostics.length} parse error(s):`);
|
||||
for (const d of sf.parseDiagnostics.slice(0, 10)) {
|
||||
const msg = typeof d.messageText === 'string' ? d.messageText : d.messageText.messageText;
|
||||
const { line, character } = sf.getLineAndCharacterOfPosition(d.start ?? 0);
|
||||
console.error(` ${line + 1}:${character + 1} ${msg}`);
|
||||
}
|
||||
process.exit(1);
|
||||
}
|
||||
const leaves = new Map();
|
||||
let foundExport = false;
|
||||
ts.forEachChild(sf, (n) => {
|
||||
if (ts.isExportAssignment(n)) {
|
||||
foundExport = true;
|
||||
collectLeaves(n.expression, '', leaves);
|
||||
}
|
||||
});
|
||||
if (!foundExport) {
|
||||
console.error(`${filePath}: no \`export default\` found — locale files must use \`export default { ... }\`.`);
|
||||
process.exit(1);
|
||||
}
|
||||
if (leaves.size === 0) {
|
||||
console.error(`${filePath}: \`export default\` resolved to zero leaves — file is empty or not a nested object.`);
|
||||
process.exit(1);
|
||||
}
|
||||
return leaves;
|
||||
}
|
||||
|
||||
const locales = {
|
||||
en: loadLocale(path.join(localesDir, 'en.ts')),
|
||||
'zh-CN': loadLocale(path.join(localesDir, 'zh-CN.ts')),
|
||||
'zh-TW': loadLocale(path.join(localesDir, 'zh-TW.ts')),
|
||||
};
|
||||
|
||||
let failed = false;
|
||||
const MAX_REPORT = 20;
|
||||
|
||||
function reportList(label, items) {
|
||||
if (items.length === 0) return;
|
||||
failed = true;
|
||||
console.error(`\n[${label}] (${items.length})`);
|
||||
items.slice(0, MAX_REPORT).forEach((i) => console.error(` ${i}`));
|
||||
if (items.length > MAX_REPORT) console.error(` ... and ${items.length - MAX_REPORT} more`);
|
||||
}
|
||||
|
||||
// Check 1: key set equality
|
||||
const enKeys = new Set(locales.en.keys());
|
||||
for (const [code, map] of Object.entries(locales)) {
|
||||
if (code === 'en') continue;
|
||||
const keys = new Set(map.keys());
|
||||
const missing = [...enKeys].filter((k) => !keys.has(k)).sort();
|
||||
const extra = [...keys].filter((k) => !enKeys.has(k)).sort();
|
||||
reportList(`${code}: missing keys vs en`, missing);
|
||||
reportList(`${code}: extra keys vs en`, extra);
|
||||
}
|
||||
|
||||
// Check 2: placeholder set equality per leaf
|
||||
const placeholderRe = /\{\{[^{}]+\}\}/g;
|
||||
for (const [code, map] of Object.entries(locales)) {
|
||||
if (code === 'en') continue;
|
||||
const mismatches = [];
|
||||
for (const [key, enValue] of locales.en) {
|
||||
const otherValue = map.get(key);
|
||||
if (otherValue === undefined) continue;
|
||||
const enPlaceholders = new Set((enValue.match(placeholderRe) ?? []));
|
||||
const otherPlaceholders = new Set((otherValue.match(placeholderRe) ?? []));
|
||||
const missingPh = [...enPlaceholders].filter((p) => !otherPlaceholders.has(p));
|
||||
const extraPh = [...otherPlaceholders].filter((p) => !enPlaceholders.has(p));
|
||||
if (missingPh.length || extraPh.length) {
|
||||
mismatches.push(`${key}: en=${[...enPlaceholders].join(',') || '∅'} vs ${code}=${[...otherPlaceholders].join(',') || '∅'}`);
|
||||
}
|
||||
}
|
||||
reportList(`${code}: placeholder mismatch vs en`, mismatches);
|
||||
}
|
||||
|
||||
// Check 3: plural suffix presence + reverse _one guard
|
||||
for (const [code, map] of Object.entries(locales)) {
|
||||
if (code === 'en') continue;
|
||||
const pluralIssues = [];
|
||||
for (const key of enKeys) {
|
||||
if (key.endsWith('_plural') && !map.has(key)) pluralIssues.push(`missing _plural key: ${key}`);
|
||||
if (key.endsWith('_one') && !map.has(key)) pluralIssues.push(`missing _one key: ${key}`);
|
||||
if (key.endsWith('_other') && !map.has(key)) pluralIssues.push(`missing _other key: ${key}`);
|
||||
}
|
||||
for (const key of map.keys()) {
|
||||
if (key.endsWith('_one') && !enKeys.has(key)) {
|
||||
pluralIssues.push(`unexpected _one not present in en: ${key}`);
|
||||
}
|
||||
}
|
||||
reportList(`${code}: plural key mismatch`, pluralIssues);
|
||||
}
|
||||
|
||||
if (failed) {
|
||||
console.error('\n❌ i18n parity check failed.');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
console.log(`All locales in parity (en / zh-CN / zh-TW):`);
|
||||
for (const [code, map] of Object.entries(locales)) {
|
||||
console.log(` ${code}: ${map.size} leaves`);
|
||||
}
|
||||
Reference in New Issue
Block a user