client: fix i18next config to generate i18n data correctly

client/i18next-scanner.config.cjs

@@ -68,17 +68,25 @@ function flush(done) {
   done();
 }
 
-
 module.exports = {
   input: [
-    'client/src/**/*.{tsx,ts}',
+    'src/**/*.{tsx,ts}',
     // Use ! to filter out files or directories
-    '!client/i18n/**',
+    '!i18n/**',
     '!**/node_modules/**',
   ],
   options: {
     debug: true,
-    removeUnusedKeys: true,
+    /**
+     * For example, the return value of a `TabTitle` element is
+     * subject to translation, but it is removed because it cannot
+     * be detected by i18next-scanner.
+     * 
+     * The relevant section will be displayed as a warning when
+     * `npm run translate` is executed, and resolving the warning
+     * will restore it to `true`.
+     */
+    removeUnusedKeys: false,
     func: {
       list: ['i18next.t', 'i18n.t', 't'],
       extensions: ['.js', '.jsx'] // not .ts or .tsx since we use i18next-scanner-typescript!
@@ -111,8 +119,8 @@ module.exports = {
       return ''; // Return empty string for other languages
     },
     resource: {
-      loadPath: './client/public/locales/{{lng}}/{{ns}}.json',
-      savePath: './client/public/locales/{{lng}}/{{ns}}.json',
+      loadPath: './public/locales/{{lng}}/{{ns}}.json',
+      savePath: './public/locales/{{lng}}/{{ns}}.json',
       jsonIndent: 2,
       lineEnding: '\n'
     },
@@ -148,5 +156,4 @@ module.exports = {
       done();
     }
   ),
-
 };

client/public/locales/de/translation.json

@@ -1,41 +1,21 @@
 {
-  "Caption": {
-    "translation": "Lean-Lern-Spiel-Server"
-  },
-  "Subcaption": {
-    "description": "Eine Sammlung von Lernspielen für den Beweisassistenten <1>Lean</1> <i>(Lean 4)</i> und dessen mathematische Bibliothek <2>mathlib</2>"
-  },
-  "Development notes": {
-    "translation": "Entwicklungsstand",
-    "description": "Der Spieleserver und die alle Spiele befinden sich in fortlaufender Entwicklung.  Wir bitten darum, Fehler und Ungereimtheiten als <1>GitHub Issue</1> zu melden."
-  },
-  "Adding new games": {
-    "translation": "Neue Spiele hinzufügen",
-    "description": "Für alle, die selbst Spiel entwickeln möchten, gibt es ein <1>GameSkeleton Github Repo</1> als Vorlage und die Anleitung <2>How to Create a Game</2>.<p>Die <3>Anleitung</3> erklärt auch, wie ein solches Spiel mittels einer passenden URL auf den Sever geladen und gespiel werden kann. Fragen dazu beantworten wir gern.</p><p>Als Kacheln sichtbar ist auf dieser Seite nur eine kuratierte Auswahl an existierenden Spielen. Wir erweitern diese Auswahl auf Anfrage sehr gerne.</p>"
-  },
-  "Funding": {
-    "translation": "Finanzierung",
-    "description": "Dieser Spiele-Server wird bereitgestellt vom Zentrum für Informations- und Medientechnologie der Heinrich-Heine-Universität Düsseldorf. Die lean4game-Software wurde im Rahmen des Projekts <1>ADAM: Anticipating the Digital Age of Mathematics</1> entwickelt, finanziert durch das Programm <i>Freiraum 2022</i> der <i>Stiftung Innovation in der Hochschullehre</i>. Der laufende Betrieb des Servers und die Weiterentwicklung der Software werden durch Mittel des <i>AI for Math Fund</i> der Stiftung <i>Renaissance Philanthropy</i> ermöglicht."
-  },
-  "Server capacity": {
-    "translation": "Server-Auslastung",
-    "description": "Diese Server läuft auf universitäter Infrastruktur mit begrenzten Kapazitäten. Wir schätzen, dass unsere Konfiguration etwa 50 gleichzeitige Spiele mit hoher Leistung und bis zu 180 gleichzeitige Spiele mit geringerer Leistung unterstützen wird."
-  },
-  "No Games": {
-    "description": "Kein Spiel geladen.  Öffne <1>http://localhost:3000/#/g/local/FOLDER</1> um ein Spiel direkt aus einem lokalen Ordner zu laden."
-  },
-  "Progress saving": {
-    "translation": "Spielstandspeicherung",
-    "description": "Das Spiel speichert den Spielstand im lokalen Browserspeicher. Wird dieser gelöscht, ist der Spielstand nicht wiederherstellbar!<br/>Achtung: In üblichen Browsern bewirkt ein löschen von Cookies auch ein löschen des lokalen Browserspeichers (z.B. \"local site data\"). Der Spielstand sollte vorgehend heruntergeladen werden!"
-  },
-  "Development": {
-    "translation": "Entwicklung",
-    "description": "Der Spieleserver wurde entwickelt von <strong>Alexander Bentkamp</strong>, <strong>Jon Eugster</strong>. Basierend auf einem Prototyp von <strong>Patrick Massot</strong>.Der Sourcecode dieses Lean-Game-Engine ist <1>auf Github verfügbar</1>. Bei Problemen, bitte einen <2>Github-Issue</2> ausfüllen oder direkt mit uns Kontakt aufnehmen."
-  },
-  "Accessibility": {
-    "translation": "Barrierefreiheit",
-    "description": "Sollten Sie auf Barrieren stoßen, die Ihnen den Zugang erschweren, wenden Sie sich bitte an uns! Wir sind bestrebt, solche Barrieren nach besten Kräften zu beseitigen."
-  },
+  "Caption.translation": "Lean-Lern-Spiel-Server",
+  "Subcaption.description": "Eine Sammlung von Lernspielen für den Beweisassistenten <1>Lean</1> <i>(Lean 4)</i> und dessen mathematische Bibliothek <2>mathlib</2>",
+  "Development notes.translation": "Entwicklungsstand",
+  "Development notes.description": "Der Spieleserver und die alle Spiele befinden sich in fortlaufender Entwicklung.  Wir bitten darum, Fehler und Ungereimtheiten als <1>GitHub Issue</1> zu melden.",
+  "Adding new games.translation": "Neue Spiele hinzufügen",
+  "Adding new games.description": "Für alle, die selbst Spiel entwickeln möchten, gibt es ein <1>GameSkeleton Github Repo</1> als Vorlage und die Anleitung <2>How to Create a Game</2>.<p>Die <3>Anleitung</3> erklärt auch, wie ein solches Spiel mittels einer passenden URL auf den Sever geladen und gespiel werden kann. Fragen dazu beantworten wir gern.</p><p>Als Kacheln sichtbar ist auf dieser Seite nur eine kuratierte Auswahl an existierenden Spielen. Wir erweitern diese Auswahl auf Anfrage sehr gerne.</p>",
+  "Funding.translation": "Finanzierung",
+  "Funding.description": "Dieser Spiele-Server wird bereitgestellt vom Zentrum für Informations- und Medientechnologie der Heinrich-Heine-Universität Düsseldorf. Die lean4game-Software wurde im Rahmen des Projekts <1>ADAM: Anticipating the Digital Age of Mathematics</1> entwickelt, finanziert durch das Programm <i>Freiraum 2022</i> der <i>Stiftung Innovation in der Hochschullehre</i>. Der laufende Betrieb des Servers und die Weiterentwicklung der Software werden durch Mittel des <i>AI for Math Fund</i> der Stiftung <i>Renaissance Philanthropy</i> ermöglicht.",
+  "Server capacity.translation": "Server-Auslastung",
+  "Server capacity.description": "Diese Server läuft auf universitäter Infrastruktur mit begrenzten Kapazitäten. Wir schätzen, dass unsere Konfiguration etwa 50 gleichzeitige Spiele mit hoher Leistung und bis zu 180 gleichzeitige Spiele mit geringerer Leistung unterstützen wird.",
+  "No Games.description": "Kein Spiel geladen.  Öffne <1>http://localhost:3000/#/g/local/FOLDER</1> um ein Spiel direkt aus einem lokalen Ordner zu laden.",
+  "Progress saving.translation": "Spielstandspeicherung",
+  "Progress saving.description": "Das Spiel speichert den Spielstand im lokalen Browserspeicher. Wird dieser gelöscht, ist der Spielstand nicht wiederherstellbar!<br/>Achtung: In üblichen Browsern bewirkt ein löschen von Cookies auch ein löschen des lokalen Browserspeichers (z.B. \"local site data\"). Der Spielstand sollte vorgehend heruntergeladen werden!",
+  "Development.translation": "Entwicklung",
+  "Development.description": "Der Spieleserver wurde entwickelt von <strong>Alexander Bentkamp</strong>, <strong>Jon Eugster</strong>. Basierend auf einem Prototyp von <strong>Patrick Massot</strong>.Der Sourcecode dieses Lean-Game-Engine ist <1>auf Github verfügbar</1>. Bei Problemen, bitte einen <2>Github-Issue</2> ausfüllen oder direkt mit uns Kontakt aufnehmen.",
+  "Accessibility.translation": "Barrierefreiheit",
+  "Accessibility.description": "Sollten Sie auf Barrieren stoßen, die Ihnen den Zugang erschweren, wenden Sie sich bitte an uns! Wir sind bestrebt, solche Barrieren nach besten Kräften zu beseitigen.",
   "Tactics": "Taktiken",
   "<p>Game rules determine if it is allowed to skip levels and if the games runs checks to only allow unlocked tactics and theorems in proofs.</p><1>Note: \"Unlocked\" tactics (or theorems) are determined by two things: The set of minimal tactics needed to solve a level, plus any tactics you unlocked in another level. That means if you unlock <1>simp</1> in a level, you can use it henceforth in any level.</1><p>The options are:</p>": "<p>Die Spielregeln bestimmen ob es erlaubt ist, Levels zu überspringen und ob das Spiel überprüft welche Taktiken und Theoreme freigeschaltet sind und nur diese im Beweis akzeptiert.</p><1>Bemerkung: \"Freigeschaltete\" Taktiken (und Theoreme) werden durch zwei Faktoren bestimmt: The Menge der Taktiken die minimal notwending sind um den Level zu lösen und dazu die Menge aller Taktiken, die in einem anderen Level freigeschaltet wurden. Das bedeutet wenn <1>simp</1> in einem Level freigeschaltet wird, kann diese Taktik danach in jeglichen Levels verwendet werden.",
   "Game Rules": "Spielregeln",
@@ -98,7 +78,7 @@
   "Layout": "Seitenlayout",
   "Always visible": "Immer sichtbar",
   "Save my settings (in the browser store)": "Einstellungen im Browser speichern.",
-    "<p>Select a JSON file with the saved game progress to load your progress.</p><1><0>Warning:</0> This will delete your current game progress! Consider <2>downloading your current progress</2> first!</1>": "<p>Wähle eine JSON-Datei mit einem Spielstand, um diesen zu laden.</p><1><0>Achtung:</0> Deraktuelle Spielstand wird dabei überschrieben! Wenn du noch einmal zum aktuellen Spielstand zurückkehren möchtest, solltest du zunächst den <2>aktuellen Spielstand herunterladen</2>!</1>",
+  "<p>Select a JSON file with the saved game progress to load your progress.</p><1><0>Warning:</0> This will delete your current game progress! Consider <2>downloading your current progress</2> first!</1>": "<p>Wähle eine JSON-Datei mit einem Spielstand, um diesen zu laden.</p><1><0>Achtung:</0> Deraktuelle Spielstand wird dabei überschrieben! Wenn du noch einmal zum aktuellen Spielstand zurückkehren möchtest, solltest du zunächst den <2>aktuellen Spielstand herunterladen</2>!</1>",
   "Upload Saved Progress": "Spielstand hochladen",
   "Load selected file": "Ausgewählte Datei hochladen",
   "Mobile": "Mobil",

client/public/locales/en/translation.json

@@ -1,41 +1,21 @@
 {
-  "Caption": {
-    "translation": "Lean Game Server"
-  },
-  "Subcaption": {
-    "description": "A repository of learning games for the proof assistant <1>Lean</1> <i>(Lean 4)</i> and its mathematical library <2>mathlib</2>"
-  },
-  "Development notes": {
-    "translation": "Development notes",
-    "description": "<p>Most aspects of the games and the infrastructure are still in development. Feel free to file a <1>GitHub Issue</1> about any problems you experience!</p>"
-  },
-  "Adding new games": {
-    "translation": "Adding new games",
-    "description": "If you are considering writing your own game, you should use the <1>GameSkeleton Github Repo</1> as a template and read <2>How to Create a Game</2>.<p>You can directly load your games into the server and play it using the correct URL. The <3>instructions above</3> also explain the details for how to load your game to the server. We'd like to encourage you to contact us if you have any questions.</p><p>Featured games on this page are added manually. Please get in contact and we'll happily add yours.</p>"
-  },
-  "Funding": {
-    "translation": "Funding",
-    "description": "This server is hosted at Heinrich Heine University Düsseldorf. The lean4game software was developed as part of the project <1>ADAM: Anticipating the Digital Age of Mathematics</1>, funded by the programme <i>Freiraum 2022</i> of the <i>Stiftung Innovation in der Hochschullehre</i>. Ongoing maintenance and development are generously supported by <i>Renaissance Philanthropy</i> through the <i>AI for Math Fund</i>."
-  },
-  "Server capacity": {
-    "translation": "Server capacity",
-    "description": "<p>As this server runs lean on our university machines, it has a limited capacity. We estimate that our setup will support around 50 simultaneous games at high performance, and up to 180 simultaneous games at a slower pace.</p>"
-  },
-  "No Games": {
-    "description": "No Games loaded. Use <1>http://localhost:3000/#/g/local/FOLDER</1> to open a game directly from a local folder."
-  },
-  "Progress saving": {
-    "translation": "Progress saving",
-    "description": "The game stores your progress in your local browser storage. If you delete it, your progress will be lost!<br/>Warning: In most browsers, deleting cookies will also clear the local storage (or \"local site data\"). Make sure to download your game progress first!"
-  },
-  "Development": {
-    "translation": "Development",
-    "description": "The game engine has been created by <strong>Alexander Bentkamp</strong>, <strong>Jon Eugster</strong>. On a prototype by <strong>Patrick Massot</strong>. The source code of this Lean game engine is <1>available on Github</1>. If you experience any problems, please file an <2>Issue on Github</2> or get directly in contact."
-  },
-  "Accessibility": {
-    "translation": "Accessibility",
-    "description": "If you experience any accessibilty barriers, please get in contact with us! We are dedicated to address such barriers to the best of our abilities."
-  },
+  "Caption.translation": "Lean Game Server",
+  "Subcaption.description": "A repository of learning games for the proof assistant <1>Lean</1> <i>(Lean 4)</i> and its mathematical library <2>mathlib</2>",
+  "Development notes.translation": "Development notes",
+  "Development notes.description": "<p>Most aspects of the games and the infrastructure are still in development. Feel free to file a <1>GitHub Issue</1> about any problems you experience!</p>",
+  "Adding new games.translation": "Adding new games",
+  "Adding new games.description": "If you are considering writing your own game, you should use the <1>GameSkeleton Github Repo</1> as a template and read <2>How to Create a Game</2>.<p>You can directly load your games into the server and play it using the correct URL. The <3>instructions above</3> also explain the details for how to load your game to the server. We'd like to encourage you to contact us if you have any questions.</p><p>Featured games on this page are added manually. Please get in contact and we'll happily add yours.</p>",
+  "Funding.translation": "Funding",
+  "Funding.description": "This server is hosted at Heinrich Heine University Düsseldorf. The lean4game software was developed as part of the project <1>ADAM: Anticipating the Digital Age of Mathematics</1>, funded by the programme <i>Freiraum 2022</i> of the <i>Stiftung Innovation in der Hochschullehre</i>. Ongoing maintenance and development are generously supported by <i>Renaissance Philanthropy</i> through the <i>AI for Math Fund</i>.",
+  "Server capacity.translation": "Server capacity",
+  "Server capacity.description": "<p>As this server runs lean on our university machines, it has a limited capacity. We estimate that our setup will support around 50 simultaneous games at high performance, and up to 180 simultaneous games at a slower pace.</p>",
+  "No Games.description": "No Games loaded. Use <1>http://localhost:3000/#/g/local/FOLDER</1> to open a game directly from a local folder.",
+  "Progress saving.translation": "Progress saving",
+  "Progress saving.description": "The game stores your progress in your local browser storage. If you delete it, your progress will be lost!<br/>Warning: In most browsers, deleting cookies will also clear the local storage (or \"local site data\"). Make sure to download your game progress first!",
+  "Development.translation": "Development",
+  "Development.description": "The game engine has been created by <strong>Alexander Bentkamp</strong>, <strong>Jon Eugster</strong>. On a prototype by <strong>Patrick Massot</strong>. The source code of this Lean game engine is <1>available on Github</1>. If you experience any problems, please file an <2>Issue on Github</2> or get directly in contact.",
+  "Accessibility.translation": "Accessibility",
+  "Accessibility.description": "If you experience any accessibilty barriers, please get in contact with us! We are dedicated to address such barriers to the best of our abilities.",
   "Tactics": "Tactics",
   "<p>Game rules determine if it is allowed to skip levels and if the games runs checks to only allow unlocked tactics and theorems in proofs.</p><1>Note: \"Unlocked\" tactics (or theorems) are determined by two things: The set of minimal tactics needed to solve a level, plus any tactics you unlocked in another level. That means if you unlock <1>simp</1> in a level, you can use it henceforth in any level.</1><p>The options are:</p>": "<p>Game rules determine if it is allowed to skip levels and if the games runs checks to only allow unlocked tactics and theorems in proofs.</p><1>Note: \"Unlocked\" tactics (or theorems) are determined by two things: The set of minimal tactics needed to solve a level, plus any tactics you unlocked in another level. That means if you unlock <1>simp</1> in a level, you can use it henceforth in any level.</1><p>The options are:</p>",
   "Game Rules": "Game Rules",