@l10nmonster/helpers-json 1.0.0

package/README.md

@@ -0,0 +1,13 @@
+# L10n Monster JSON Helpers
+
+### JSON Filter
+
+A filter for JSON files. It supports annotations as defined by the [ARB spec](https://github.com/google/app-resource-bundle/wiki/ApplicationResourceBundleSpecification). In addition it supports nested keys and plurals as defined by the [i18next JSON v4](https://www.i18next.com/misc/json-format) format.
+
+```js
+this.resourceFilter = new filters.JsonFilter({
+        enableArbAnnotations: true,
+        enablePluralSuffixes: true,
+        emitArbAnnotations: true
+});
+```

package/i18next.js

@@ -0,0 +1,85 @@
+// i18next v4 json format defined at https://www.i18next.com/misc/json-format
+const flat = require('flat');
+const { regex } = require('@l10nmonster/helpers');
+
+const isArbAnnotations = e => e[0].split('.').slice(-2)[0].startsWith('@');
+const validArbAnnotations = new Set(['description', 'type', 'context', 'placeholders', 'screenshot', 'video', 'source_text']);
+const validPluralSuffixes = new Set(['one', 'other', 'zero', 'two', 'few', 'many']);
+const extractArbGroupsRegex = /(?<prefix>.+?\.)?@(?<key>\S+)\.(?<attribute>\S+)/;
+
+function parseResourceAnnotations(resource, enableArbAnnotations) {
+    let parsedResource = Object.entries(flat.flatten(resource));
+    const notes = {};
+    if (enableArbAnnotations) {
+        for (const [key, value] of parsedResource.filter(isArbAnnotations)) {
+            const arbGroups = extractArbGroupsRegex.exec(key).groups;
+            const sid = `${arbGroups.prefix ?? ''}${arbGroups.key}`;
+            if (validArbAnnotations.has(arbGroups.attribute)) {
+                notes[sid] = `${notes[sid] ? `${notes[sid]}\n` : ''}${arbGroups.attribute === 'description' ? '' : `${arbGroups.attribute}: `}${arbGroups.attribute === 'placeholders' ? JSON.stringify(value) : value}`;
+            } else {
+                l10nmonster.logger.verbose(`Unexpected ${arbGroups.attribute} annotation for SID ${sid}`);
+            }
+        }
+    }
+    enableArbAnnotations && (parsedResource = parsedResource.filter(e => !isArbAnnotations(e)));
+    return [ parsedResource, notes ];
+}
+
+exports.Filter = class I18nextFilter {
+    constructor(params) {
+        this.enableArbAnnotations = params?.enableArbAnnotations || false;
+        this.enablePluralSuffixes = params?.enablePluralSuffixes || false;
+        this.emitArbAnnotations = params?.emitArbAnnotations || false;
+    }
+
+    async parseResource({ resource }) {
+        const segments = [];
+        const [ parsedResource, notes ] = parseResourceAnnotations(JSON.parse(resource), this.enableArbAnnotations);
+        for (const [key, value] of parsedResource) {
+            let seg = { sid: key, str: value };
+            notes[key] && (seg.notes = notes[key]);
+            if (this.enablePluralSuffixes && key.indexOf('_') !== -1 && validPluralSuffixes.has(key.split('_').slice(-1)[0])) {
+                seg.isSuffixPluralized = true;
+            }
+            segments.push(seg);
+        }
+        return {
+            segments,
+        };
+    }
+
+    async translateResource({ resource, translator }) {
+        let flatResource = flat.flatten(JSON.parse(resource));
+        for (const entry of Object.entries(flatResource)) {
+            if (!this.enableArbAnnotations || !isArbAnnotations(entry)) {
+                const translation = await translator(...entry);
+                if (translation === undefined) {
+                    delete flatResource[entry[0]];
+                } else {
+                    flatResource[entry[0]] = translation;
+                    // TODO: deal with pluralized forms as well
+                }
+            }
+        }
+        if (this.enableArbAnnotations) {
+            for (const entry of Object.entries(flatResource).filter(entry => isArbAnnotations(entry))) {
+                const arbGroups = extractArbGroupsRegex.exec(entry[0]).groups;
+                const sid = `${arbGroups.prefix ?? ''}${arbGroups.key}`;
+                if (!this.emitArbAnnotations || !flatResource[sid]) {
+                    delete flatResource[entry[0]];
+                }
+            }
+        }
+        return JSON.stringify(flat.unflatten(flatResource), null, 2);
+    }
+}
+
+// i18next v4 placeholder formats
+// - "keyNesting": "reuse $t(keyDeep.inner)", or
+// - "keyInterpolate": "replace this {{value}}"
+// See: https://www.i18next.com/misc/json-format#i18next-json-v4
+exports.phDecoder = regex.decoderMaker(
+    'i18nextKey',
+    /(?<nestingPh>\$t\([\w:.]+\))|(?<doubleBracePh>{{[^}]+}})/g,
+    (groups) => ({ t: 'x', v: groups.nestingPh ?? groups.doubleBracePh })
+);

package/index.js

@@ -0,0 +1 @@
+exports.i18next = { ...require('./i18next') };

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@l10nmonster/helpers-json",
+  "version": "1.0.0",
+  "description": "Helpers to deal with JSON file formats",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Diego Lagunas",
+  "license": "MIT",
+  "dependencies": {
+    "flat": "^5.0.2"
+  },
+  "peerDependencies": {
+    "@l10nmonster/helpers": "^1"
+  }
+}