locize-cli 10.2.0 → 10.3.0

package/CHANGELOG.md

@@ -6,6 +6,15 @@ Project versioning adheres to [Semantic Versioning](http://semver.org/).
 Change log format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 
+## [10.3.0](https://github.com/locize/locize-cli/compare/v10.2.1...v10.3.0) - 2025-08-11
+
+- introduce delete-branch command
+- sync/download: try to check if version exists also on dry-run
+
+## [10.2.1](https://github.com/locize/locize-cli/compare/v10.2.0...v10.2.1) - 2025-08-07
+
+- download/sync: check if branch name is empty string
+
 ## [10.2.0](https://github.com/locize/locize-cli/compare/v10.1.1...v10.2.0) - 2025-07-16
 
 - download/sync introduce `--overridden-only` option for branches or tenants

package/README.md

@@ -23,6 +23,23 @@ iwr https://raw.githubusercontent.com/locize/locize-cli/master/install.ps1 -useb
 ```
 
 
+> ⚠️ **Filename restrictions**  
+> The namespace you choose becomes your on-disk filename, so please avoid these characters:
+> ```
+> <   (less than)
+> >   (greater than)
+> :   (colon)
+> "   (double quote)
+> /   (forward slash)
+> \   (backslash)
+> |   (vertical bar or pipe)
+> ?   (question mark)
+> *   (asterisk)
+> ```
+> These are sometimes illegal on various operating systems, so using them may lead to files not being written or being written incorrectly. If necessary, use only letters, numbers, hyphens ("-") and underscores ("_") in your namespace names.
+
+
+
 ## Adding/Updating new keys
 ### Step 1: execute
 
@@ -346,6 +363,12 @@ locize download --branch featureXYZ --api-key my-api-key-d9de-4f55-9855-a9ef0ed4
 locize merge-branch featureXYZ --api-key my-api-key-d9de-4f55-9855-a9ef0ed44672 --project-id my-project-id-93e1-442a-ab35-24331fa294ba --delete true
 ```
 
+### Delete an unmerged branch
+
+```sh
+locize delete-branch featureXYZ --api-key my-api-key-d9de-4f55-9855-a9ef0ed44672 --project-id my-project-id-93e1-442a-ab35-24331fa294ba
+```
+
 
 ## Other information
 

package/bin/locize

@@ -28,6 +28,7 @@ const deleteNamespace = require('../deleteNamespace');
 const formatFn = require('../format');
 const createBranch = require('../createBranch');
 const mergeBranch = require('../mergeBranch');
+const deleteBranch = require('../deleteBranch');
 
 var config = {};
 try {
@@ -839,9 +840,9 @@ program
   .on('--help', () => {
     console.log('  Examples:');
     console.log();
-    console.log('    $ locize creaete-branch featureX');
-    console.log('    $ locize creaete-branch featureX --ver production');
-    console.log('    $ locize creaete-branch featureX --api-key <apiKey> --project-id <projectId> --ver <version>');
+    console.log('    $ locize create-branch featureX');
+    console.log('    $ locize create-branch featureX --ver production');
+    console.log('    $ locize create-branch featureX --api-key <apiKey> --project-id <projectId> --ver <version>');
     console.log();
   });
 
@@ -892,6 +893,49 @@ program
     console.log();
   });
 
+program
+  .command('delete-branch <branch>')
+  .alias('cb')
+  .description('delete branch')
+  .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((branch, 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 || options.addPath || config.addPath || getPathUrl;
+
+    deleteBranch({
+      apiKey: apiKey,
+      projectId: projectId,
+      apiPath: url.parse(getPath).protocol + '//' + url.parse(getPath).host,
+      branch: branch
+    });
+  })
+  .on('--help', () => {
+    console.log('  Examples:');
+    console.log();
+    console.log('    $ locize delete-branch featureX');
+    console.log('    $ locize delete-branch featureX --api-key <apiKey> --project-id <projectId>');
+    console.log();
+  });
+
 program.parse(process.argv);
 
 if (!process.argv.slice(2).length) {

package/deleteBranch.js

@@ -0,0 +1,97 @@
+const colors = require('colors');
+const request = require('./request');
+const getBranches = require('./getBranches');
+const getJob = require('./getJob');
+const isValidUuid = require('./isValidUuid');
+
+const handleError = (err, cb) => {
+  if (!cb && err) {
+    console.error(colors.red(err.stack));
+    process.exit(1);
+  }
+  if (cb) cb(err);
+};
+
+const deleteBranch = (opt, cb) => {
+  request(opt.apiPath + '/branch/' + opt.branch, {
+    method: 'delete',
+    headers: {
+      'Authorization': opt.apiKey
+    }
+  }, (err, res, obj) => {
+    if (err || (obj && (obj.errorMessage || obj.message))) {
+      if (!cb) console.log(colors.red('deleting branch failed...'));
+
+      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 === 404) {
+      if (!cb) { console.error(colors.yellow(res.statusText + ' (' + res.status + ')')); process.exit(1); }
+      if (cb) cb(null, null);
+      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({
+        apiPath: opt.apiPath,
+        apiKey: opt.apiKey,
+        projectId: opt.branch
+      }, 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(`deleting branch "${opt.branch}" succesfully requested`));
+        if (cb) cb(null);
+      });
+    })();
+  });
+};
+
+module.exports = (opt, cb) => {
+  getBranches(opt, (err, branches) => {
+    if (err) return handleError(err, cb);
+
+    let b;
+    if (isValidUuid(opt.branch)) b = branches.find((br) => br.id === opt.branch);
+    if (!b) b = branches.find((br) => br.name === opt.branch);
+    if (!b) {
+      return handleError(new Error(`Branch ${opt.branch} not found!`), cb);
+    }
+    opt.branch = b.id;
+
+    deleteBranch(opt, cb);
+  });
+};

package/download.js

@@ -417,15 +417,27 @@ const continueToDownload = (opt, cb) => {
           return;
         }
 
-        obj = filterDownloads(opt, obj || []);
-        handleDownload(opt, url, err, res, obj, cb);
+        if (obj.length > 0) {
+          obj = filterDownloads(opt, obj || []);
+          return handleDownload(opt, url, err, res, obj, cb);
+        }
+
+        getProjectStats(opt, (err, res) => {
+          if (err) return handleError(err, cb);
+          if (!res) return handleError(new Error('Nothing found!'), cb);
+          if (!res[opt.version]) return handleError(new Error(`Version "${opt.version}" not found!`), cb);
+
+          obj = filterDownloads(opt, obj || []);
+          return handleDownload(opt, url, err, res, obj, cb);
+        });
       });
       return;
     }
 
     getProjectStats(opt, (err, res) => {
       if (err) return handleError(err, cb);
-      if (!res || !res[opt.version]) return handleError(new Error('Nothing found!'), cb);
+      if (!res) return handleError(new Error('Nothing found!'), cb);
+      if (!res[opt.version]) return handleError(new Error(`Version "${opt.version}" not found!`), cb);
 
       const toDownload = [];
       const lngsToCheck = opt.language ? [opt.language] : Object.keys(res[opt.version]);
@@ -474,6 +486,10 @@ const download = (opt, cb) => {
     return handleError(new Error('Please provide also an api-key!'), cb);
   }
 
+  if (opt.branch === '') {
+    return handleError(new Error('The branch name seems invalid!'), cb);
+  }
+
   if (opt.branch) {
     getBranches(opt, (err, branches) => {
       if (err) return handleError(err, cb);

package/mergeBranch.js

@@ -48,7 +48,11 @@ const mergeBranch = (opt, cb) => {
     }
 
     (function waitForJob() {
-      getJob(opt, obj.jobId, (err, job) => {
+      getJob({
+        apiPath: opt.apiPath,
+        apiKey: opt.apiKey,
+        projectId: opt.branch
+      }, obj.jobId, (err, job) => {
         if (err) {
           if (!cb) { console.error(colors.red(err.message)); process.exit(1); }
           if (cb) cb(err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locize-cli",
-  "version": "10.2.0",
+  "version": "10.3.0",
   "description": "locize cli to import locales",
   "main": "index.js",
   "bin": {

package/sync.js

@@ -53,13 +53,24 @@ const getDownloads = (opt, cb) => {
         }
         return cb(new Error(res.statusText + ' (' + res.status + ')'));
       }
-      if (opt.skipEmpty) obj = obj.filter((d) => d.size > 2);
-      cb(null, obj);
+      if (obj.length > 0) {
+        if (opt.skipEmpty) obj = obj.filter((d) => d.size > 2);
+        return cb(null, obj);
+      }
+
+      getProjectStats(opt, (err, res) => {
+        if (err) return handleError(err, cb);
+        if (!res) return handleError(new Error('Nothing found!'), cb);
+        if (!res[opt.version]) return handleError(new Error(`Version "${opt.version}" not found!`), cb);
+
+        return cb(null, obj);
+      });
     });
   } else {
     getProjectStats(opt, (err, res) => {
       if (err) return handleError(err, cb);
-      if (!res || !res[opt.version]) return handleError(new Error('Nothing found!'), cb);
+      if (!res) return handleError(new Error('Nothing found!'), cb);
+      if (!res[opt.version]) return handleError(new Error(`Version "${opt.version}" not found!`), cb);
 
       const toDownload = [];
       const lngsToCheck = opt.language ? [opt.language] : (opt.languages && opt.languages.length > 0) ? opt.languages : Object.keys(res[opt.version]);
@@ -743,6 +754,10 @@ const sync = (opt, cb) => {
     return handleError(new Error('Please provide also an api-key!'), cb);
   }
 
+  if (opt.branch === '') {
+    return handleError(new Error('The branch name seems invalid!'), cb);
+  }
+
   if (opt.branch) {
     getBranches(opt, (err, branches) => {
       if (err) return handleError(err, cb);