locize-cli 9.0.1 → 9.1.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/).
 
+## [9.1.0](https://github.com/locize/locize-cli/compare/v9.0.2...v9.1.0) - 2025-05-07
+
+- introduce `remove-version` command
+
+## [9.0.2](https://github.com/locize/locize-cli/compare/v9.0.1...v9.0.2) - 2025-04-25
+
+- Hint: `Using the "--auto-translate true" option together with the "--reference-language-only false" option might result in inconsistent target language translations (automatic translation vs. what is sent direcly to locize).`
+
 ## [9.0.1](https://github.com/locize/locize-cli/compare/v9.0.0...v9.0.1) - 2025-04-04
 
 - optimize xcstrings format [106](https://github.com/locize/locize-cli/issues/106)

package/README.md

@@ -237,6 +237,20 @@ locize publish-version --api-key my-api-key-d9de-4f55-9855-a9ef0ed44672 --projec
 ```
 
 
+## Delete version
+
+*It uses this [API endpoint](https://www.locize.com/docs/api#remove-version).*
+
+### Step 1: execute
+
+Add your api-key and your project-id and let's go...
+
+```sh
+# this will remove version tmp-ver
+locize remove-version tmp-ver --api-key my-api-key-d9de-4f55-9855-a9ef0ed44672 --project-id my-project-id-93e1-442a-ab35-24331fa294ba
+```
+
+
 ## Delete namespace
 ### Step 1: execute
 

package/bin/locize

@@ -22,6 +22,7 @@ const get = require('../get');
 const sync = require('../sync');
 const missing = require('../missing');
 const copyVersion = require('../copyVersion');
+const removeVersion = require('../removeVersion.js');
 const publishVersion = require('../publishVersion');
 const deleteNamespace = require('../deleteNamespace');
 const formatFn = require('../format');
@@ -588,7 +589,50 @@ program
     console.log();
     console.log('    $ locize copy-version latest"');
     console.log('    $ locize copy-version latest --ver production"');
-    console.log('    $ locize copy-version latest production --api-key <apiKey> --project-id <projectId> --ver <version>');
+    console.log('    $ locize copy-version latest --api-key <apiKey> --project-id <projectId> --ver <version>');
+    console.log();
+  });
+
+program
+  .command('remove-version <version>')
+  .alias('rv')
+  .description('remove version')
+  .option('-k, --api-key <apiKey>', 'The api-key that should be used')
+  .option('-i, --project-id <projectId>', 'The project-id that should be used')
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
+  .action((version, options) => {
+    try {
+      config = ini.parse(fs.readFileSync(options.configPath, 'utf-8')) || config;
+    } catch (e) {}
+
+    const apiKey = options.apiKey || config.apiKey || process.env.LOCIZE_API_KEY || process.env.LOCIZE_KEY;
+    if (!apiKey) {
+      console.error('  error: missing required argument `apiKey`');
+      process.exit(1);
+      return;
+    }
+
+    const projectId = options.projectId || config.projectId || process.env.LOCIZE_PROJECTID || process.env.LOCIZE_PID;
+    if (!projectId) {
+      console.error('  error: missing required argument `projectId`');
+      process.exit(1);
+      return;
+    }
+
+    const getPath = options.getPath || config.getPath || getPathUrl;
+
+    removeVersion({
+      apiKey: apiKey,
+      projectId: projectId,
+      apiPath: url.parse(getPath).protocol + '//' + url.parse(getPath).host,
+      version: version
+    });
+  })
+  .on('--help', () => {
+    console.log('  Examples:');
+    console.log();
+    console.log('    $ locize remove-version tmp-ver"');
+    console.log('    $ locize remove-version tmp-ver --api-key <apiKey> --project-id <projectId>');
     console.log();
   });
 

package/download.js

@@ -93,7 +93,7 @@ function handleDownload(opt, url, err, res, downloads, cb) {
               if (clb) clb(null);
             }
 
-            const fileContent = opt.format !== 'xlsx' ? (converted + '\n') : converted;
+            const fileContent = (opt.format !== 'xlsx' && !converted.endsWith('\n')) ? (converted + '\n') : converted;
             if (!opt.version) {
               if (mkdirPath) mkdirp.sync(path.join(opt.path, version, mkdirPath));
               fs.writeFile(path.join(opt.path, version, filledMask), fileContent, logAndClb);
@@ -145,7 +145,7 @@ function handleDownload(opt, url, err, res, downloads, cb) {
           if (filledMask.lastIndexOf(path.sep) > 0) {
             mkdirPath = filledMask.substring(0, filledMask.lastIndexOf(path.sep));
           }
-          const fileContent = opt.format !== 'xlsx' ? (converted + '\n') : converted;
+          const fileContent = (opt.format !== 'xlsx' && !converted.endsWith('\n')) ? (converted + '\n') : converted;
           if (!opt.version) {
             if (mkdirPath) mkdirp.sync(path.join(opt.path, version, mkdirPath));
             fs.writeFile(path.join(opt.path, version, filledMask), fileContent, clb);
@@ -232,7 +232,7 @@ function handlePull(opt, toDownload, cb) {
           }
 
           if (mkdirPath) mkdirp.sync(path.join(opt.path, mkdirPath));
-          const fileContent = opt.format !== 'xlsx' ? (converted + '\n') : converted;
+          const fileContent = (opt.format !== 'xlsx' && !converted.endsWith('\n')) ? (converted + '\n') : converted;
           fs.writeFile(path.join(opt.path, filledMask), fileContent, logAndClb);
         } catch (e) {
           err.message = 'Invalid content for "' + opt.format + '" format!\n' + (err.message || '');
@@ -276,7 +276,7 @@ function handlePull(opt, toDownload, cb) {
           if (filledMask.lastIndexOf(path.sep) > 0) {
             mkdirPath = filledMask.substring(0, filledMask.lastIndexOf(path.sep));
           }
-          const fileContent = opt.format !== 'xlsx' ? (converted + '\n') : converted;
+          const fileContent = (opt.format !== 'xlsx' && !converted.endsWith('\n')) ? (converted + '\n') : converted;
           if (!opt.language) {
             if (mkdirPath) mkdirp.sync(path.join(opt.path, mkdirPath));
             fs.writeFile(path.join(opt.path, filledMask), fileContent, clb);

package/format.js

@@ -113,7 +113,7 @@ function writeLocalFile(opt, file, clb) {
     return clb(null, true);
   }
 
-  const fileContent = opt.format !== 'xlsx' ? (file.converted + '\n') : file.converted;
+  const fileContent = (opt.format !== 'xlsx' && !file.converted.endsWith('\n')) ? (file.converted + '\n') : file.converted;
 
   fs.writeFile(file.path, fileContent, (err) => clb(err, true));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locize-cli",
-  "version": "9.0.1",
+  "version": "9.1.0",
   "description": "locize cli to import locales",
   "main": "index.js",
   "bin": {
@@ -15,7 +15,7 @@
     "commander": "9.5.0",
     "csvjson": "5.1.0",
     "diff": "7.0.0",
-    "dotenv": "16.4.7",
+    "dotenv": "16.5.0",
     "flat": "5.0.2",
     "fluent_conv": "3.3.0",
     "gettext-converter": "1.3.0",
@@ -31,11 +31,11 @@
     "rimraf": "4.4.1",
     "strings-file": "0.0.5",
     "tmexchange": "2.0.5",
-    "xliff": "6.2.1",
+    "xliff": "6.2.2",
     "xlsx": "https://cdn.sheetjs.com/xlsx-0.20.3/xlsx-0.20.3.tgz"
   },
   "devDependencies": {
-    "@yao-pkg/pkg": "6.3.1",
+    "@yao-pkg/pkg": "6.4.0",
     "eslint": "8.56.0",
     "gh-release": "7.0.2"
   },

package/removeVersion.js

@@ -0,0 +1,64 @@
+const colors = require('colors');
+const request = require('./request');
+const getJob = require('./getJob');
+
+const removeVersion = (opt, cb) => {
+  request(opt.apiPath + '/version/' + opt.projectId + '/' + opt.version, {
+    method: 'delete',
+    headers: {
+      'Authorization': opt.apiKey
+    }
+  }, (err, res, obj) => {
+    if (err || (obj && (obj.errorMessage || obj.message))) {
+      if (!cb) console.log(colors.red(`remove failed for version ${opt.version}...`));
+
+      if (err) {
+        if (!cb) { console.error(colors.red(err.message)); process.exit(1); }
+        if (cb) cb(err);
+        return;
+      }
+      if (obj && (obj.errorMessage || obj.message)) {
+        if (!cb) { console.error(colors.red((obj.errorMessage || obj.message))); process.exit(1); }
+        if (cb) cb(new Error((obj.errorMessage || obj.message)));
+        return;
+      }
+    }
+    if (res.status >= 300) {
+      if (!cb) { console.error(colors.red(res.statusText + ' (' + res.status + ')')); process.exit(1); }
+      if (cb) cb(new Error(res.statusText + ' (' + res.status + ')'));
+      return;
+    }
+
+    if (!obj || !obj.jobId) {
+      if (!cb) { console.error(colors.red('No jobId! Something went wrong!')); process.exit(1); }
+      if (cb) cb(new Error('No jobId! Something went wrong!'));
+      return;
+    }
+
+    (function waitForJob() {
+      getJob(opt, obj.jobId, (err, job) => {
+        if (err) {
+          if (!cb) { console.error(colors.red(err.message)); process.exit(1); }
+          if (cb) cb(err);
+          return;
+        }
+
+        if (job && !job.timeouted) {
+          setTimeout(waitForJob, 2000);
+          return;
+        }
+
+        if (job && job.timeouted) {
+          if (!cb) { console.error(colors.red('Job timeouted!')); process.exit(1); }
+          if (cb) cb(new Error('Job timeouted!'));
+          return;
+        }
+
+        if (!cb) console.log(colors.green(`remove version ${opt.version} succesfully requested`));
+        if (cb) cb(null);
+      });
+    })();
+  });
+};
+
+module.exports = removeVersion;

package/sync.js

@@ -267,7 +267,7 @@ const downloadAll = (opt, remoteLanguages, omitRef, manipulate, cb) => {
             }
             const parentDir = path.dirname(path.join(opt.path, filledMask));
             mkdirp.sync(parentDir);
-            const fileContent = opt.format !== 'xlsx' ? (converted + '\n') : converted;
+            const fileContent = (opt.format !== 'xlsx' && !converted.endsWith('\n')) ? (converted + '\n') : converted;
             fs.writeFile(path.join(opt.path, filledMask), fileContent, clb);
           } catch (e) {
             err.message = 'Invalid content for "' + opt.format + '" format!\n' + (err.message || '');
@@ -307,7 +307,7 @@ const downloadAll = (opt, remoteLanguages, omitRef, manipulate, cb) => {
             }
             const parentDir = path.dirname(path.join(opt.path, filledMask));
             mkdirp.sync(parentDir);
-            const fileContent = opt.format !== 'xlsx' ? (converted + '\n') : converted;
+            const fileContent = (opt.format !== 'xlsx' && !converted.endsWith('\n')) ? (converted + '\n') : converted;
             fs.writeFile(path.join(opt.path, filledMask), fileContent, clb);
           });
         });
@@ -335,7 +335,7 @@ const update = (opt, lng, ns, shouldOmit, cb) => {
 
   function send(d, so, clb, isRetrying) {
     const queryParams = new URLSearchParams();
-    if (opt.autoTranslate) {
+    if (opt.autoTranslate && lng === opt.referenceLanguage) {
       /** @See https://www.locize.com/docs/api#optional-autotranslate */
       queryParams.append('autotranslate', 'true');
     }
@@ -489,7 +489,7 @@ const backupDeleted = (opt, ns, now) => {
   }, {});
   mkdirp.sync(path.join(currentBackupPath, ns.language));
   const content = JSON.stringify(removingRemote, null, 2);
-  const fileContent = opt.format !== 'xlsx' ? (content + '\n') : content;
+  const fileContent = (opt.format !== 'xlsx' && !content.endsWith('\n')) ? (content + '\n') : content;
   fs.writeFileSync(path.join(currentBackupPath, ns.language, `${ns.namespace}.json`), fileContent);
 };
 
@@ -665,6 +665,10 @@ const sync = (opt, cb) => {
     return handleError(new Error(`${opt.format} is not a valid format!`), cb);
   }
 
+  if (opt.autoTranslate && !opt.referenceLanguageOnly) {
+    console.log(colors.yellow('Using the "--auto-translate true" option together with the "--reference-language-only false" option might result in inconsistent target language translations (automatic translation vs. what is sent direcly to locize).'));
+  }
+
   opt.version = opt.version || 'latest';
   opt.apiPath = opt.apiPath || 'https://api.locize.app';