locize-cli 7.15.2 → 8.0.1

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.0.1](https://github.com/locize/locize-cli/compare/v8.0.0...v8.0.1) - 2023-04-10
+
+- update some dependencies to address security vulnerabilities in xlsx
+
+## [8.0.0](https://github.com/locize/locize-cli/compare/v7.15.2...v8.0.0) - 2023-01-18
+
+- align json format with publish format on project: To keep the same behaviour like before with default format or `json` format, now use `--format nested`. The `--format json` (the default) will now try to "guess" if a flat or a nested format should be used.
+
 ## [7.15.2](https://github.com/locize/locize-cli/compare/v7.15.1...v7.15.2) - 2023-01-06
 
 - optimize --skip-empty false handling for download command

package/README.md

@@ -66,6 +66,9 @@ locize get common title
 
 
 ## Download current published files
+
+*The CLI will use the normal [API](https://docs.locize.com/integration/api) endpoints to download the translations, so normal download charges etc. will occur.*
+
 ### Step 1: execute
 
 Add your project-id and let's go...
@@ -81,7 +84,7 @@ or
 locize download
 ```
 
-or add a format like (json, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties)
+or add a format like (json, nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties)
 
 ```sh
 locize download --project-id my-project-id-93e1-442a-ab35-24331fa294ba --ver latest --language en --namespace namespace1 --path ./backup --format android
@@ -98,6 +101,10 @@ An example on how this could look like can be seen in [this tutorial](https://gi
 
 **⚠️ Since the remote source are the published translations, make sure the desired version is set to auto publish mode. Alternatively use the `--unpublished true` argument (this will generate [private downloads costs](https://docs.locize.com/integration/api#fetch-filter-the-unpublished-namespace-resources)). ⚠️**
 
+*The CLI will use the normal [API](https://docs.locize.com/integration/api) endpoints, so normal modification and download charges etc. will occur.*
+
+*If you need to change or remove multiple keys, please do NOT execute the sync command after each individual key change, but make the changes all together and then execute the sync command once.*
+
 ### Step 1: Go near to your translation files
 
 ```sh
@@ -126,7 +133,7 @@ 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, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties)
+or add a format like (json, nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties)
 
 ```sh
 locize sync --api-key my-api-key-d9de-4f55-9855-a9ef0ed44672 --project-id my-project-id-93e1-442a-ab35-24331fa294ba --format android
@@ -184,7 +191,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, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties)
+or add a format like (json, nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties)
 
 ```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

@@ -231,7 +231,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; [flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties])', 'json')
+  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties])', '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}}`)
@@ -357,7 +357,7 @@ program
   .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('-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; [flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties])', 'json')
+  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties])', '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')
@@ -460,7 +460,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; [flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties])', 'json')
+  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties])', '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')
@@ -679,7 +679,7 @@ program
   .command('format [fileOrDirectory]')
   .alias('ft')
   .description('format local files')
-  .option('-f, --format <json>', 'File format of namespaces (default: json; [flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties])', 'json')
+  .option('-f, --format <json>', 'File format of namespaces (default: json; [nested, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, yaml-rails, yaml-nested, csv, xlsx, po, strings, resx, fluent, tmx, laravel, properties])', '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

@@ -30,6 +30,13 @@ const convertToDesiredFormat = (
   const isEmpty = !data || Object.keys(data).length === 0;
   try {
     if (opt.format === 'json') {
+      try {
+        data = unflatten(data, true);
+      } catch (err) {}
+      cb(null, JSON.stringify(data, null, 2));
+      return;
+    }
+    if (opt.format === 'nested') {
       try {
         data = unflatten(data);
       } catch (err) {}

package/convertToFlatFormat.js

@@ -22,7 +22,7 @@ const convertToFlatFormat = (opt, data, lng, cb) => {
     lng = undefined;
   }
   try {
-    if (opt.format === 'json' || opt.format === 'flat') {
+    if (opt.format === 'json' || opt.format === 'nested' || opt.format === 'flat') {
       const dataString = data.toString().trim();
       if (dataString[0] !== '{' && dataString[0] !== '[') {
         return cb(new Error(`Not a valid json file: Content starts with "${dataString[0]}" but should start with "{"`));

package/formats.js

@@ -1,5 +1,5 @@
 const fileExtensionsMap = {
-  '.json': ['json', 'flat'],
+  '.json': ['json', 'nested', 'flat'],
   '.po': ['po', 'gettext', 'po_i18next', 'gettext_i18next'],
   '.xml': ['android'],
   '.strings': ['strings'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locize-cli",
-  "version": "7.15.2",
+  "version": "8.0.1",
   "description": "locize cli to import locales",
   "main": "index.js",
   "bin": {
@@ -14,13 +14,13 @@
     "colors": "1.4.0",
     "commander": "9.5.0",
     "csvjson": "5.1.0",
-    "diff": "5.1.0",
-    "dotenv": "16.3.1",
+    "diff": "5.2.0",
+    "dotenv": "16.4.5",
     "flat": "5.0.2",
-    "fluent_conv": "3.2.0",
-    "gettext-converter": "1.2.4",
+    "fluent_conv": "3.3.0",
+    "gettext-converter": "1.3.0",
     "https-proxy-agent": "5.0.1",
-    "ini": "4.1.1",
+    "ini": "4.1.2",
     "js-yaml": "4.1.0",
     "laravelphp": "2.0.4",
     "lodash.clonedeep": "4.5.0",
@@ -30,8 +30,8 @@
     "rimraf": "3.0.2",
     "strings-file": "0.0.5",
     "tmexchange": "2.0.5",
-    "xliff": "6.2.0",
-    "xlsx": "https://cdn.sheetjs.com/xlsx-0.20.0/xlsx-0.20.0.tgz"
+    "xliff": "6.2.1",
+    "xlsx": "https://cdn.sheetjs.com/xlsx-0.20.2/xlsx-0.20.2.tgz"
   },
   "devDependencies": {
     "eslint": "8.56.0",

package/unflatten.js

@@ -1,8 +1,13 @@
-module.exports = (data) => {
+module.exports = (data, testNatural) => {
   const result = {};
   const shouldConvertArray = {};
-  for (var i in data) {
-    const keys = i.split('.');
+  for (const i in data) {
+    let keys = [];
+    if (testNatural && /( |,|\?)/.test(i)) {
+      keys = [i];
+    } else {
+      keys = i.split('.');
+    }
     keys.reduce((r, e, j) => {
       const isNumber = !isNaN(Number(keys[j + 1]));
       const hasLeadingZero = isNumber && keys[j + 1].length > 1 && keys[j + 1][0] === '0';