i18n: add support for user defined overrisable translations in react

[zzacharo]

Proposed solution

We utilize the dynamic resource addition of i18next to dynamically add user defined translations in every module.

Currently, each module is creating their own i18next instance. We need to add the following lines

const { languages } = require("./package.json").config;

languages.forEach((lng) => {
  try {
    const overridenTranslations = require(`@overriden_translations/${lng}/LC_MESSAGES/translations.json`);
    i18next.addResourceBundle(lng, "translation", overridenTranslations);
  } catch (e) {
    console.log("No overridden translations found for language", lng);
  }
});

in each module that instantiates such an instance. The @overriden_translations is an alias that is defined in cookiecutter-invenio-rdm and points to the same location as the backend translations. If you want to override react translations you will need to create a translations.json file with all the keys for that specific language. The workflow would look like the following:

$ invenio-cli translations init -l <locale>
$ cd translations/<locale>/LC_messages
$ touch translations.json

Next steps

• We need to iterate through all the invenio modules that have an i18next.js file and the code changes
• Test that image building works with the overridden translations
• Test that local development works with the overridden translations
• Test that there is no errors when there are no translations defined by the user
• Test that you can create a completely new catalog and add custom translations
  • This might be not possible now because we rely on each modules defined languages in the respective package.json.

Open PRs

• i18next: support user defined overriden translations for react #2620
• User defined react translations invenio-rdm-records#1698
• i18next: support user defined overriden translations for react cookiecutter-invenio-rdm#279

[SarahW91]

There are some thoughts on this from the workshop in Münster gathered in this pad: https://pad.uni-muenster.de/dd3q7gQcQpqgDwzKocaQBA?both#

[github-actions]

This issue was automatically marked as stale.

[SarahW91]

Are there any news on this issue?