locize-cli 7.7.2 → 7.8.2

package/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 Project versioning adheres to [Semantic Versioning](http://semver.org/).
 Change log format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [7.8.2](https://github.com/locize/locize-cli/compare/v7.8.1...v7.8.2) - 2022-02-28
+
+- update dependencies
+
+
+## [7.8.1](https://github.com/locize/locize-cli/compare/v7.8.0...v7.8.1) - 2022-02-10
+
+- sync: optimize handling if pathmask does not include namespace
+
+
+## [7.8.0](https://github.com/locize/locize-cli/compare/v7.7.2...v7.8.0) - 2022-01-13
+
+- sync: introduce --delete-remote-namespace option
+
+
 ## [7.7.2](https://github.com/locize/locize-cli/compare/v7.7.1...v7.7.2) - 2021-12-10
 
 - update dependencies

package/README.md

@@ -91,7 +91,7 @@ locize download --project-id my-project-id-93e1-442a-ab35-24331fa294ba --ver lat
 By using the sync command, you can keep your existing code setup and synchronize the translations with locize.
 An example on how this could look like can be seen in [this tutorial](https://github.com/locize/react-tutorial#step-1---keep-existing-code-setup-but-synchronize-with-locize).
 
-**⚠️ Since the remote source are the published translations, make sure the desired version is set to standard publish mode, or alternatively [publish](#publish-version) that version before you execute the cli command. ⚠️**
+**⚠️ Since the remote source are the published translations, make sure the desired version is set to standard/auto publish mode, or alternatively [publish](#publish-version) that version before you execute the cli command. ⚠️**
 
 ### Step 1: Go near to your translation files
 

package/bin/locize

@@ -368,6 +368,7 @@ program
   .option('-cf, --clean-local-files <true|false>', 'Removes all local files without removing any folder (default: false)', 'false')
   .option('-u, --update-values <true|false>', 'This will update values of existing translations. (default: false)', 'false')
   .option('-S, --skip-delete <true|false>', 'This will skip the removal of keys on locize. (default: false)', 'false')
+  .option('-D, --delete-remote-namespace <true|false>', 'This will delete a complete namespace on locize, if a local file in reference language was deleted. (default: false)', 'false')
   .option('-m, --path-mask <mask>', 'This will define the folder and file structure; do not add a file extension (default: {{language}}/{{namespace}})', `{{language}}${path.sep}{{namespace}}`)
   .option('-P, --language-folder-prefix <prefix>', 'This will be added as a local folder name prefix in front of the language.', '')
   .option('-d, --dry <true|false>', 'Dry run (default: false)', 'false')
@@ -417,6 +418,7 @@ program
     const dry = options.dry === 'true';
     const updateValues = options.updateValues === 'true';
     const skipDelete = options.skipDelete === 'true';
+    const deleteRemoteNamespace = options.deleteRemoteNamespace === 'true';
     const languageFolderPrefix = options.languageFolderPrefix || '';
     const skipEmpty = options.skipEmpty === 'true';
     const referenceLanguageOnly = options.referenceLanguageOnly === 'false' ? false : true;
@@ -432,6 +434,7 @@ program
       format: options.format,
       updateValues: updateValues,
       skipDelete: skipDelete,
+      deleteRemoteNamespace: deleteRemoteNamespace,
       languageFolderPrefix: languageFolderPrefix,
       clean: clean,
       cleanLocalFiles: cleanLocalFiles,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locize-cli",
-  "version": "7.7.2",
+  "version": "7.8.2",
   "description": "locize cli to import locales",
   "main": "index.js",
   "bin": {
@@ -9,9 +9,9 @@
   "dependencies": {
     "@js.properties/properties": "0.5.4",
     "android-string-resource": "2.3.4",
-    "async": "3.2.2",
+    "async": "3.2.3",
     "colors": "1.4.0",
-    "commander": "7.2.0",
+    "commander": "9.0.0",
     "csvjson": "5.1.0",
     "diff": "5.0.0",
     "flat": "5.0.2",
@@ -23,18 +23,18 @@
     "laravelphp": "2.0.3",
     "lodash.clonedeep": "4.5.0",
     "mkdirp": "1.0.4",
-    "node-fetch": "2.6.6",
+    "node-fetch": "2.6.7",
     "resx": "2.0.3",
     "rimraf": "3.0.2",
     "strings-file": "0.0.5",
     "tmexchange": "2.0.4",
-    "xliff": "5.7.2",
-    "xlsx": "0.17.4"
+    "xliff": "6.0.3",
+    "xlsx": "0.18.2"
   },
   "devDependencies": {
     "eslint": "7.32.0",
     "gh-release": "6.0.1",
-    "pkg": "5.5.1"
+    "pkg": "5.5.2"
   },
   "scripts": {
     "lint": "eslint .",

package/parseLocalLanguage.js

@@ -20,6 +20,7 @@ const getDirectories = (srcpath) => {
 };
 
 const parseLocalLanguage = (opt, lng, cb) => {
+  const hasNamespaceInPath = opt.pathMask.indexOf(`${opt.pathMaskInterpolationPrefix}namespace${opt.pathMaskInterpolationSuffix}`) > -1;
   const filledLngMask = opt.pathMask.replace(`${opt.pathMaskInterpolationPrefix}language${opt.pathMaskInterpolationSuffix}`, lng);
   var firstPartLngMask, lastPartLngMask;
   if (opt.pathMask.indexOf(`${opt.pathMaskInterpolationPrefix}language${opt.pathMaskInterpolationSuffix}`) > opt.pathMask.indexOf(`${opt.pathMaskInterpolationPrefix}namespace${opt.pathMaskInterpolationSuffix}`)) {
@@ -114,6 +115,8 @@ const parseLocalLanguage = (opt, lng, cb) => {
       } else {
         namespace = dirPath.substring(filledNsMask.indexOf(nsMask));
       }
+    } else if (!hasNamespaceInPath && startNsIndex < 0) {
+      namespace = opt.namespace;
     }
     var fPath = path.join(opt.path, lngPath || '', file);
     if (dirPath && lngPath.indexOf(nsMask) > -1) {

package/sync.js

@@ -14,6 +14,7 @@ const parseLocalLanguages = require('./parseLocalLanguages');
 const parseLocalReference = require('./parseLocalReference');
 const formats = require('./formats');
 const lngCodes = require('./lngs.json');
+const deleteNamespace = require('./deleteNamespace');
 const reversedFileExtensionsMap = formats.reversedFileExtensionsMap;
 
 const getDirectories = (srcpath) => {
@@ -303,6 +304,26 @@ const handleError = (err, cb) => {
   if (cb) cb(err);
 };
 
+const checkForMissingLocalNamespaces = (downloads, localNamespaces, opt) => {
+  const localMissingNamespaces = [];
+  downloads.forEach((d) => {
+    const splitted = d.url.split('/');
+    const namespace = splitted.pop();
+    const language = splitted.pop();
+    // if (!opt.referenceLanguageOnly || (opt.referenceLanguageOnly && language === opt.referenceLanguage)) {
+    if (language === opt.referenceLanguage) {
+      const foundLocalNamespace = localNamespaces.find((n) => n.namespace === namespace && n.language === language);
+      if (!foundLocalNamespace) {
+        localMissingNamespaces.push({
+          language,
+          namespace
+        });
+      }
+    }
+  });
+  return localMissingNamespaces;
+};
+
 const handleSync = (opt, remoteLanguages, localNamespaces, cb) => {
   if (!localNamespaces || localNamespaces.length === 0) {
     downloadAll(opt, remoteLanguages, (err) => {
@@ -318,6 +339,8 @@ const handleSync = (opt, remoteLanguages, localNamespaces, cb) => {
 
     opt.isPrivate = downloads.length > 0 && downloads[0].isPrivate;
 
+    const localMissingNamespaces = checkForMissingLocalNamespaces(downloads, localNamespaces, opt);
+
     compareNamespaces(opt, localNamespaces, (err, compared) => {
       if (err) return handleError(err);
 
@@ -336,105 +359,131 @@ const handleSync = (opt, remoteLanguages, localNamespaces, cb) => {
       const shouldOmit = lngsInReqs.length > 5 || nsInReqs.length > 5;
 
       var wasThereSomethingToUpdate = false;
-      async.eachLimit(compared, Math.round(require('os').cpus().length / 2), (ns, clb) => {
-        if (!cb) {
-          if (ns.diff.toRemove.length > 0) {
-            if (opt.skipDelete) {
-              console.log(colors.bgRed(`skipping the removal of ${ns.diff.toRemove.length} keys in ${ns.language}/${ns.namespace}...`));
-              if (opt.dry) console.log(colors.bgRed(`skipped to remove ${ns.diff.toRemove.join(', ')} in ${ns.language}/${ns.namespace}...`));
-            } else {
-              console.log(colors.red(`removing ${ns.diff.toRemove.length} keys in ${ns.language}/${ns.namespace}...`));
-              if (opt.dry) console.log(colors.red(`would remove ${ns.diff.toRemove.join(', ')} in ${ns.language}/${ns.namespace}...`));
+
+      function updateComparedNamespaces() {
+        async.eachLimit(compared, Math.round(require('os').cpus().length / 2), (ns, clb) => {
+          if (!cb) {
+            if (ns.diff.toRemove.length > 0) {
+              if (opt.skipDelete) {
+                console.log(colors.bgRed(`skipping the removal of ${ns.diff.toRemove.length} keys in ${ns.language}/${ns.namespace}...`));
+                if (opt.dry) console.log(colors.bgRed(`skipped to remove ${ns.diff.toRemove.join(', ')} in ${ns.language}/${ns.namespace}...`));
+              } else {
+                console.log(colors.red(`removing ${ns.diff.toRemove.length} keys in ${ns.language}/${ns.namespace}...`));
+                if (opt.dry) console.log(colors.red(`would remove ${ns.diff.toRemove.join(', ')} in ${ns.language}/${ns.namespace}...`));
+              }
             }
-          }
-          if (ns.diff.toRemoveLocally.length > 0) {
-            console.log(colors.red(`removing ${ns.diff.toRemoveLocally.length} keys in ${ns.language}/${ns.namespace} locally...`));
-            if (opt.dry) console.log(colors.red(`would remove ${ns.diff.toRemoveLocally.join(', ')} in ${ns.language}/${ns.namespace} locally...`));
-          }
-          if (ns.diff.toAdd.length > 0) {
-            console.log(colors.green(`adding ${ns.diff.toAdd.length} keys in ${ns.language}/${ns.namespace}...`));
-            if (opt.dry) console.log(colors.green(`would add ${ns.diff.toAdd.join(', ')} in ${ns.language}/${ns.namespace}...`));
-          }
-          if (ns.diff.toAddLocally.length > 0) {
-            if (opt.skipDelete) {
-              console.log(colors.bgGreen(`skipping the addition of ${ns.diff.toAddLocally.length} keys in ${ns.language}/${ns.namespace} locally...`));
-              if (opt.dry) console.log(colors.bgGreen(`skipped the addition of ${ns.diff.toAddLocally.join(', ')} in ${ns.language}/${ns.namespace} locally...`));
-            } else {
-              console.log(colors.green(`adding ${ns.diff.toAddLocally.length} keys in ${ns.language}/${ns.namespace} locally...`));
-              if (opt.dry) console.log(colors.green(`would add ${ns.diff.toAddLocally.join(', ')} in ${ns.language}/${ns.namespace} locally...`));
+            if (ns.diff.toRemoveLocally.length > 0) {
+              console.log(colors.red(`removing ${ns.diff.toRemoveLocally.length} keys in ${ns.language}/${ns.namespace} locally...`));
+              if (opt.dry) console.log(colors.red(`would remove ${ns.diff.toRemoveLocally.join(', ')} in ${ns.language}/${ns.namespace} locally...`));
             }
-          }
-          if (opt.updateValues) {
-            if (ns.diff.toUpdate.length > 0) {
-              console.log(colors.yellow(`updating ${ns.diff.toUpdate.length} keys in ${ns.language}/${ns.namespace}...`));
-              if (opt.dry) console.log(colors.yellow(`would update ${ns.diff.toUpdate.join(', ')} in ${ns.language}/${ns.namespace}...`));
+            if (ns.diff.toAdd.length > 0) {
+              console.log(colors.green(`adding ${ns.diff.toAdd.length} keys in ${ns.language}/${ns.namespace}...`));
+              if (opt.dry) console.log(colors.green(`would add ${ns.diff.toAdd.join(', ')} in ${ns.language}/${ns.namespace}...`));
             }
-            if (ns.diff.toUpdateLocally.length > 0) {
-              console.log(colors.yellow(`updating ${ns.diff.toUpdateLocally.length} keys in ${ns.language}/${ns.namespace} locally...`));
-              if (opt.dry) console.log(colors.yellow(`would update ${ns.diff.toUpdateLocally.join(', ')} in ${ns.language}/${ns.namespace} locally...`));
+            if (ns.diff.toAddLocally.length > 0) {
+              if (opt.skipDelete) {
+                console.log(colors.bgGreen(`skipping the addition of ${ns.diff.toAddLocally.length} keys in ${ns.language}/${ns.namespace} locally...`));
+                if (opt.dry) console.log(colors.bgGreen(`skipped the addition of ${ns.diff.toAddLocally.join(', ')} in ${ns.language}/${ns.namespace} locally...`));
+              } else {
+                console.log(colors.green(`adding ${ns.diff.toAddLocally.length} keys in ${ns.language}/${ns.namespace} locally...`));
+                if (opt.dry) console.log(colors.green(`would add ${ns.diff.toAddLocally.join(', ')} in ${ns.language}/${ns.namespace} locally...`));
+              }
+            }
+            if (opt.updateValues) {
+              if (ns.diff.toUpdate.length > 0) {
+                console.log(colors.yellow(`updating ${ns.diff.toUpdate.length} keys in ${ns.language}/${ns.namespace}...`));
+                if (opt.dry) console.log(colors.yellow(`would update ${ns.diff.toUpdate.join(', ')} in ${ns.language}/${ns.namespace}...`));
+              }
+              if (ns.diff.toUpdateLocally.length > 0) {
+                console.log(colors.yellow(`updating ${ns.diff.toUpdateLocally.length} keys in ${ns.language}/${ns.namespace} locally...`));
+                if (opt.dry) console.log(colors.yellow(`would update ${ns.diff.toUpdateLocally.join(', ')} in ${ns.language}/${ns.namespace} locally...`));
+              }
             }
+            const somethingToUpdate = ns.diff.toAdd.concat(opt.skipDelete ? [] : ns.diff.toRemove)/*.concat(ns.diff.toUpdate)*/.length > 0;
+            if (!somethingToUpdate) console.log(colors.grey(`nothing to update for ${ns.language}/${ns.namespace}`));
+            if (!wasThereSomethingToUpdate && somethingToUpdate) wasThereSomethingToUpdate = true;
           }
-          const somethingToUpdate = ns.diff.toAdd.concat(opt.skipDelete ? [] : ns.diff.toRemove)/*.concat(ns.diff.toUpdate)*/.length > 0;
-          if (!somethingToUpdate) console.log(colors.grey(`nothing to update for ${ns.language}/${ns.namespace}`));
-          if (!wasThereSomethingToUpdate && somethingToUpdate) wasThereSomethingToUpdate = true;
-        }
-        update(opt, ns.language, ns, shouldOmit, (err) => {
-          if (err) return clb(err);
-          if (ns.diff.toRemove.length === 0 || ns.language !== opt.referenceLanguage) return clb();
-          const nsOnlyRemove = cloneDeep(ns);
-          nsOnlyRemove.diff.toAdd = [];
-          nsOnlyRemove.diff.toUpdate = [];
-          async.eachLimit(remoteLanguages, Math.round(require('os').cpus().length / 2), (lng, clb) => update(opt, lng, nsOnlyRemove, shouldOmit, clb), clb);
-        });
-      }, (err) => {
-        if (err) return handleError(err);
-        if (!cb) console.log(colors.grey('syncing...'));
-
-        function down() {
-          setTimeout(() => { // wait a bit before downloading... just to have a chance to get the newly published files
-            downloadAll(opt, remoteLanguages, false, opt.skipDelete ? (lng, namespace, ns) => {
-              const found = compared.find((n) => n.namespace === namespace && n.language === lng);
-              if (found && found.diff) {
-                if (found.diff.toAddLocally && found.diff.toAddLocally.length > 0) {
-                  found.diff.toAddLocally.forEach((k) => {
-                    delete ns[k];
-                  });
-                }
-                if (found.diff.toRemove && found.diff.toRemove.length > 0) {
-                  found.diff.toRemove.forEach((k) => {
-                    delete ns[k];
-                  });
+          update(opt, ns.language, ns, shouldOmit, (err) => {
+            if (err) return clb(err);
+            if (ns.diff.toRemove.length === 0 || ns.language !== opt.referenceLanguage) return clb();
+            const nsOnlyRemove = cloneDeep(ns);
+            nsOnlyRemove.diff.toAdd = [];
+            nsOnlyRemove.diff.toUpdate = [];
+            async.eachLimit(remoteLanguages, Math.round(require('os').cpus().length / 2), (lng, clb) => update(opt, lng, nsOnlyRemove, shouldOmit, clb), clb);
+          });
+        }, (err) => {
+          if (err) return handleError(err);
+          if (!cb) console.log(colors.grey('syncing...'));
+
+          function down() {
+            setTimeout(() => { // wait a bit before downloading... just to have a chance to get the newly published files
+              downloadAll(opt, remoteLanguages, false, opt.skipDelete ? (lng, namespace, ns) => {
+                const found = compared.find((n) => n.namespace === namespace && n.language === lng);
+                if (found && found.diff) {
+                  if (found.diff.toAddLocally && found.diff.toAddLocally.length > 0) {
+                    found.diff.toAddLocally.forEach((k) => {
+                      delete ns[k];
+                    });
+                  }
+                  if (found.diff.toRemove && found.diff.toRemove.length > 0) {
+                    found.diff.toRemove.forEach((k) => {
+                      delete ns[k];
+                    });
+                  }
                 }
-              }
-            } : undefined, (err) => {
-              if (err) return handleError(err);
-              if (!cb) console.log(colors.green('FINISHED'));
-              if (cb) cb(null);
-            });
-          }, wasThereSomethingToUpdate && !opt.dry ? 5000 : 0);
-        }
+              } : undefined, (err) => {
+                if (err) return handleError(err);
+                if (!cb) console.log(colors.green('FINISHED'));
+                if (cb) cb(null);
+              });
+            }, wasThereSomethingToUpdate && !opt.dry ? 5000 : 0);
+          }
 
-        if (!shouldOmit) return down();
-        if (opt.dry) return down();
+          if (!shouldOmit) return down();
+          if (opt.dry) return down();
 
-        // optimize stats generation...
-        request(opt.apiPath + '/stats/project/regenerate/' + opt.projectId + '/' + opt.version + (lngsInReqs.length === 1 ? `/${lngsInReqs[0]}` : '') + (nsInReqs.length === 1 ? `?namespace=${nsInReqs[0]}` : ''), {
-          method: 'post',
-          body: {},
-          headers: {
-            'Authorization': opt.apiKey
-          }
-        }, (err, res, obj) => {
-          if (err) return handleError(err);
-          if (res.status >= 300 && res.status !== 412) {
-            if (obj && (obj.errorMessage || obj.message)) {
-              return handleError(new Error((obj.errorMessage || obj.message)));
+          // optimize stats generation...
+          request(opt.apiPath + '/stats/project/regenerate/' + opt.projectId + '/' + opt.version + (lngsInReqs.length === 1 ? `/${lngsInReqs[0]}` : '') + (nsInReqs.length === 1 ? `?namespace=${nsInReqs[0]}` : ''), {
+            method: 'post',
+            body: {},
+            headers: {
+              'Authorization': opt.apiKey
+            }
+          }, (err, res, obj) => {
+            if (err) return handleError(err);
+            if (res.status >= 300 && res.status !== 412) {
+              if (obj && (obj.errorMessage || obj.message)) {
+                return handleError(new Error((obj.errorMessage || obj.message)));
+              }
+              return handleError(new Error(res.statusText + ' (' + res.status + ')'));
             }
-            return handleError(new Error(res.statusText + ' (' + res.status + ')'));
+            down();
+          });
+        });
+      }
+
+      if (opt.deleteRemoteNamespace && localMissingNamespaces.length > 0) {
+        wasThereSomethingToUpdate = true;
+        async.each(localMissingNamespaces, (n, clb) => {
+          if (opt.dry) {
+            console.log(colors.red(`would delete complete namespace ${n.namespace}...`));
+            return clb();
           }
-          down();
+          console.log(colors.red(`deleting complete namespace ${n.namespace}...`));
+          deleteNamespace({
+            apiPath: opt.apiPath,
+            apiKey: opt.apiKey,
+            projectId: opt.projectId,
+            version: opt.version,
+            namespace: n.namespace
+          }, clb);
+        }, (err) => {
+          if (err) return handleError(err);
+          updateComparedNamespaces();
         });
-      });
+        return;
+      }
+      updateComparedNamespaces();
     });
   });
 };