locize-cli 7.13.1 → 7.14.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/).
 
+## [7.14.0](https://github.com/locize/locize-cli/compare/v7.13.2...v7.14.0) - 2023-03-11
+
+- support for .env file [#83](https://github.com/locize/locize-cli/pull/83)
+
+## [7.13.2](https://github.com/locize/locize-cli/compare/v7.13.1...v7.13.2) - 2023-01-24
+
+- update dependencies to fix reported vulnerabilities [#81](https://github.com/locize/locize-cli/issues/81)
+
 ## [7.13.1](https://github.com/locize/locize-cli/compare/v7.13.0...v7.13.1) - 2022-12-08
 
 - optimize migrate command

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 locize
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -86,6 +86,10 @@ or add a format like (json, flat, xliff2, xliff12, xlf2, xlf12, android, yaml, y
 locize download --project-id my-project-id-93e1-442a-ab35-24331fa294ba --ver latest --language en --namespace namespace1 --path ./backup --format android
 ```
 
+### GitHub Action
+
+There's also a [GitHub Action](https://github.com/marketplace/actions/locize-download) that handles the download in your CI/CD workflow.
+
 
 ## Synchronize locize with your repository (or any other local directory)
 By using the sync command, you can keep your existing code setup and synchronize the translations with locize.
@@ -311,7 +315,7 @@ or
 locize add common title "the title of my cool app"
 ```
 
-### Additionally if these environment variables are set:
+### Additionally if these environment variables can be set:
 
 - LOCIZE_PROJECTID or LOCIZE_PID
 - LOCIZE_API_KEY or LOCIZE_KEY
@@ -322,4 +326,6 @@ they will also be considered with this priority:
 
 1. argument as part of command (i.e. locize sync --project-id ...)
 2. config value in .locize file (i.e. projectId = ...)
-3. env variable (i.e. LOCIZE_PROJECTID)
+3. env variable (i.e. LOCIZE_PROJECTID) / or .env file
+
+In case you have a .env file in the current working directory, it will be used to load environment variables from that .env file into process.env.

package/bin/locize

@@ -8,8 +8,10 @@ const os = require('os');
 const url = require('url');
 const ini = require('ini');
 
-const home = path.join(os.homedir(), '.locize');
-const workingDirectory = path.join(process.cwd(), '.locize');
+const configInHome = path.join(os.homedir(), '.locize');
+const configInWorkingDirectory = path.join(process.cwd(), '.locize');
+const dotEnvFile = path.join(process.cwd(), '.env');
+if (fs.existsSync(dotEnvFile)) require('dotenv').config();
 const addPathUrl = 'https://api.locize.app/update/{{projectId}}/{{version}}/{{lng}}/{{ns}}';
 const getPathUrl = 'https://api.locize.app/{{projectId}}/{{version}}/{{lng}}/{{ns}}';
 
@@ -25,11 +27,18 @@ const deleteNamespace = require('../deleteNamespace');
 const formatFn = require('../format');
 
 var config = {};
+try {
+  config = ini.parse(fs.readFileSync(configInWorkingDirectory, 'utf-8'));
+} catch (e) {
+  try {
+    config = ini.parse(fs.readFileSync(configInHome, 'utf-8'));
+  } catch (e) {}
+}
 
 program
   .version(require('../package.json').version)
   .option('-a, --add-path <url>', `Specify the add-path url that should be used (default: ${addPathUrl})`);
-// .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${workingDirectory} or ${home})`);
+// .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`);
 
 program
   .command('migrate')
@@ -43,15 +52,11 @@ program
   .option('-L, --parse-language <true|false>', 'Parse folders as language (default: true)', 'true')
   .option('-f, --format <json>', 'File format of namespaces (default: json)', 'json')
   .option('-r, --replace <true|false>', 'This will empty the optionally existing namespace before saving the new translations. (default: false)', 'false')
-  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     const addPath = options.addPath || config.addPath || addPathUrl;
 
@@ -105,15 +110,11 @@ program
   .option('-i, --project-id <projectId>', 'The project-id that should be used')
   .option('-l, --language <lng>', 'The language that should be targeted')
   .option('-v, --ver <version>', 'The version that should be targeted (default: latest)')
-  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((namespace, key, value, options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     const apiKey = options.apiKey || config.apiKey || process.env.LOCIZE_API_KEY || process.env.LOCIZE_KEY;
     if (!apiKey) {
@@ -168,15 +169,11 @@ program
   .option('-i, --project-id <projectId>', 'The project-id that should be used')
   .option('-l, --language <lng>', 'The language that should be targeted (omitting this attribute will result in removing the key from all languages)')
   .option('-v, --ver <version>', 'The version that should be targeted (default: latest)')
-  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((namespace, key, options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     const apiKey = options.apiKey || config.apiKey || process.env.LOCIZE_API_KEY || process.env.LOCIZE_KEY;
     if (!apiKey) {
@@ -240,15 +237,11 @@ 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('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     const projectId = options.projectId || config.projectId || process.env.LOCIZE_PROJECTID || process.env.LOCIZE_PID;
     if (!projectId) {
@@ -313,15 +306,11 @@ program
   .option('-i, --project-id <projectId>', 'The project-id that should be used')
   .option('-l, --language <lng>', 'The language that should be targeted')
   .option('-v, --ver <version>', 'The version that should be targeted (default: latest)')
-  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((namespace, key, options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     const projectId = options.projectId || config.projectId || process.env.LOCIZE_PROJECTID || process.env.LOCIZE_PID;
     if (!projectId) {
@@ -383,15 +372,11 @@ program
   .option('-n, --namespace <ns>', 'The namespace that should be targeted')
   .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('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     const getPath = options.getPath || config.getPath || options.addPath || config.addPath || getPathUrl;
 
@@ -479,15 +464,11 @@ program
   .option('-R, --reference-language-only <true|false>', 'Check for changes in reference language only. (default: true)', 'true')
   .option('-l, --language <lng>', 'The language that should be targeted')
   .option('-n, --namespace <ns>', 'The namespace that should be targeted')
-  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     const getPath = options.getPath || config.getPath || options.addPath || config.addPath || getPathUrl;
 
@@ -555,15 +536,11 @@ program
   .option('-k, --api-key <apiKey>', 'The api-key that should be used')
   .option('-v, --ver <version>', 'The target version to be used to copy to (default: latest)')
   .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: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((fromVersion, options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     const apiKey = options.apiKey || config.apiKey || process.env.LOCIZE_API_KEY || process.env.LOCIZE_KEY;
     if (!apiKey) {
@@ -607,15 +584,11 @@ program
   .option('-k, --api-key <apiKey>', 'The api-key that should be used')
   .option('-v, --ver <version>', 'The version to be used to publish (default: latest)')
   .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: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     const apiKey = options.apiKey || config.apiKey || process.env.LOCIZE_API_KEY || process.env.LOCIZE_KEY;
     if (!apiKey) {
@@ -658,15 +631,11 @@ program
   .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('-v, --ver <version>', 'The version that should be targeted (default: latest)')
-  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((namespace, options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     const apiKey = options.apiKey || config.apiKey || process.env.LOCIZE_API_KEY || process.env.LOCIZE_KEY;
     if (!apiKey) {
@@ -710,15 +679,11 @@ program
   .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('-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: ${workingDirectory} or ${home})`)
+  .option('-C, --config-path <configPath>', `Specify the path to the optional locize config file (default: ${configInWorkingDirectory} or ${configInHome})`)
   .action((fileOrDirectory, options) => {
     try {
-      config = ini.parse(fs.readFileSync(options.configPath || workingDirectory, 'utf-8'));
-    } catch (e) {
-      try {
-        config = ini.parse(fs.readFileSync(options.configPath || home, 'utf-8'));
-      } catch (e) {}
-    }
+      config = ini.parse(fs.readFileSync(options.configPath)) || config;
+    } catch (e) {}
 
     fileOrDirectory = fileOrDirectory || '.';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locize-cli",
-  "version": "7.13.1",
+  "version": "7.14.0",
   "description": "locize cli to import locales",
   "main": "index.js",
   "bin": {
@@ -8,13 +8,14 @@
   },
   "dependencies": {
     "@js.properties/properties": "0.5.4",
-    "android-string-resource": "2.3.8",
+    "android-string-resource": "2.3.9",
     "async": "3.2.4",
     "cacheable-lookup": "6.1.0",
     "colors": "1.4.0",
-    "commander": "9.4.1",
+    "commander": "9.5.0",
     "csvjson": "5.1.0",
     "diff": "5.1.0",
+    "dotenv": "16.0.3",
     "flat": "5.0.2",
     "fluent_conv": "3.1.0",
     "gettext-converter": "1.2.3",
@@ -23,8 +24,8 @@
     "js-yaml": "4.1.0",
     "laravelphp": "2.0.3",
     "lodash.clonedeep": "4.5.0",
-    "mkdirp": "1.0.4",
-    "node-fetch": "2.6.7",
+    "mkdirp": "2.1.5",
+    "node-fetch": "2.6.8",
     "resx": "2.0.3",
     "rimraf": "3.0.2",
     "strings-file": "0.0.5",
@@ -33,9 +34,9 @@
     "xlsx": "0.18.5"
   },
   "devDependencies": {
-    "eslint": "8.29.0",
-    "gh-release": "6.0.4",
-    "pkg": "5.8.0"
+    "eslint": "8.36.0",
+    "gh-release": "7.0.2",
+    "pkg": "5.8.1"
   },
   "scripts": {
     "lint": "eslint .",