- docs/adr/0001: GitHub Pages is the only host, not open for renegotiation - docs/adr/0002: source in many files, shipped as one page assembled at build - tests/pages.test.js: builds stay static files Pages can serve, all local references resolve, only release.yml deploys and only via the Pages actions - tests/build.test.js: partial naming and layout rules - new skills: github-pages, edit-the-game; add-strings, performance, release and write-tests updated for src/, sorted dictionaries and --base-ref - CLAUDE.md, ARCHITECTURE.md, CONTRIBUTING.md (incl. porting older branches), README.md and the PR template describe the new layout
2.5 KiB
| name | description |
|---|---|
| add-strings | Add or change player-facing text in Series of Tubes and keep every translation (site/i18n/*.js) complete. |
Adding or changing player-facing text
The English text is the translation key. Every string a player can see must go
through the translation helpers and have an entry in every dictionary in site/i18n/
(Italian it.js, Portuguese pt.js, French fr.js). The code is in src/.
In the code
tr('Text with {name}', {name}): translate now and fill placeholders.trn('{n} router', '{n} routers', n, vars): plurals; both forms are keys.N_('Text'): marks a literal kept in a table for latertr()(e.g. labels stored in constants). Calltr(x)where it's shown.- Static HTML: add
data-i18nto the element;aria-labelandtitleattributes are collected automatically. - Text must be a string literal inside the call, or the checker can't see it.
- Keep HTML (
<b>,<br>,<small>) and{placeholders}identical in translations. - Don't build sentences by concatenating translated fragments; translate whole sentences.
In the dictionary
site/i18n/<lang>.js is one object, "English":"Translation", per line, sorted by the English
text. Sorted files mean two pull requests that add strings touch different lines instead of both
appending at the end. Don't edit the lines by hand; use the script, which quotes correctly, keeps the
order and works on every dictionary at once:
cat > /tmp/strings.json <<'JSON'
{
"it": { "New English text": "Nuovo testo italiano", "Text that was removed": null },
"pt": { "New English text": "Novo texto em português" },
"fr": { "New English text": "Nouveau texte en français" }
}
JSON
node scripts/i18n-add.js /tmp/strings.json # a string adds or replaces, null removes
node scripts/i18n-add.js --rename "Old English" "New English" # English text changed: move the key everywhere
If a dictionary got out of order anyway (a hand edit, a merge), npm run i18n:fix sorts it again;
npm run i18n:check fails until it is sorted.
Italian style
Natural, friendly Italian, informal "tu". Keep networking terms that Italian engineers use in English (peering, transit, router, POP, PNI, LAG, dark fiber). Translate puns into an Italian joke when one fits; otherwise keep the pun name and translate the rest.
Check
node scripts/i18n-check.js # must say: 0 missing, 0 unused, 0 broken
npm test # includes tests/i18n.test.js