Merge pull request #19 from PolymerLabs/xliff

Add XLIFF support

Author: aomarks

.eslintrc.json

@@ -8,7 +8,7 @@
     "plugin:@typescript-eslint/recommended"
   ],
   "rules": {
-    "@typescript-eslint/no-use-before-define": ["error", "nofunc"],
+    "@typescript-eslint/no-use-before-define": "off",
     "@typescript-eslint/explicit-function-return-type": "off",
     "semi": "error"
   }

CHANGELOG.md

@@ -5,7 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-<!-- ## Unreleased -->
+## Unreleased
+
+- Add support for the XLIFF localization interchange format:
+  https://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html
+
+- [BREAKING] Replaced `xlbDir` config file property with `interchange` property.
+  The interchange format is set with `interchange.format` (currently `xliff` or
+  `xlb`), and other format-specific configuration is set in that object.
 
 ## [0.1.2] - 2020-05-09
 

config.schema.json

@@ -20,13 +20,71 @@
                 "before"
             ],
             "type": "object"
+        },
+        "XlbConfig": {
+            "additionalProperties": false,
+            "description": "Parse an XLB XML file. These files contain translations organized using the\nsame message names that we originally requested.\nConfiguration for XLB interchange format.",
+            "properties": {
+                "format": {
+                    "enum": [
+                        "xlb"
+                    ],
+                    "type": "string"
+                },
+                "outputFile": {
+                    "description": "Output path on disk to the XLB XML file that will be created containing all\nmessages extracted from the source. E.g. \"data/localization/en.xlb\".",
+                    "type": "string"
+                },
+                "translationsGlob": {
+                    "description": "Glob pattern of XLB XML files to read from disk containing translated\nmessages. E.g. \"data/localization/*.xlb\".\n\nSee https://github.com/isaacs/node-glob#README for valid glob syntax.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "format",
+                "outputFile",
+                "translationsGlob"
+            ],
+            "type": "object"
+        },
+        "XliffConfig": {
+            "additionalProperties": false,
+            "description": "Configuration for XLIFF interchange format.",
+            "properties": {
+                "format": {
+                    "enum": [
+                        "xliff"
+                    ],
+                    "type": "string"
+                },
+                "xliffDir": {
+                    "description": "Directory on disk to read/write .xlf XML files. For each target locale,\nthe file path \"<xliffDir>/<locale>.xlf\" will be used.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "format",
+                "xliffDir"
+            ],
+            "type": "object"
         }
     },
     "properties": {
         "$schema": {
             "description": "See https://json-schema.org/understanding-json-schema/reference/schema.html",
             "type": "string"
         },
+        "interchange": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/XlbConfig"
+                },
+                {
+                    "$ref": "#/definitions/XliffConfig"
+                }
+            ],
+            "description": "Localization interchange format and configuration specific to that format."
+        },
         "patches": {
             "additionalProperties": {
                 "additionalProperties": {
@@ -55,18 +113,14 @@
         "tsOut": {
             "description": "Required path to the directory where generated TypeScript files will be\nwritten.",
             "type": "string"
-        },
-        "xlbDir": {
-            "description": "Required path to the directory where generated XLB files will be written.",
-            "type": "string"
         }
     },
     "required": [
+        "interchange",
         "sourceLocale",
         "targetLocales",
         "tsConfig",
-        "tsOut",
-        "xlbDir"
+        "tsOut"
     ],
     "type": "object"
 }