google-spreadsheet-translation-sync 1.3.18 → 1.4.0

package/README.md

@@ -65,6 +65,12 @@ Default value: 'default'
 
 If no locale is provided or could be parsed, the defaultLocaleName is used instead.
 
+#### options.defaultFallback
+Type: `Boolean`   
+Default value: `false`
+
+Fills empty collumns automatically with the value from the defaultLocale - usefull if always complete translations have to be provided per file.
+
 #### options.fileBaseName
 Type: `String`    
 Default value: (empty string)    

package/index.js

@@ -1,5 +1,10 @@
 'use strict'
 
+/**
+ * The options type
+ * @typedef {{translationFormat: string, mode: string, spreadsheetId: string, gid : string, credentials: {}, keyId: string, fileBaseName: string, namespaces: boolean, defaultLocaleName: string, defaultFallback: boolean}} OptionsObject
+ */
+
 /**
  * Adds commas to a number
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-spreadsheet-translation-sync",
-  "version": "1.3.18",
+  "version": "1.4.0",
   "description": "A plugin to read and write i18n translationsfrom and to google spreadsheets ",
   "main": "index.js",
   "scripts": {

package/src/export-to-spreadsheet.js

@@ -5,7 +5,7 @@
 
 /**
  * @param {[]} 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 {OptionsObject} options
  * @param {function} callback
  */
 module.exports = function (translationFiles, options, callback) {
@@ -14,7 +14,7 @@ module.exports = function (translationFiles, options, callback) {
   const async = require('async')
 
   const sheetId = options.spreadsheetId;
-  const credentials = options.credentials;
+  const credentials = options.credentials || require('../test/data/google-test-access.json');
   const translationFormat = options.translationFormat;
 
   // get the handler

package/src/import-from-spreadsheet.js

@@ -1,5 +1,10 @@
 'use strict'
-
+/**
+ *
+ * @param translationRootFolder
+ * @param {OptionsObject} options
+ * @param callback
+ */
 module.exports = function (translationRootFolder, options, callback) {
 
     const connector = require('./connector');
@@ -74,6 +79,26 @@ module.exports = function (translationRootFolder, options, callback) {
                         }
                     }
 
+                    if (options.defaultFallback) {
+
+                        const defaultLocale = options.defaultLocaleName || 'default';
+
+                        Object.keys(translationData).forEach(locale => {
+                            // use the default locale as reference
+                            Object.keys(translationData[defaultLocale]).forEach(namespace => {
+                                if (!translationData[locale][namespace]) {
+                                    translationData[locale][namespace] = {};
+                                }
+
+                                Object.keys(translationData[defaultLocale][namespace]).forEach(key => {
+                                    if (translationData[locale][namespace][key] === undefined) {
+                                        translationData[locale][namespace][key] = translationData[defaultLocale][namespace][key];
+                                    }
+                                });
+                            });
+                        });
+                    }
+
                     // now we get the handler
                     const h = require('./handler');
                     const TRANSLATION_FORMATS = require('./util/constraints').TRANSLATION_FORMATS;

package/test/test.js

@@ -54,7 +54,7 @@ function ensureFolder (folder) {
 
 
 // const testFor = 'all' // 'connect', 'upload', 'import', 'properties', 'locale_json', 'gettext', 'yml', 'json_structure'
-// const testFor = 'json_structure';
+// const testFor = 'gettext';
 const testFor = 'all';
 
 const tests = [
@@ -403,6 +403,49 @@ const tests = [
           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');
+          expect(translationsPl.add_address).to.be.undefined;
+        }
+
+        done();
+      });
+    }
+  },
+
+  {
+    name: 'should fill empty columns with the default',
+    run: ['import', 'gettext'],
+    fnc: function (done) {
+      this.timeout(timeout);
+
+      const baseName = 'om-mani-peme';
+
+      const options = {
+        translationFormat: 'gettext',
+        fileBaseName: baseName,
+        spreadsheetId: testSheetId_gettext,
+        credentials: accessData,
+        defaultLocaleName: 'en',
+        defaultFallback: true
+      };
+
+      const translationRoot = ensureFolder(path.resolve('./test/translations/' + options.translationFormat + '/'));
+      const testFile = path.resolve(translationRoot + '/' + baseName + '-en.po');
+      const testFileDe = path.resolve(translationRoot + '/' + baseName + '-de.po');
+
+      app.importFromSpreadsheet(translationRoot, options, function (err) {
+        expect(err).to.be.null
+
+        if (!err) {
+          const fs = require('fs');
+
+          expect(fs.existsSync(testFile)).to.equal(true);
+
+          const po = require('gettext-parser').po.parse(fs.readFileSync(testFile));
+          const poDe = require('gettext-parser').po.parse(fs.readFileSync(testFileDe));
+          const translations = po.translations[''];
+          const translationsDe = poDe.translations[''];
+          expect(translations['additional.news'].msgstr[0]).to.equal("Additional News");
+          expect(translationsDe['additional.news']?.msgstr[0]).to.equal('Additional News');
         }
 
         done();