Improve translation plugin as done in gridstudy-app (#455)

Signed-off-by: sBouzols <[email protected]>

Author: sBouzols

src/components/app-wrapper.jsx

@@ -48,8 +48,7 @@ import messages_en from '../translations/en.json';
 import messages_fr from '../translations/fr.json';
 import network_modification_locale_en from '../translations/dynamic/network-modifications-locale-en';
 import network_modification_locale_fr from '../translations/dynamic/network-modifications-locale-fr';
-import messages_plugins_en from '../plugins/translations/en.json';
-import messages_plugins_fr from '../plugins/translations/fr.json';
+import messages_plugins from '../plugins/translations';
 import aggrid_locale_fr from '../translations/external/aggrid-locale-fr';
 import backend_locale_fr from '../translations/external/backend-locale-fr';
 import backend_locale_en from '../translations/external/backend-locale-en';
@@ -199,7 +198,7 @@ const messages = {
         ...element_search_en,
         ...filter_en,
         ...filter_expert_en,
-        ...messages_plugins_en, // keep it at the end to allow translation overwritting
+        ...messages_plugins.en, // keep it at the end to allow translation overwritting
     },
     fr: {
         ...messages_fr,
@@ -219,7 +218,7 @@ const messages = {
         ...directory_items_input_fr,
         ...filter_fr,
         ...filter_expert_fr,
-        ...messages_plugins_fr, // keep it at the end to allow translation overwritting
+        ...messages_plugins.fr, // keep it at the end to allow translation overwritting
     },
 };
 

src/plugins/README.md

@@ -45,7 +45,31 @@ const MyPluggableComponent = () => {
 
 # How to overwrite translations
 
-Add your private translations to the following files to complete or overwrite existing translations
+Add your private translations to the following directory to complete or overwrite existing translations
 
-* src/plugins/translations/en.json
-* src/plugins/translations/fr.json
+* src/plugins/translations
+
+import your file and export an object messages_plugins for the translation in french or english
+in src/plugins/translations/index.js
+
+```diff
+import messages_plugins_fr from '../translations/fr.json';
++import my_plugins_fr from '../translations/my_plugins_fr.json';
+
+import messages_plugins_en from '../translations/en.json';
++import my_plugins_en from '../translations/my_plugins_en.json';
+
+const messages_plugins = {
+    fr: {
+        ...messages_plugins_fr,
++       ...my_plugins_fr,
+    },
+    en: {
+        ...messages_plugins_en,
++       ...my_plugins_en,
+    },
+};
+
+export default messages_plugins;
+
+```

src/plugins/translations/index.js

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+import messages_plugins_fr from '../translations/fr.json';
+import messages_plugins_en from '../translations/en.json';
+const messages_plugins = {
+    fr: {
+        ...messages_plugins_fr,
+    },
+    en: {
+        ...messages_plugins_en,
+    },
+};
+
+export default messages_plugins;