formats: Add Format.JS support

Fixes WeblateOrg#8802
nijel · Jan 4, 2024 · 67936b5 · 67936b5
1 parent 739b0cc
commit 67936b5
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 0 deletions.
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -7,6 +7,7 @@ Not yet released.
 
 * :ref:`check-perl-brace-format` quality check.
 * :doc:`/formats/moko`.
+* :doc:`/formats/formatjs`.
 
 **Improvements**
 

diff --git a/docs/formats/formatjs.rst b/docs/formats/formatjs.rst
@@ -0,0 +1,52 @@
+.. _formatjs:
+
+Format.JS JSON file
+-------------------
+
+.. versionadded:: 5.4
+
+File format used when translating Format.JS and React-Intl applications.
+
+.. seealso::
+
+    :doc:`tt:formats/json`,
+    `Format.JS Message Extraction <https://formatjs.io/docs/getting-started/message-extraction>`_
+
+Example file:
+
+.. code-block:: json
+
+   {
+      {
+     "hak27d": {
+       "defaultMessage": "Control Panel",
+       "description": "title of control panel section"
+     },
+     "haqsd": {
+       "defaultMessage": "Delete user {name}",
+       "description": "delete button"
+     },
+     "19hjs": {
+       "defaultMessage": "New Password",
+       "description": "placeholder text"
+     },
+     "explicit-id": {
+       "defaultMessage": "Confirm Password",
+       "description": "placeholder text"
+     }
+   }
+
+Weblate configuration
++++++++++++++++++++++
+
++-------------------------------------------------------------------+
+| Typical Weblate :ref:`component`                                  |
++================================+==================================+
+| File mask                      | ``src/lang/*.json``              |
++--------------------------------+----------------------------------+
+| Monolingual base language file | ``src/extracted/en.json``        |
++--------------------------------+----------------------------------+
+| Template for new translations  | `Empty`                          |
++--------------------------------+----------------------------------+
+| File format                    | `Format.JS JSON file`            |
++--------------------------------+----------------------------------+
diff --git a/weblate/formats/models.py b/weblate/formats/models.py
@@ -99,6 +99,7 @@ class FormatsConf(AppConf):
         "weblate.formats.ttkit.GoI18V2JSONFormat",
         "weblate.formats.ttkit.GoTextFormat",
         "weblate.formats.ttkit.ARBFormat",
+        "weblate.formats.ttkit.FormatJSFormat",
         "weblate.formats.ttkit.CSVFormat",
         "weblate.formats.ttkit.CSVUtf8Format",
         "weblate.formats.ttkit.CSVSimpleFormat",

diff --git a/weblate/formats/ttkit.py b/weblate/formats/ttkit.py
@@ -1515,6 +1515,14 @@ class GoTextFormat(JSONFormat):
     supports_plural: bool = True
 
 
+class FormatJSFormat(JSONFormat):
+    name = gettext_lazy("Format.JS JSON file")
+    format_id = "formatjs"
+    loader = ("jsonl10n", "FormatJSJsonFile")
+    autoload = ()
+    check_flags = ("icu-message-format",)
+
+
 class CSVFormat(TTKitFormat):
     name = gettext_lazy("CSV file")
     format_id = "csv"