i18nexus-cli 1.0.0 → 2.1.0

package/README.md

@@ -9,7 +9,7 @@
 ## Who is this CLI meant for?
 
 - Developers using SSR/SSG or libraries such as [next-i18next](https://github.com/isaachinman/next-i18next)
-- Developers who prefer to bundle their translation files with their project
+- Developers who prefer to bundle their translation files with their app
 
 The primary motivation for this CLI is to ease i18nexus integration with SSR/SSG frameworks such as NextJS. It is the best way to integrate i18nexus with [next-i18next](https://github.com/isaachinman/next-i18next).
 
@@ -47,21 +47,23 @@ If you wish to download your files to a different directory, you can use the `--
 
 `i18nexus pull`
 
-| Option             | Default value      | Required? |
-| ------------------ | ------------------ | --------- |
-| `--apiKey` or `-k` |                    | yes       |
-| `--path` or `-p`   | `./public/locales` |           |
-| `--ver` or `-v`    | `latest`           |           |
-| `--clean`          | `false`            |           |
+| Option              | Default value      |
+| ------------------- | ------------------ |
+| `--api-key` or `-k` |                    |
+| `--path` or `-p`    | `./public/locales` |
+| `--ver` or `-v`     | `latest`           |
+| `--clean`           | `false`            |
 
-`--apiKey`
-Your project API key
+#### Details
+
+`--api-key`
+Your project API key (Can also be set using environment variable `I18NEXUS_API_KEY`)
 
 `--path`
 The path to the destination folder in which translation files will be downloaded
 
 `--ver`
-The version of your project's translations to be downloaded
+The version of your project's translations to be downloaded (Can also be set using environment variable `I18NEXUS_VERSION`)
 
 `--clean`
-Remove and rebuild destination folder before download
+Before download, clears your destination folder specified in --path. As a safety precaution, this only deletes folders with names that match a simple language code regex. You should still ensure you are not storing any files in your destination folder that you do not want deleted.

package/bin/index.js

@@ -4,18 +4,28 @@ const pkg = require('../package.json');
 const program = require('commander');
 const pull = require('../pull');
 
+// Using Next's env variable loader because
+// Next supports more than just one .env file
+const { loadEnvConfig } = require('@next/env');
+
+loadEnvConfig(process.cwd());
+
 program.version(pkg.version);
 
 program
   .command('pull')
   .description('Download all translations as .json files')
-  .requiredOption('-k, --api-key <apiKey>', 'The API key for your project')
-  .option(
+  .requiredOption(
+    '-k, --api-key <apiKey>',
+    'The API key for your project',
+    process.env.I18NEXUS_API_KEY
+  )
+  .requiredOption(
     '-v, --ver <version>',
     'The version of the translations to be downloaded.',
-    'latest'
+    process.env.I18NEXUS_VERSION || 'latest'
   )
-  .option(
+  .requiredOption(
     '-p, --path <path>',
     'The path to the destination folder in which translation files will be downloaded',
     `${process.cwd()}/public/locales`
@@ -26,11 +36,9 @@ program
     false
   )
   .action(options => {
-    console.log(options.clean, typeof options.clean);
-
     pull({
-      apiKey: options.apiKey || process.env.I18NEXUS_API_KEY,
-      version: options.ver || process.env.I18NEXUS_VERSION,
+      apiKey: options.apiKey,
+      version: options.ver,
       path: options.path,
       clean: options.clean
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18nexus-cli",
-  "version": "1.0.0",
+  "version": "2.1.0",
   "description": "Command line interface (CLI) for accessing the i18nexus API",
   "main": "index.js",
   "bin": {
@@ -14,8 +14,10 @@
   "author": "i18nexus",
   "license": "MIT",
   "dependencies": {
+    "@next/env": "^11.0.1",
     "colors": "^1.4.0",
     "commander": "^7.2.0",
-    "node-fetch": "^2.6.1"
+    "https-proxy-agent": "^5.0.0",
+    "node-fetch": "^2.6.7"
   }
 }

package/pull.js

@@ -1,6 +1,7 @@
 const fs = require('fs');
 const fetch = require('node-fetch');
 const colors = require('colors');
+const HttpsProxyAgent = require('https-proxy-agent');
 
 const handleError = async (response, usingVersion) => {
   let json, message;
@@ -24,6 +25,23 @@ const handleError = async (response, usingVersion) => {
   process.exit(1);
 };
 
+const cleanDirectory = path => {
+  if (!fs.existsSync(path)) {
+    return;
+  }
+
+  // as safety precaution, only delete folders that match regex
+  const regex = /^[a-z]{2}(-[A-Z]{2,4})?$/;
+
+  const contents = fs.readdirSync(path);
+
+  contents.forEach(name => {
+    if (regex.test(name)) {
+      fs.rmdirSync(`${path}/${name}`, { recursive: true });
+    }
+  });
+};
+
 const pull = async opt => {
   const usingVersion = opt.version !== 'latest';
 
@@ -35,7 +53,19 @@ const pull = async opt => {
 
   console.log(`Downloading translations to ${opt.path}...`);
 
-  const response = await fetch(url);
+  const proxy =
+    process.env.http_proxy ||
+    process.env.HTTP_PROXY ||
+    process.env.https_proxy ||
+    process.env.HTTPS_PROXY;
+
+  const fetchOptions = {};
+
+  if (proxy) {
+    fetchOptions.agent = new HttpsProxyAgent(proxy);
+  }
+
+  const response = await fetch(url, fetchOptions);
 
   if (response.status !== 200) {
     return handleError(response, usingVersion);
@@ -44,7 +74,7 @@ const pull = async opt => {
   const translations = await response.json();
 
   if (opt.clean) {
-    fs.rmdirSync(opt.path, { recursive: true });
+    cleanDirectory(opt.path);
   }
 
   for (let lng in translations) {