@ni/xliff-to-json-converter 1.0.0

package/README.md

@@ -0,0 +1,36 @@
+# XLIFF to JSON Converter for Angular
+
+The `@ni/xliff-to-json-converter` library converts XLIFF translation files to Angular's JSON format so that they can be loaded at runtime in Angular apps.
+
+# Usage
+
+1. Install in your Angular app's `devDependencies`:
+
+    ```
+    npm install -D @ni/xliff-to-json-converter
+    ```
+
+2. Add scripts to your app's `package.json` to convert translated XLIFF files to JSON.
+
+    ```json
+    "scripts": {
+        "i18n:convert": "npm run i18n:convert:de && npm run i18n:convert:ja && npm run i18n:convert:zh",
+        "i18n:convert:de": "xliff-to-json-converter --source src/locales/messages.de.xlf --destination src/locales/messages.de.json",
+        "i18n:convert:ja": "xliff-to-json-converter --source src/locales/messages.ja.xlf --destination src/locales/messages.ja.json",
+        "i18n:convert:zh": "xliff-to-json-converter --source src/locales/messages.zh.xlf --destination src/locales/messages.zh.json",
+    },
+    ```
+
+3. Ensure those converted files are generated at build time and not checked in to source.
+
+# Context
+
+NI employees can see more info about our [recommended Angular localization toolchain in the NI internal wiki](https://dev.azure.com/ni/DevCentral/_wiki/wikis/AppCentral.wiki/6636/Internationalization-(Angular)).
+
+# Contributing
+
+See [CONTRIBUTING.md](/packages/xliff-to-json-converter/CONTRIBUTING.md) for instructions to make changes to the library.
+
+# Acknowledgements
+
+This library is forked from [talque/xliff-to-angular-json](https://github.com/talque/xliff-to-angular-json) with additions including auto-testing, linting, and some small functionality changes. Thanks to its main contributor [vbraun](https://github.com/vbraun) for the starting point!

package/dist/commonjs/cli.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+const convert_1 = require("./convert");
+// This is how yargs expects to be run at the entry point of a cli application
+// eslint-disable-next-line @typescript-eslint/no-unused-expressions, @typescript-eslint/no-floating-promises
+yargs_1.default(helpers_1.hideBin(process.argv))
+    .strict()
+    .scriptName('xliff-to-json-converter')
+    .usage('$0 --source <src.xlf> --destination <dst.json>')
+    .command('$0', 'Convert source xliff file to angular simple json format', yargsObj => yargsObj
+    .option('source', {
+    alias: 's',
+    type: 'string',
+    describe: 'Source xliff file',
+    demandOption: true
+})
+    .option('destination', {
+    alias: 'd',
+    type: 'string',
+    describe: 'Destination json file',
+    demandOption: true
+}), async (argv) => {
+    const { source, destination } = argv;
+    console.log(`Converting ${source} -> ${destination}`);
+    await convert_1.convertXliff2Json(source, destination);
+})
+    .help()
+    .argv;

package/dist/commonjs/convert.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeParsedTranslation = exports.xliff2Json = exports.convertXliff2Json = void 0;
+const json_file_1 = require("./json-file");
+const xliff_file_1 = require("./xliff-file");
+async function convertXliff2Json(src, dst) {
+    const xliff = await xliff_file_1.loadXliff(src);
+    const json = xliff2Json(xliff);
+    json_file_1.saveJson(json, dst);
+}
+exports.convertXliff2Json = convertXliff2Json;
+function xliff2Json(xliff) {
+    const translations = {};
+    const template = xliff.resources['ng2.template'];
+    Object.keys(template).forEach(key => {
+        const target = template[key].target;
+        const translation = xliffTranslation2jsonString(target);
+        if (translation !== '') {
+            translations[key] = translation;
+        }
+    });
+    const json = {
+        locale: xliff.targetLanguage,
+        translations
+    };
+    return json;
+}
+exports.xliff2Json = xliff2Json;
+function xliffTranslation2jsonString(xliff) {
+    if (xliff === undefined) {
+        // translating the empty string (empty source is technically allowed, makes no sense)
+        return '';
+    }
+    if (typeof xliff === 'string') {
+        // translation is plain string without interpolation
+        return xliff;
+    }
+    if (!(xliff instanceof Array)) {
+        // translation just interpolation (makes no linguistical sense, but technically possible)
+        return makeParsedTranslation(['', ''], [xliff.Standalone.id]);
+    }
+    // makeParsedTranslation expects messagePart0, placeholderName0,
+    // messagePart1, placeholderName1, ..., messagePartN. May have to
+    // add empty messagePart at front or back.
+    const messageParts = [];
+    const placeholderNames = [];
+    for (const part of xliff) {
+        if (typeof part === 'string') {
+            messageParts.push(part);
+        }
+        else {
+            // part is placeholder object
+            if (messageParts.length === placeholderNames.length) {
+                messageParts.push('');
+            }
+            placeholderNames.push(part.Standalone.id);
+        }
+    }
+    if (messageParts.length === placeholderNames.length) {
+        messageParts.push('');
+    }
+    return makeParsedTranslation(messageParts, placeholderNames);
+}
+/**
+ * Create a `ParsedTranslation` from a set of `messageParts` and `placeholderNames`.
+ *
+ * Adapted from the function in @angular/localize of the same name
+ */
+function makeParsedTranslation(messageParts, placeholderNames) {
+    if (messageParts.length !== placeholderNames.length + 1) {
+        throw new Error('translation part length mismatch');
+    }
+    let messageString = messageParts[0];
+    for (let i = 0; i < placeholderNames.length; i++) {
+        messageString += `{$${placeholderNames[i]}}${messageParts[i + 1]}`;
+    }
+    return messageString;
+}
+exports.makeParsedTranslation = makeParsedTranslation;

package/dist/commonjs/json-file.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveJson = exports.stringify = void 0;
+const fs_1 = require("fs");
+function stringify(json) {
+    const content = JSON.stringify(json, undefined, 4);
+    return content;
+}
+exports.stringify = stringify;
+function saveJson(json, dst) {
+    const content = stringify(json);
+    fs_1.writeFileSync(dst, content);
+}
+exports.saveJson = saveJson;

package/dist/commonjs/util.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/commonjs/xliff-file.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseXliff = exports.loadXliff = void 0;
+const fs_1 = require("fs");
+const xliff_1 = require("xliff");
+async function loadXliff(path) {
+    const xliff = fs_1.readFileSync(path);
+    return parseXliff(xliff.toString());
+}
+exports.loadXliff = loadXliff;
+async function parseXliff(contents) {
+    return xliff_1.xliff12ToJs(contents);
+}
+exports.parseXliff = parseXliff;

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@ni/xliff-to-json-converter",
+  "version": "1.0.0",
+  "description": "A utility to convert translation files from XLIFF to JSON for Angular localization",
+  "main": "dist/commonjs/cli.js",
+  "bin": {
+    "xliff-to-json-converter": "./dist/commonjs/cli.js"
+  },
+  "scripts": {
+    "build": "npm run compile",
+    "compile": "tsc -p tsconfig.json",
+    "compile-watch": "tsc -p tsconfig.json -w",
+    "lint": "eslint .",
+    "format": "eslint . --fix",
+    "pack": "npm pack",
+    "invoke-publish": "npm publish",
+    "tdd": "npm run build && npm run test",
+    "test": "jasmine"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ni/nimble.git",
+    "directory": "packages/xliff-to-json-converter"
+  },
+  "author": "National Instruments",
+  "license": "UNLICENSED",
+  "devDependencies": {
+    "@ni/eslint-config-javascript": "^3.1.0",
+    "@ni/eslint-config-typescript": "^3.0.5",
+    "@types/jasmine": "^4.0.2",
+    "@types/yargs": "^17.0.10",
+    "jasmine": "^4.2.0",
+    "jasmine-core": "^4.1.0",
+    "typescript": "^4.3.2"
+  },
+  "dependencies": {
+    "xliff": "^6.0.3",
+    "yargs": "^17.5.1"
+  }
+}