@remvst/localization 1.0.0 → 1.0.2

package/.github/workflows/check.yaml

@@ -2,7 +2,7 @@ name: Check
 on:
   push:
     branches:
-      - master
+      - main
   workflow_dispatch:
 jobs:
   check:

package/lib/commands/combine-json.js

@@ -1,8 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.combineJsonCommand = void 0;
 const fs_1 = require("fs");
 const translation_set_1 = require("../model/translation-set");
+const path_1 = __importDefault(require("path"));
 async function combineJsonCommand(options) {
     const fallbackTranslations = [];
     for (const fallbackPath of options.fallback || []) {
@@ -25,6 +29,7 @@ async function combineJsonCommand(options) {
         }
         return null;
     });
+    await fs_1.promises.mkdir(path_1.default.dirname(options.out), { recursive: true });
     await fs_1.promises.writeFile(options.out, JSON.stringify(outTranslations.toJSON(), null, 4));
 }
 exports.combineJsonCommand = combineJsonCommand;

package/lib/commands/google-translate.js

@@ -1,9 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.googleTranslateCommand = void 0;
 const fs_1 = require("fs");
 const translation_set_1 = require("../model/translation-set");
 const google_translate_api_1 = require("@vitalets/google-translate-api");
+const path_1 = __importDefault(require("path"));
 async function googleTranslateCommand(options) {
     const mainJson = JSON.parse(await fs_1.promises.readFile(options.in, 'utf-8'));
     const outTranslations = translation_set_1.TranslationSet.fromJSON(mainJson);
@@ -15,6 +19,7 @@ async function googleTranslateCommand(options) {
         const translationResult = await (0, google_translate_api_1.translate)(translationInFallbackLocale, { from: options.fallbackLocale, to: locale });
         return translationResult?.text;
     });
+    await fs_1.promises.mkdir(path_1.default.dirname(options.out), { recursive: true });
     await fs_1.promises.writeFile(options.out, JSON.stringify(outTranslations.toJSON(), null, 4));
 }
 exports.googleTranslateCommand = googleTranslateCommand;

package/lib/commands/parse-csv.js

@@ -1,8 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseCsvCommand = exports.parseCsv = void 0;
 const fs_1 = require("fs");
 const translation_set_1 = require("../model/translation-set");
+const path_1 = __importDefault(require("path"));
 async function parseCsv(path, languagesLine) {
     const csvContent = await fs_1.promises.readFile(path, 'utf-8');
     const csvLines = csvContent.split('\n');
@@ -26,6 +30,7 @@ async function parseCsv(path, languagesLine) {
 exports.parseCsv = parseCsv;
 async function parseCsvCommand(options) {
     const polyglotTranslations = await parseCsv(options.in, options.languagesLineIndex);
+    await fs_1.promises.mkdir(path_1.default.dirname(options.out), { recursive: true });
     await fs_1.promises.writeFile(options.out, JSON.stringify(polyglotTranslations, null, 4));
 }
 exports.parseCsvCommand = parseCsvCommand;

package/lib/commands/to-typescript.js

@@ -1,11 +1,16 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toTypescriptCommand = void 0;
+const path_1 = __importDefault(require("path"));
 const translation_set_1 = require("../model/translation-set");
 const fs_1 = require("fs");
 async function toTypescriptCommand(options) {
     const sourceJson = JSON.parse(await fs_1.promises.readFile(options.in, 'utf-8'));
     const outTranslations = translation_set_1.TranslationSet.fromJSON(sourceJson);
+    await fs_1.promises.mkdir(path_1.default.dirname(options.out), { recursive: true });
     await fs_1.promises.writeFile(options.out, outTranslations.toTypeScript());
 }
 exports.toTypescriptCommand = toTypescriptCommand;

package/lib/model/translation-set.js

@@ -48,11 +48,11 @@ class TranslationSet {
         generatedFileContent += `export type LocalizationItem = {[key in Locale]?: string};\n\n`;
         generatedFileContent += 'export const LOCALIZATION: {[key in LocalizedKey]: LocalizationItem} = {\n';
         for (const [key, localizedItem] of this.translations.entries()) {
-            generatedFileContent += `    ${key}: {\n`;
+            generatedFileContent += `    ${JSON.stringify(key)}: {\n`;
             for (const [locale, translation] of localizedItem.entries()) {
                 if (!translation)
                     continue;
-                generatedFileContent += `        ${locale}: ${JSON.stringify(translation)},\n`;
+                generatedFileContent += `        ${JSON.stringify(locale)}: ${JSON.stringify(translation)},\n`;
             }
             generatedFileContent += `    },\n`;
         }
@@ -63,6 +63,7 @@ class TranslationSet {
         generatedFileContent += `}\n\n`;
         generatedFileContent += `export function localize(key: LocalizedKey) {\n`;
         generatedFileContent += `    const localizationItem: LocalizationItem = LOCALIZATION[key];\n`;
+        generatedFileContent += `    if (!localizationItem) return key;\n`;
         generatedFileContent += `    return localizationItem[LOCALE] || localizationItem.en;\n`;
         generatedFileContent += `}\n`;
         return generatedFileContent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remvst/localization",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "main": "lib/index.js",
   "bin": {
@@ -9,11 +9,11 @@
   "scripts": {
     "build": "rm -rf lib && tsc",
     "prepublishOnly": "npm i && npm run build",
-    "test:polyglot": "ts-node src/index.ts index -i test/polyglot.csv -o testOut/polyglot.json -l 1",
-    "test:backfill-json": "ts-node src/index.ts combine-json --main=test/localization.json --out=testOut/localization-backfilled.json --fallback=testOut/polyglot.json -l en -l fr -l es",
-    "test:backfill-google-translate": "ts-node src/index.ts google-translate --in=testOut/localization-backfilled.json --out=testOut/localization-backfilled-google-translate.json -l en -l fr -l es",
-    "test:to-typescript": "ts-node src/index.ts to-typescript -i testOut/localization-backfilled.json -o testOut/localization.ts",
-    "test": "npm run test:polyglot && npm run test:backfill-json && npm run test:to-typescript"
+    "test:polyglot": "ts-node src/index.ts parse-csv -i test/polyglot.csv -o testOut/polyglot.json -l 1",
+    "test:combine-json": "ts-node src/index.ts combine-json --main=test/localization.json --out=testOut/localization-combined.json --fallback=testOut/polyglot.json -l en -l fr -l es",
+    "test:google-translate": "ts-node src/index.ts google-translate --in=testOut/localization-combined.json --out=testOut/localization-backfilled-google-translate.json -l en -l fr -l es",
+    "test:to-typescript": "ts-node src/index.ts to-typescript -i testOut/localization-combined.json -o testOut/localization.ts && tsc testOut/localization.ts",
+    "test": "npm run test:polyglot && npm run test:combine-json && npm run test:to-typescript"
   },
   "author": "Rémi Vansteelandt",
   "license": "UNLICENSED",

package/src/commands/combine-json.ts

@@ -1,5 +1,6 @@
 import { promises as fs } from 'fs';
 import { TranslationSet, Key, Locale, LocalizedItem } from '../model/translation-set';
+import path from 'path';
 
 export async function combineJsonCommand(options: {
     main: string,
@@ -35,5 +36,6 @@ export async function combineJsonCommand(options: {
         }
     );
 
+    await fs.mkdir(path.dirname(options.out), { recursive: true });
     await fs.writeFile(options.out, JSON.stringify(outTranslations.toJSON(), null, 4));
 }

package/src/commands/google-translate.ts

@@ -1,6 +1,7 @@
 import { promises as fs } from 'fs';
 import { Key, Locale, LocalizedItem, TranslationSet } from "../model/translation-set";
 import { translate } from '@vitalets/google-translate-api';
+import path from 'path';
 
 export async function googleTranslateCommand(options: {
     in: string,
@@ -28,5 +29,6 @@ export async function googleTranslateCommand(options: {
         }
     );
 
+    await fs.mkdir(path.dirname(options.out), { recursive: true });
     await fs.writeFile(options.out, JSON.stringify(outTranslations.toJSON(), null, 4));
 }

package/src/commands/parse-csv.ts

@@ -1,5 +1,6 @@
 import { promises as fs } from 'fs';
 import { TranslationSet } from "../model/translation-set";
+import path from 'path';
 
 export async function parseCsv(
     path: string,
@@ -37,5 +38,6 @@ export async function parseCsvCommand(options: {
     languagesLineIndex: number,
 }) {
     const polyglotTranslations = await parseCsv(options.in!, options.languagesLineIndex);
+    await fs.mkdir(path.dirname(options.out), { recursive: true });
     await fs.writeFile(options.out!, JSON.stringify(polyglotTranslations, null, 4));
 }

package/src/commands/to-typescript.ts

@@ -1,3 +1,4 @@
+import path from "path";
 import { TranslationSet } from "../model/translation-set";
 import { promises as fs } from 'fs';
 
@@ -8,5 +9,6 @@ export async function toTypescriptCommand(options: {
     const sourceJson = JSON.parse(await fs.readFile(options.in, 'utf-8'));
     const outTranslations = TranslationSet.fromJSON(sourceJson);
 
+    await fs.mkdir(path.dirname(options.out), { recursive: true });
     await fs.writeFile(options.out, outTranslations.toTypeScript());
 }

package/src/model/translation-set.ts

@@ -65,11 +65,11 @@ export class TranslationSet {
         generatedFileContent += 'export const LOCALIZATION: {[key in LocalizedKey]: LocalizationItem} = {\n';
 
         for (const [key, localizedItem] of this.translations.entries()) {
-            generatedFileContent += `    ${key}: {\n`;
+            generatedFileContent += `    ${JSON.stringify(key)}: {\n`;
 
             for (const [locale, translation] of localizedItem.entries()) {
                 if (!translation) continue;
-                generatedFileContent += `        ${locale}: ${JSON.stringify(translation)},\n`;
+                generatedFileContent += `        ${JSON.stringify(locale)}: ${JSON.stringify(translation)},\n`;
             }
 
             generatedFileContent += `    },\n`;
@@ -85,6 +85,7 @@ export class TranslationSet {
 
         generatedFileContent += `export function localize(key: LocalizedKey) {\n`;
         generatedFileContent += `    const localizationItem: LocalizationItem = LOCALIZATION[key];\n`;
+        generatedFileContent += `    if (!localizationItem) return key;\n`;
         generatedFileContent += `    return localizationItem[LOCALE] || localizationItem.en;\n`;
         generatedFileContent += `}\n`;
 

package/test/localization.json

@@ -5,5 +5,11 @@
     "back": { "en": "Back" },
     "play": { "en": "Play" },
     "time": { "en": "Time" },
-    "backToMainMenu": { "en": "Back To Main Menu", "fr": "Retour au menu principal" }
+    "some-Fancy-Key?": { "en": "Fancy key" },
+    "backToMainMenu": { "en": "Back To Main Menu", "fr": "Retour au menu principal" },
+    "difficulty": { "en": "Difficulty" },
+    "difficultyNormal": { "en": "Normal" },
+    "difficultyHard": { "en": "Hard" },
+    "difficultyEasy": { "en": "Easy" },
+    "difficultyVeryEasy": { "en": "Very Easy" }
 }