google-spreadsheet-translation-sync 1.3.10 → 1.3.12

package/index.js

@@ -16,4 +16,7 @@ module.exports.exportToSpreadsheet = require('./src/export-to-spreadsheet');
 module.exports.importFromSpreadsheet = require('./src/import-from-spreadsheet');
 
 
-module.exports.possibleTranslationFormats = require('./src/util/constraints').translationFormats;
+module.exports.possibleTranslationFormats = require('./src/util/constraints').translationFormats;
+
+
+module.exports.interaction = require('./src/interaction');

package/interact.js

@@ -0,0 +1 @@
+require('./src/interaction')();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-spreadsheet-translation-sync",
-  "version": "1.3.10",
+  "version": "1.3.12",
   "description": "A plugin to read and write i18n translationsfrom and to google spreadsheets ",
   "main": "index.js",
   "scripts": {
@@ -43,6 +43,7 @@
     "shell": "^0.5.0"
   },
   "dependencies": {
+    "@inquirer/prompts": "^3.0.3",
     "async": "^2.6.3",
     "fast-csv": "^4.3",
     "gettext-parser": "^4.0.2",

package/src/interaction.js

@@ -0,0 +1,144 @@
+/**
+ * @param {string[]} translationFiles - an array of files
+ * @param {{translationFormat: string, mode: string, spreadsheetId: string, gid : string, credentials: {}, keyId: string, fileBaseName: string, namespaces: boolean, defaultLocaleName: string}} options
+ * @param {function} callback
+ */
+const fs = require("fs");
+const async = require("async");
+const path = require("path");
+
+module.exports = async function () {
+    const async= require('async')
+    const path = require('path');
+    const prompts = require('@inquirer/prompts');
+    const fs = require('fs');
+
+    const options = {
+        keyId: 'key',
+        gid: '0',
+        credentials: require('../test/data/google-test-access.json'),
+        fileBaseName: '',
+        namespaces: false,
+        translationFormat: 'locale_json',
+        defaultLocaleName: 'default',
+        namespaceSeparator: '-'
+    }
+
+    const TRANSLATION_FORMATS = require('./util/constraints').TRANSLATION_FORMATS
+
+    options.translationFormat = await prompts.select({
+        message: 'Select the translation format of your project',
+        choices: Object.values(TRANSLATION_FORMATS).map((format) => {
+            return {value: format};
+        })
+    });
+
+    const h = require('./handler');
+    const handler = h.getHandler(options.translationFormat);
+
+    if (options.translationFormat === TRANSLATION_FORMATS.PROPERTIES) {
+        options.namespaces = true;
+        options.namespaceSeparator = await prompts.input({
+            message: 'Please set the namespace separator',
+            default: options.namespaceSeparator
+        });
+    }
+
+    // get all the files
+    const folder = await prompts.input({
+        message: 'Folder of your translation files (relative to ' + process.cwd() + ')'
+    });
+
+    const files = fs.readdirSync(folder).map(file => {
+        return path.resolve(folder, file);
+    });
+
+    let data = {};
+
+    async.each(files, function (file, cb) {
+
+        const extension = path.extname(file);
+        const fileName = path.basename(file, extension);
+        let namespace = '';
+        let localeKey;
+
+        // namespace based parsing required?
+        if (options.namespaces) {
+            const regex = /^(\w*?)([\-_])([\w\-]{2,5})$/gi
+            const matches = regex.exec(fileName);
+
+            if (!matches) {
+                // we assume, that the whole filename is the namespace
+                localeKey = options.defaultLocaleName ? options.defaultLocaleName : 'default'
+                namespace = fileName;
+            } else {
+                namespace = matches[1];
+                localeKey = matches[3];
+            }
+
+            if (!data[namespace]) {
+                data[namespace] = {};
+            }
+
+        } else {
+            localeKey = fileName.substring(options.fileBaseName.length + (options.namespaceSeparator ? options.namespaceSeparator.length : 0));
+        }
+
+        handler.getTranslationKeys(file, function (tData) {
+            if (options.namespaces) {
+                data[namespace][localeKey] = tData;
+            } else {
+                data[localeKey] = tData;
+            }
+
+            cb();
+        });
+    }, async (err) => {
+
+        switch (await prompts.select({
+            message: 'What would you like to do?',
+            choices: [
+                {value: 'export_key', name: "Export a single key"}
+            ]
+        })) {
+            case 'export_key':
+
+                const key = await prompts.input({
+                    message: 'Which key?'
+                });
+                let namespace = '';
+
+                if (options.namespaces) {
+                    namespace = await prompts.select({
+                        message: 'From which namespace?',
+                        choices: Object.keys(data).map(value => {
+                            return {value}
+                        })
+                    });
+
+                    data = data[namespace];
+                }
+
+
+                const head = ['key'];
+                const line = [key];
+
+                Object.keys(data).forEach(locale => {
+                    head.push(locale);
+                    line.push(data[locale][key] || '')
+                })
+// default export as Jira MD for now
+                console.log(`||${head.join('||')}||
+|${line.join('|')}|
+`)
+
+                break;
+        }
+
+
+
+    })
+
+
+
+}

package/test/test.js

@@ -11,9 +11,9 @@ const async = require('async');
 
 const testSheetId = '1ZJK1G_3wrEo9lnu1FenjOzSy3uoAi-RLWbph1cI6DWI'; // https://docs.google.com/spreadsheets/d/1ZJK1G_3wrEo9lnu1FenjOzSy3uoAi-RLWbph1cI6DWI/edit#gid=0
 const testWorksheetId = '1209225803';
-const testSheetId_gettext = '1CRvX4TCxUGCcs_MtKC5BdEViHYzYzLXdqtbuVaAXfKc';
+const testSheetId_gettext = '1CRvX4TCxUGCcs_MtKC5BdEViHYzYzLXdqtbuVaAXfKc'; // https://docs.google.com/spreadsheets/d/1CRvX4TCxUGCcs_MtKC5BdEViHYzYzLXdqtbuVaAXfKc/edit#gid=0
 const testSheetId_properties = '1Z0Mpbf6lgdGiuiHlpb9DENVfKxkxSRwcfQEDYrgokEE'; // https://docs.google.com/spreadsheets/d/1Z0Mpbf6lgdGiuiHlpb9DENVfKxkxSRwcfQEDYrgokEE/edit#gid=0
-const testSheetId_yaml = '1Ml3jLK6RgbPQ4e7XZpILvB-XWMeziHpwdxS8r4AYNtE';
+const testSheetId_yaml = '1Ml3jLK6RgbPQ4e7XZpILvB-XWMeziHpwdxS8r4AYNtE'; // https://docs.google.com/spreadsheets/d/1Ml3jLK6RgbPQ4e7XZpILvB-XWMeziHpwdxS8r4AYNtE/edit#gid=0
 const timeout = 20000;
 
 // preparations
@@ -21,10 +21,6 @@ const timeout = 20000;
 var tmpFile = tmp.fileSync({postfix: '.csv'});
 
 const csv = require('fast-csv');
-const fileUtils = require("../src/util/file-utils");
-const yamlHandler = require("../src/handlers/yaml");
-const rimraf = require("rimraf");
-const yaml = require("js-yaml");
 const testFile = tmpFile.name;
 const csvData = [
   ['key', 'default', 'de', 'it', 'fr', 'pl', 'hu'],
@@ -323,12 +319,15 @@ const tests = [
 
         if (!err) {
           const testFile = path.resolve(translationRoot + '/other.properties');
+          const testFilePl = path.resolve(translationRoot + '/other_pl.properties');
           const PropertiesReader = require('properties-reader');
 
           const props = PropertiesReader(testFile);
+          const propsPl = PropertiesReader(testFilePl);
 
           // expect(Object.keys(props.getAllProperties()).length).to.equal(csvData.length - 1); // without the header
           expect(props.get(csvData[2][0])).to.equal(csvData[2][1]);
+          expect(propsPl.get(csvData[1][0])).to.equal(csvData[1][5]);
         }
 
         done();
@@ -352,15 +351,18 @@ const tests = [
 
       const translationRoot = ensureFolder(path.resolve('./test/translations/' + options.translationFormat + '/'));
       const testFile = path.resolve(translationRoot + '/default.json');
+      const testFilePl = path.resolve(translationRoot + '/pl.json');
 
       app.importFromSpreadsheet(translationRoot, options, function (err) {
         expect(err).to.be.null
 
         if (!err) {
           const defaultKeys = require(testFile);
+          const plKeys = require(testFilePl);
 
           // expect(Object.keys(defaultKeys).length).to.equal(326);
           expect(defaultKeys[csvData[2][0]]).to.equal(csvData[2][1]);
+          expect(plKeys[csvData[1][0]]).to.equal(csvData[1][5]);
         }
 
         done();
@@ -385,6 +387,7 @@ const tests = [
 
       const translationRoot = ensureFolder(path.resolve('./test/translations/' + options.translationFormat + '/'));
       const testFile = path.resolve(translationRoot + '/' + baseName + '-en.po');
+      const testFilePl = path.resolve(translationRoot + '/' + baseName + '-pl.po');
 
       app.importFromSpreadsheet(translationRoot, options, function (err) {
         expect(err).to.be.null
@@ -395,9 +398,11 @@ const tests = [
           expect(fs.existsSync(testFile)).to.equal(true);
 
           const po = require('gettext-parser').po.parse(fs.readFileSync(testFile));
+          const poPl = require('gettext-parser').po.parse(fs.readFileSync(testFilePl));
           const translations = po.translations[''];
-
+          const translationsPl = poPl.translations[''];
           expect(translations.add_address.msgstr[0]).to.equal("Add new address");
+          expect(translationsPl['additional.news'].msgstr[0]).to.equal('czecz 2242');
         }
 
         done();