Localization Support - Merging

Follows https://github.com/onaio/fhir-tooling/issues/10 and https://github.com/onaio/fhir-tooling/issues/62 and https://github.com/onaio/fhir-tooling/issues/62

Overview

This issue is part of a broader effort to support the localization of FHIR content resources. It focuses on the third phase of this, which involves merging the translated content back into the original FHIR resources. The previous phases (content extraction and configs extraction) have prepared the content for translation. This phase addresses the merging of translated content back into the FHIR resources, ensuring that the resources contain the necessary language extensions.

Implementation

The merging phase involves taking the translated content (typically stored in properties files) and applying it to the original FHIR resources. The process should be efficient and automated to reduce manual intervention.

Key implementation steps include:

Parsing the translated properties file: The tool should parse the properties file containing the translated content and language-specific keys.
Identifying the field to be translated: Determine the field to which the translations should be applied. This can be done by hashing the relevant fields and getting the matching translation keys from the properties files
Applying language extensions: Add translation extensions to all occurrences of untranslated text in the FHIR resources. These extensions include language codes and translated content.

Sample Command

A sample command for the merging phase might look like this:

fct translate -m merge -l fr -rf /some/path/to/Questionnaire.json -tf /some/path/<translated locale file>.properties

-m merge: Specifies the merge mode.
-l fr: Specifies the target locale (language code).
-rf /some/path/to/Questionnaire.json: Path to the FHIR resource to which translations should be applied.
-tf /some/path/.properties: Path to the translated properties file from Transifex for the specified locale.

Acceptance Criteria

[x] The translate subcommand must support the merge mode (-m merge).
[x] It should take a mandatory -rf flag for the path to the directory or resource file
[x] It should take a mandatory -tf flag for the path to the translated properties file.
[x] The merge mode should take an additional -l flag to specify the target locale for the translations.
[x] All flags should have corresponding full name aliases (e.g., -l for --locale, -tf for --translation-file, -m for --mode, -rf for --resource-file).
[x] Should edit the existing file and add the translations. i.e

Original file

{
  "text": "this is a text",
  "display": "this is a display"
}

Translated File

{
  "text": "this is a text",
  "_text": {
    "extension": [
      {
        "extension": [
          {
            "url": "lang",
            "valueCode": "vi-VN"
          },
          {
            "url": "content",
            "valueString": "this is a translated text"
          }
        ],
        "url": "http://hl7.org/fhir/StructureDefinition/translation"
      }
    ],
  "display": "this is a display",
    "_display": {
      "extension": [
        {
          "extension": [
            {
              "url": "lang",
              "valueCode": "vi-VN"
            },
            {
              "url": "content",
              "valueString": "this is a translated display"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/translation"
        }
      ]
}

[ ] Documentation of the merge command should be added to the project's README.

Enhancements

Should perform merging of an entire directory i.e configs or content
Should perform merging of entire directory if directory is consistent with format

onaio / fhir-tooling