locize-cli 8.7.0 → 9.0.0

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/).
 
+## [9.0.0](https://github.com/locize/locize-cli/compare/v8.7.1...v9.0.0) - 2025-04-03
+
+- the format `yaml-rails-ns`/`yml-rails-ns` is the old `yaml-rails`/`yml-rails`
+- `yaml-rails`/`yml-rails` does not scope the yaml content with the namespace anymore => use `yaml-rails-ns`/`yml-rails-ns` instead
+
+## [8.7.1](https://github.com/locize/locize-cli/compare/v8.7.0...v8.7.1) - 2025-04-02
+
+- make generated files POSIX compliant, addresses [107](https://github.com/locize/locize-cli/issues/107)
+
 ## [8.7.0](https://github.com/locize/locize-cli/compare/v8.6.2...v8.7.0) - 2025-03-20
 
 - intruduce xcstrings format [106](https://github.com/locize/locize-cli/issues/106)

package/README.md

@@ -84,7 +84,11 @@ or
 locize download
 ```
 
-or add a format like (json, nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings)
+or add a format like (json, nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-rails-ns, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings)
+
+*Special formats:*
+- use yaml-rails to have the language code in the resulting yaml as root object
+- use yaml-rails-ns to have the namespace in the resulting yaml as first key scope
 
 ```sh
 locize download --project-id my-project-id-93e1-442a-ab35-24331fa294ba --ver latest --language en --namespace namespace1 --path ./backup --format android
@@ -133,7 +137,11 @@ Add your api-key and your project-id and let's go...
 locize sync --api-key my-api-key-d9de-4f55-9855-a9ef0ed44672 --project-id my-project-id-93e1-442a-ab35-24331fa294ba
 ```
 
-or add a format like (json, nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings)
+or add a format like (json, nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-rails-ns, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings)
+
+*Special formats:*
+- use yaml-rails to have the language code in the resulting yaml as root object
+- use yaml-rails-ns to have the namespace in the resulting yaml as first key scope
 
 ```sh
 locize sync --api-key my-api-key-d9de-4f55-9855-a9ef0ed44672 --project-id my-project-id-93e1-442a-ab35-24331fa294ba --format android
@@ -158,9 +166,10 @@ Navigate to your locize project and check the results => [www.locize.app](https:
 
 ## Push missing keys to locize from your repository (or any other local directory)
 This is useful, when i.e. using [i18next-scanner](https://github.com/i18next/i18next-scanner), like described [here](https://github.com/locize/i18next-locize-backend/issues/315#issuecomment-586967039).
-The save-missing command uses the [missing API](https://www.locize.com/docs/api#missing-translations) and the sync command uses the [update API](https://www.locize.com/docs/api#update-remove-translations)
+The save-missing command uses the [missing API](https://www.locize.com/docs/api#missing-translations) and the sync command uses the [update API](https://www.locize.com/docs/api#update-remove-translations).
 So, if you want to save new keys (that does not exist in locize), the save-missing command is the better choice.
 Doing so, you can then for example make use of the “created by missing API" filter in the locize UI.
+Also, using this save-missing command does not generate extra modification costs.
 
 But if you need to update existing keys, the sync command is the correct choice.
 
@@ -192,7 +201,7 @@ Add your api-key and your project-id and let's go...
 locize save-missing --api-key my-api-key-d9de-4f55-9855-a9ef0ed44672 --project-id my-project-id-93e1-442a-ab35-24331fa294ba
 ```
 
-or add a format like (json, nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings)
+or add a format like (json, nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-rails-ns, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings)
 
 ```sh
 locize save-missing --api-key my-api-key-d9de-4f55-9855-a9ef0ed44672 --project-id my-project-id-93e1-442a-ab35-24331fa294ba --format android

package/bin/locize

@@ -232,7 +232,7 @@ program
   .option('-p, --path <path>', `Specify the path that should be used (default: ${process.cwd()})`, process.cwd())
   .option('-g, --get-path <url>', `Specify the get-path url that should be used (default: ${getPathUrl})`)
   .option('-k, --api-key <apiKey>', 'The api-key that should be used')
-  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings])', 'json')
+  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-rails-ns, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings])', 'json')
   .option('-s, --skip-empty <true|false>', 'Skips to download empty files (default: true)', 'true')
   .option('-P, --language-folder-prefix <prefix>', 'This will be added as a local folder name prefix in front of the language.', '')
   .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}}`)
@@ -361,7 +361,7 @@ program
   .option('-p, --path <path>', `Specify the path that should be used (default: ${process.cwd()})`, process.cwd())
   .option('-B, --backup-deleted-path <path>', 'Saves the segments that will be deleted in this path')
   .option('-A, --auto-create-path <true|false>', 'This will automatically make sure the --path is created. (default: true)', 'true')
-  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings])', 'json')
+  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-rails-ns, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings])', 'json')
   .option('-s, --skip-empty <true|false>', 'Skips to download empty files (default: false)', 'false')
   .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')
@@ -472,7 +472,7 @@ program
   .option('-i, --project-id <projectId>', 'The project-id that should be used')
   .option('-v, --ver <version>', 'Found namespaces will be matched to this version (default: latest)')
   .option('-p, --path <path>', `Specify the path that should be used (default: ${process.cwd()})`, process.cwd())
-  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings])', 'json')
+  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-rails-ns, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings])', 'json')
   .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')
@@ -695,7 +695,7 @@ program
   .command('format [fileOrDirectory]')
   .alias('ft')
   .description('format local files')
-  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings])', 'json')
+  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-rails-ns, yaml-nested, yml, yml-rails, yml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties, xcstrings])', 'json')
   .option('-l, --reference-language <lng>', 'Some format conversions need to know the reference language.', 'en')
   .option('-d, --dry <true|false>', 'Dry run (default: false)', 'false')
   .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)

package/convertToDesiredFormat.js

@@ -161,11 +161,21 @@ const convertToDesiredFormat = (
     ) {
       if (isEmpty) return cb(null, '');
       var newData = {};
-      newData[lng] = {};
-      newData[lng][namespace] = shouldUnflatten(data) ? unflatten(data) : data;
+      newData[lng] = shouldUnflatten(data) ? unflatten(data) : data;
       cb(null, jsyaml.dump(removeUndefinedFromArrays(newData)));
       return;
     }
+    if (
+      opt.format === 'yaml-rails-ns' ||
+      opt.format === 'yml-rails-ns'
+    ) {
+      if (isEmpty) return cb(null, '');
+      var newDataNs = {};
+      newDataNs[lng] = {};
+      newDataNs[lng][namespace] = shouldUnflatten(data) ? unflatten(data) : data;
+      cb(null, jsyaml.dump(removeUndefinedFromArrays(newDataNs)));
+      return;
+    }
     if (opt.format === 'android') {
       js2asr(flatten(data), cb);
       return;

package/convertToFlatFormat.js

@@ -141,13 +141,28 @@ const convertToFlatFormat = (opt, data, lng, cb) => {
       opt.format === 'yml-rails'
     ) {
       const d = data.toString();
-      if (!d || d === '') return cb(null, {});
+      if (!d || d.trim() === '') return cb(null, {});
       const jsObj = jsyaml.load(d);
       cb(
         null,
         flatten(
-          jsObj[Object.keys(jsObj)[0]][
-            Object.keys(jsObj[Object.keys(jsObj)[0]])[0]
+          jsObj[Object.keys(jsObj)[0]]
+        )
+      );
+      return;
+    }
+    if (
+      opt.format === 'yaml-rails-ns' ||
+      opt.format === 'yml-rails-ns'
+    ) {
+      const dn = data.toString();
+      if (!dn || dn.trim() === '') return cb(null, {});
+      const jsObjn = jsyaml.load(dn);
+      cb(
+        null,
+        flatten(
+          jsObjn[Object.keys(jsObjn)[0]][
+            Object.keys(jsObjn[Object.keys(jsObjn)[0]])[0]
           ]
         )
       );

package/download.js

@@ -94,9 +94,10 @@ function handleDownload(opt, url, err, res, downloads, cb) {
               if (clb) clb(null);
             }
 
+            const fileContent = opt.format !== 'xlsx' ? (converted + '\n') : converted;
             if (!opt.version) {
               if (mkdirPath) mkdirp.sync(path.join(opt.path, version, mkdirPath));
-              fs.writeFile(path.join(opt.path, version, filledMask), converted, logAndClb);
+              fs.writeFile(path.join(opt.path, version, filledMask), fileContent, logAndClb);
               return;
             }
 
@@ -145,21 +146,22 @@ 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;
           if (!opt.version) {
             if (mkdirPath) mkdirp.sync(path.join(opt.path, version, mkdirPath));
-            fs.writeFile(path.join(opt.path, version, filledMask), converted, clb);
+            fs.writeFile(path.join(opt.path, version, filledMask), fileContent, clb);
             return;
           }
           if (!opt.language) {
             if (mkdirPath) mkdirp.sync(path.join(opt.path, mkdirPath));
-            fs.writeFile(path.join(opt.path, filledMask), converted, clb);
+            fs.writeFile(path.join(opt.path, filledMask), fileContent, clb);
             return;
           }
 
           if (filledMask.indexOf(path.sep) > 0) filledMask = filledMask.replace(opt.languageFolderPrefix + language, '');
           const parentDir = path.dirname(path.join(opt.path, filledMask));
           mkdirp.sync(parentDir);
-          fs.writeFile(path.join(opt.path, filledMask), converted, clb);
+          fs.writeFile(path.join(opt.path, filledMask), fileContent, clb);
         });
       });
     }, (err) => {
@@ -231,7 +233,8 @@ function handlePull(opt, toDownload, cb) {
           }
 
           if (mkdirPath) mkdirp.sync(path.join(opt.path, mkdirPath));
-          fs.writeFile(path.join(opt.path, filledMask), converted, logAndClb);
+          const fileContent = opt.format !== 'xlsx' ? (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 || '');
           return clb(err);
@@ -274,16 +277,17 @@ 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;
           if (!opt.language) {
             if (mkdirPath) mkdirp.sync(path.join(opt.path, mkdirPath));
-            fs.writeFile(path.join(opt.path, filledMask), converted, clb);
+            fs.writeFile(path.join(opt.path, filledMask), fileContent, clb);
             return;
           }
 
           if (filledMask.indexOf(path.sep) > 0) filledMask = filledMask.replace(opt.languageFolderPrefix + lng, '');
           const parentDir = path.dirname(path.join(opt.path, filledMask));
           mkdirp.sync(parentDir);
-          fs.writeFile(path.join(opt.path, filledMask), converted, clb);
+          fs.writeFile(path.join(opt.path, filledMask), fileContent, clb);
         });
       });
     }, (err) => {

package/format.js

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

package/formats.js

@@ -5,8 +5,8 @@ const fileExtensionsMap = {
   '.strings': ['strings'],
   '.csv': ['csv'],
   '.resx': ['resx'],
-  '.yaml': ['yaml', 'yaml-rails', 'yaml-nested'],
-  '.yml': ['yml', 'yml-rails', 'yml-nested'],
+  '.yaml': ['yaml', 'yaml-rails', 'yaml-rails-ns', 'yaml-nested'],
+  '.yml': ['yml', 'yml-rails', 'yml-rails-ns', 'yml-nested'],
   '.xlsx': ['xlsx'],
   '.xliff': ['xliff2', 'xliff12'],
   '.xlf': ['xlf2', 'xlf12'],

package/package.json

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

package/sync.js

@@ -268,7 +268,8 @@ const downloadAll = (opt, remoteLanguages, omitRef, manipulate, cb) => {
             }
             const parentDir = path.dirname(path.join(opt.path, filledMask));
             mkdirp.sync(parentDir);
-            fs.writeFile(path.join(opt.path, filledMask), converted, clb);
+            const fileContent = opt.format !== 'xlsx' ? (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 || '');
             return clb(err);
@@ -307,7 +308,8 @@ const downloadAll = (opt, remoteLanguages, omitRef, manipulate, cb) => {
             }
             const parentDir = path.dirname(path.join(opt.path, filledMask));
             mkdirp.sync(parentDir);
-            fs.writeFile(path.join(opt.path, filledMask), converted, clb);
+            const fileContent = opt.format !== 'xlsx' ? (converted + '\n') : converted;
+            fs.writeFile(path.join(opt.path, filledMask), fileContent, clb);
           });
         });
       }, cb);
@@ -487,7 +489,9 @@ const backupDeleted = (opt, ns, now) => {
     return prev;
   }, {});
   mkdirp.sync(path.join(currentBackupPath, ns.language));
-  fs.writeFileSync(path.join(currentBackupPath, ns.language, `${ns.namespace}.json`), JSON.stringify(removingRemote, null, 2));
+  const content = JSON.stringify(removingRemote, null, 2);
+  const fileContent = opt.format !== 'xlsx' ? (content + '\n') : content;
+  fs.writeFileSync(path.join(currentBackupPath, ns.language, `${ns.namespace}.json`), fileContent);
 };
 
 const handleSync = (opt, remoteLanguages, localNamespaces, cb) => {