locize-cli 10.1.1 → 10.2.1

package/CHANGELOG.md

@@ -5,6 +5,15 @@ 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/).
 
+
+## [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
+
 ## [10.1.1](https://github.com/locize/locize-cli/compare/v10.1.0...v10.1.1) - 2025-07-12
 
 - create-branch: nicer feedback, if branch already exists

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
 

package/bin/locize

@@ -241,6 +241,7 @@ program
   .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('-c, --clean <true|false>', 'Removes all local files by removing the whole folder (default: false)', 'false')
   .option('-up, --unpublished <true|false>', 'Downloads the current (unpublished) translations. This will generate private download costs (default: false)', 'false')
+  .option('-oo, --overridden-only <true|false>', 'Downloads only the current overridden (unpublished) translations of a tenant or branch project. This will generate private download costs (default: false)', 'false')
   .option('-b, --branch <branch>', 'The branch name (or id) that should be targeted')
   .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((options) => {
@@ -274,6 +275,8 @@ program
 
     const unpublished = options.unpublished === 'true';
 
+    const overriddenOnly = options.overriddenOnly === 'true';
+
     const languageFolderPrefix = options.languageFolderPrefix || '';
 
     const pathMask = options.pathMask;
@@ -295,7 +298,8 @@ program
       languageFolderPrefix: languageFolderPrefix,
       pathMask: pathMask,
       unpublished: unpublished,
-      branch: branch
+      branch: branch,
+      overriddenOnly: overriddenOnly
     });
   })
   .on('--help', () => {
@@ -386,6 +390,7 @@ program
   .option('-n, --namespace <ns>', 'The namespace that should be targeted (you can also pass a comma separated list)')
   .option('-g, --get-path <url>', `Specify the get-path url that should be used (default: ${getPathUrl})`)
   .option('-up, --unpublished <true|false>', 'Downloads the current (unpublished) translations. This will generate private download costs (default: false)', 'false')
+  .option('-oo, --overridden-only <true|false>', 'Downloads only the current overridden (unpublished) translations of a tenant or branch project. This will generate private download costs (default: false)', 'false')
   .option('-b, --branch <branch>', 'The branch name (or id) that should be targeted')
   .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((options) => {
@@ -433,6 +438,7 @@ program
     const compareModificationTime = options.compareModificationTime === 'true';
     const pathMask = options.pathMask;
     const unpublished = options.unpublished === 'true';
+    const overriddenOnly = options.overriddenOnly === 'true';
     const autoCreatePath = options.autoCreatePath === 'true';
     const backupDeletedPath = options.backupDeletedPath;
     const branch = options.branch;
@@ -462,7 +468,8 @@ program
       unpublished: unpublished,
       autoCreatePath: autoCreatePath,
       backupDeletedPath: backupDeletedPath,
-      branch: branch
+      branch: branch,
+      overriddenOnly: overriddenOnly
     });
   })
   .on('--help', () => {

package/download.js

@@ -467,10 +467,17 @@ const download = (opt, cb) => {
   opt.pathMaskInterpolationSuffix = opt.pathMaskInterpolationSuffix || '}}';
   opt.pathMask = opt.pathMask || `${opt.pathMaskInterpolationPrefix}language${opt.pathMaskInterpolationSuffix}${path.sep}${opt.pathMaskInterpolationPrefix}namespace${opt.pathMaskInterpolationSuffix}`;
   opt.pathMask = opt.pathMask.replace(`${opt.pathMaskInterpolationPrefix}language${opt.pathMaskInterpolationSuffix}`, `${opt.languageFolderPrefix}${opt.pathMaskInterpolationPrefix}language${opt.pathMaskInterpolationSuffix}`);
+  if (opt.overriddenOnly) {
+    opt.unpublished = true;
+  }
   if (opt.unpublished && !opt.apiKey) {
     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/getRemoteNamespace.js

@@ -23,7 +23,7 @@ function onlyKeysFlat(resources, prefix, ret) {
 
 const pullNamespacePaged = (opt, lng, ns, cb, next, retry) => {
   next = next || '';
-  request(opt.apiPath + '/pull/' + opt.projectId + '/' + opt.version + '/' + lng + '/' + ns + '?' + 'next=' + next + (opt.raw ? '&raw=true' : '') + '&ts=' + Date.now(), {
+  request(opt.apiPath + '/pull/' + opt.projectId + '/' + opt.version + '/' + lng + '/' + ns + '?' + 'next=' + next + ((opt.raw || opt.overriddenOnly) ? '&raw=true' : '') + '&ts=' + Date.now(), {
     method: 'get',
     headers: {
       'Authorization': opt.apiKey
@@ -47,6 +47,20 @@ const pullNamespacePaged = (opt, lng, ns, cb, next, retry) => {
       return cb(new Error(res.statusText + ' (' + res.status + ')'));
     }
 
+    if (opt.overriddenOnly && obj) {
+      const newObj = {};
+      Object.keys(obj).forEach((k) => {
+        if (obj[k].overrides !== undefined) {
+          if (opt.raw) {
+            newObj[k] = obj[k];
+          } else {
+            newObj[k] = obj[k].value;
+          }
+        }
+      });
+      obj = newObj;
+    }
+
     cb(null, {
       result: opt.raw ? sortFlatResources(onlyKeysFlat(obj)) : sortFlatResources(flatten(obj)),
       next: res.headers.get('x-next-page'),

package/package.json

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

package/sync.js

@@ -736,10 +736,17 @@ const sync = (opt, cb) => {
   opt.pathMask = opt.pathMask || `${opt.pathMaskInterpolationPrefix}language${opt.pathMaskInterpolationSuffix}${path.sep}${opt.pathMaskInterpolationPrefix}namespace${opt.pathMaskInterpolationSuffix}`;
   opt.languageFolderPrefix = opt.languageFolderPrefix || '';
   opt.pathMask = opt.pathMask.replace(`${opt.pathMaskInterpolationPrefix}language${opt.pathMaskInterpolationSuffix}`, `${opt.languageFolderPrefix}${opt.pathMaskInterpolationPrefix}language${opt.pathMaskInterpolationSuffix}`);
+  if (opt.overriddenOnly) {
+    opt.unpublished = true;
+  }
   if (opt.unpublished && !opt.apiKey) {
     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);