locize-cli 8.3.0 → 8.4.0

package/CHANGELOG.md

@@ -5,6 +5,14 @@ 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/).
 
+## [8.4.0](https://github.com/locize/locize-cli/compare/v8.3.1...v8.4.0) - 2024-12-23
+
+- feat: add --auto-translate option for sync command [101](https://github.com/locize/locize-cli/pull/101)
+
+## [8.3.1](https://github.com/locize/locize-cli/compare/v8.3.0...v8.3.1) - 2024-12-23
+
+- special check for CVS (does not cleanup local language folders)
+
 ## [8.3.0](https://github.com/locize/locize-cli/compare/v8.2.0...v8.3.0) - 2024-11-25
 
 - update some deprecated dependencies (#100)

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 locize
+Copyright (c) 2025 locize
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -146,6 +146,7 @@ locize sync --api-key my-api-key-d9de-4f55-9855-a9ef0ed44672 --project-id my-pro
 - if you have less keys (you have deleted some keys) in your local namespace it will remove them in locize too
 - all non reference languages will always be just locally replaced by what is published on locize, unless the *--skip-delete true* argument is used
 - if you change the values of existing keys in the reference language, it will not change them in locize (to change the existing values you have to change it directly in locize or use the *--update-values true* argument)
+- if you update existing keys (with *--update-values true*) the automatic translation is not triggered, unless the *--auto-translate true* argument us used
 - **if you want to take into account all languages instead of the reference language only while comparing the namespace content between local and remote, you can use the command argument *--reference-language-only false***
 - **if you want to take into account the modification time while comparing the namespace content between local and remote, you can use the command argument *--compare-modification-time true***
 

package/bin/locize

@@ -366,6 +366,7 @@ program
   .option('-c, --clean <true|false>', 'Removes all local files by removing the whole folder (default: false)', 'false')
   .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('--auto-translate <true|false>', 'This will trigger auto-translation of updated 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}}`)
@@ -415,6 +416,7 @@ program
     const cleanLocalFiles = options.cleanLocalFiles === 'true';
     const dry = options.dry === 'true';
     const updateValues = options.updateValues === 'true';
+    const autoTranslate = options.autoTranslate === 'true';
     const skipDelete = options.skipDelete === 'true';
     const deleteRemoteNamespace = options.deleteRemoteNamespace === 'true';
     const languageFolderPrefix = options.languageFolderPrefix || '';
@@ -434,6 +436,7 @@ program
       path: options.path,
       format: options.format,
       updateValues: updateValues,
+      autoTranslate: autoTranslate,
       skipDelete: skipDelete,
       deleteRemoteNamespace: deleteRemoteNamespace,
       languageFolderPrefix: languageFolderPrefix,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locize-cli",
-  "version": "8.3.0",
+  "version": "8.4.0",
   "description": "locize cli to import locales",
   "main": "index.js",
   "bin": {
@@ -15,11 +15,11 @@
     "commander": "9.5.0",
     "csvjson": "5.1.0",
     "diff": "7.0.0",
-    "dotenv": "16.4.5",
+    "dotenv": "16.4.7",
     "flat": "5.0.2",
     "fluent_conv": "3.3.0",
     "gettext-converter": "1.3.0",
-    "https-proxy-agent": "7.0.5",
+    "https-proxy-agent": "7.0.6",
     "ini": "4.1.3",
     "js-yaml": "4.1.0",
     "laravelphp": "2.0.4",
@@ -36,7 +36,7 @@
   "devDependencies": {
     "eslint": "8.56.0",
     "gh-release": "7.0.2",
-    "@yao-pkg/pkg": "6.1.1"
+    "@yao-pkg/pkg": "6.2.0"
   },
   "scripts": {
     "lint": "eslint .",

package/sync.js

@@ -266,7 +266,19 @@ const update = (opt, lng, ns, shouldOmit, cb) => {
   var payloadKeysLimit = 1000;
 
   function send(d, so, clb, isRetrying) {
-    request(opt.apiPath + '/update/' + opt.projectId + '/' + opt.version + '/' + lng + '/' + ns.namespace + (so ? '?omitstatsgeneration=true' : ''), {
+    const queryParams = new URLSearchParams();
+    if (opt.autoTranslate) {
+      /** @See https://docs.locize.com/integration/api#optional-autotranslate */
+      queryParams.append('autotranslate', 'true');
+    }
+    if (so) {
+      // no API docs for this
+      queryParams.append('omitstatsgeneration', 'true');
+    }
+
+    const queryString = queryParams.size > 0 ? '?' + queryParams.toString() : '';
+
+    request(opt.apiPath + '/update/' + opt.projectId + '/' + opt.version + '/' + lng + '/' + ns.namespace + queryString, {
       method: 'post',
       body: d,
       headers: {
@@ -318,6 +330,14 @@ const update = (opt, lng, ns, shouldOmit, cb) => {
   send(data, shouldOmit, cb);
 };
 
+const doesDirectoryExist = (p) => {
+  var directoryExists = false;
+  try {
+    directoryExists = fs.statSync(p).isDirectory();
+  } catch (e) {}
+  return directoryExists;
+};
+
 const cleanupLanguages = (opt, remoteLanguages) => {
   if (opt.pathMask.lastIndexOf(path.sep) < 0) return;
   const dirs = getDirectories(opt.path).filter((dir) => dir.indexOf('.') !== 0);
@@ -338,6 +358,7 @@ const cleanupLanguages = (opt, remoteLanguages) => {
         if (filledLngMask.lastIndexOf(path.sep) > 0) {
           lngPath = filledLngMask.substring(0, filledLngMask.lastIndexOf(path.sep));
         }
+        if (doesDirectoryExist(path.join(opt.path, lngPath, 'CVS'))) return; // special hack for CVS
         rimraf.sync(path.join(opt.path, lngPath));
       });
   }
@@ -472,7 +493,7 @@ const handleSync = (opt, remoteLanguages, localNamespaces, cb) => {
             }
             if (opt.updateValues) {
               if (ns.diff.toUpdate.length > 0) {
-                console.log(colors.yellow(`updating ${ns.diff.toUpdate.length} keys in ${ns.language}/${ns.namespace}...`));
+                console.log(colors.yellow(`updating ${ns.diff.toUpdate.length} keys in ${ns.language}/${ns.namespace}${opt.autoTranslate ? ' with automatic translation' : ''}...`));
                 if (opt.dry) console.log(colors.yellow(`would update ${ns.diff.toUpdate.join(', ')} in ${ns.language}/${ns.namespace}...`));
               }
               if (ns.diff.toUpdateLocally.length > 0) {
@@ -581,11 +602,7 @@ const sync = (opt, cb) => {
   if (!opt.dry && opt.clean) rimraf.sync(path.join(opt.path, '*'));
 
   if (opt.autoCreatePath === false) {
-    var directoryExists = false;
-    try {
-      directoryExists = fs.statSync(opt.path).isDirectory();
-    } catch (e) {}
-    if (!directoryExists) {
+    if (!doesDirectoryExist(opt.path)) {
       return handleError(new Error(`${opt.path} does not exist!`), cb);
     }
   }