Merge pull request #774 from tchapgouv/translations-as-module

Migrate translations to module

.gitignore

@@ -36,7 +36,7 @@ electron/pub
 
 # Auto-generated file
 /src/modules.ts
-/build_config.yaml
+#/build_config.yaml # :TCHAP: writes this by hand.
 
 /cypress/videos
 /cypress/downloads

build_config.yaml

@@ -0,0 +1,11 @@
+# copied from build_config.sample.yaml
+# Make sure that the modules added here are ALSO ADDED IN OPTIONALDEPENDENCIES in package.json.
+modules:
+    # An example of pulling a module from NPM
+    #- "@vector-im/element-web-ilag-module@^0.0.4"
+
+    # An example of pulling a module from github
+    #- "github:vector-im/element-web-ilag-module#main"
+
+    # Pulling from filesystem.
+    - "file:./modules/tchap-translations"

config.dev.json

@@ -92,8 +92,6 @@
         "fdroid": null
     },
     "permalink_prefix": "https://www.tchap.incubateur.net",
-    "custom_translations_url_comments": "To add translations, edit /src/i18n/strings/tchap_translations.json. It gets copied over to webapp/i18n for serving.",
-    "custom_translations_url": "/i18n/tchap_translations.json",
     "tchap_features": {
         "feature_email_notification": [
             "agent1.tchap.incubateur.net",

config.preprod.json

@@ -86,8 +86,6 @@
         "fdroid": null
     },
     "permalink_prefix": "https://www.beta.tchap.gouv.fr",
-    "custom_translations_url_comments": "To add translations, edit /src/i18n/strings/tchap_translations.json. It gets copied over to webapp/i18n for serving.",
-    "custom_translations_url": "/i18n/tchap_translations.json",
     "tchap_features": {
         "feature_email_notification": ["i.tchap.gouv.fr", "e.tchap.gouv.fr"],
         "feature_thread": ["i.tchap.gouv.fr", "e.tchap.gouv.fr"],

config.prod.json

@@ -194,8 +194,6 @@
         "fdroid": null
     },
     "permalink_prefix": "https://tchap.gouv.fr",
-    "custom_translations_url_comments": "To add translations, edit /src/i18n/strings/tchap_translations.json. It gets copied over to webapp/i18n for serving.",
-    "custom_translations_url": "/i18n/tchap_translations.json",
     "tchap_features": {
         "feature_email_notification": ["agent.dinum.tchap.gouv.fr"],
         "feature_thread": ["agent.dinum.tchap.gouv.fr"],

config.prod.lab.json

@@ -194,8 +194,6 @@
         "fdroid": null
     },
     "permalink_prefix": "https://tchap.gouv.fr",
-    "custom_translations_url_comments": "To add translations, edit /src/i18n/strings/tchap_translations.json. It gets copied over to webapp/i18n for serving.",
-    "custom_translations_url": "/i18n/tchap_translations.json",
     "tchap_features": {
         "feature_email_notification": ["agent.dinum.tchap.gouv.fr"],
         "feature_thread": ["agent.dinum.tchap.gouv.fr"],

config.sample.json

@@ -81,7 +81,5 @@
         "available": false
     },
     "map_style_url": "https://openmaptiles.geo.data.gouv.fr/styles/osm-bright/style.json",
-    "permalink_prefix": "https://www.beta.tchap.gouv.fr",
-    "custom_translations_url_comments": "To add translations, edit /src/i18n/strings/tchap_translations.json. It gets copied over to webapp/i18n for serving.",
-    "custom_translations_url": "/i18n/tchap_translations.json"
+    "permalink_prefix": "https://www.beta.tchap.gouv.fr"
 }

module_system/installer.ts

@@ -59,7 +59,36 @@ export function installer(config: BuildConfig): void {
     try {
         // Install the modules with yarn
         const yarnAddRef = config.modules.join(" ");
-        callYarnAdd(yarnAddRef); // install them all at once
+        // :TCHAP: don't run the yarn install, scalingo does not like it.
+        // eslint-disable-next-line no-constant-condition
+        if (false) {
+            callYarnAdd(yarnAddRef); // install them all at once
+        }
+        console.log("The following modules are in build_config: ", config.modules);
+        // To make sure the build will work without the yarn add, check that the modules in build_config are present in optionalDependencies.
+        const currentOptDepsValues = Object.values(JSON.parse(packageDeps.packageJson)?.["optionalDependencies"] ?? {});
+        const isAllGood = config.modules.every((configLine) => {
+            // Check only the "file:" modules, it's too complicated to check all yarn allowed formats.
+            // Our modules should be "file:"
+            if (configLine.includes("file:")) {
+                if (!currentOptDepsValues.includes(configLine)) {
+                    console.error(
+                        "build_config.yml contains",
+                        configLine,
+                        "but it is not present in optionalDependencies in package.json.",
+                        "\nYou should run : yarn add -O",
+                        configLine,
+                    );
+                    return false;
+                }
+            }
+            return true;
+        });
+        if (!isAllGood) {
+            exitCode = 1;
+            return;
+        }
+        // end :TCHAP:
 
         // Grab the optional dependencies again and exclude what was there already. Everything
         // else must be a module, we assume.

modules/tchap-translations/TchapTranslationsModule.js

@@ -0,0 +1,13 @@
+/*
+Copyright 2023 DINUM
+*/
+import { RuntimeModule } from "@matrix-org/react-sdk-module-api/lib/RuntimeModule";
+
+import tchapTranslations from "./tchap_translations.json";
+export default class TchapTranslationsModule extends RuntimeModule {
+    constructor(moduleApi) {
+        super(moduleApi);
+
+        this.moduleApi.registerTranslations(tchapTranslations);
+    }
+}

modules/tchap-translations/package.json

@@ -0,0 +1,11 @@
+{
+    "name": "tchap-translations",
+    "version": "0.0.0",
+    "description": "Custom translations for Tchap",
+    "author": "DINUM",
+    "license": "Apache-2.0",
+    "dependencies": {
+        "@matrix-org/react-sdk-module-api": "^1.0.0"
+    },
+    "main": "TchapTranslationsModule.js"
+}