auto-lang 1.0.2 → 1.0.5

package/README.md

@@ -1,19 +1,22 @@
 # Auto Lang
 
-Generate translation files for multiple languages
+Generate translation files for multiple languages.
+
+Write once for a single language and automatically get translated json files for others.
 ## Installation
-### npm
-```npm i auto-lang```
-### yarn
-```yarn install auto-lang```
+### Using npm
+    $ npm install auto-lang
+### Using yarn
+    $ yarn add auto-lang
 
 ## Usage
 Run `auto-lang [options]`
 
 ### Options
 
-    -V, --version       output the version number
-    -f, --from <lang>   language to translate from
-    -t, --to <lang...>  Languages to translate to (Seperated by space)
-    -g, --gen-types     generate typescript declaration file
-    -h, --help          display help for command
+    -V, --version          output the version number
+    -f, --from <lang>      language to translate from
+    -t, --to <lang...>     languages to translate to (seperated by space)
+    -d, --dir <directory>  directory containing the language files (default: "translations")
+    -g, --gen-type <lang>  generate types from language file
+    -h, --help             display help for command

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "auto-lang",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "description": "Automatically create language json files for internationalization",
   "main": "./src/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "keywords": ["Internationalization", "node", "i18n"],
+  "keywords": ["Internationalization", "node", "i18n", "translate"],
   "author": "Lafen Lesley <lesleytech6@gmail.com> (https://github.com/lesleytech/)",
   "homepage": "https://github.com/lesleytech/auto-lang#readme",
   "repository": {

package/src/index.js

@@ -11,6 +11,10 @@ import JsonToTS from 'json-to-ts';
 import prettier from 'prettier';
 
 import { Logger } from './utils/Logger.mjs';
+import chalk from 'chalk';
+import { validateOptions } from './utils/validation.mjs';
+
+const APP_VERSION = '1.0.5';
 
 const program = new Command();
 const nodeMajVer = parseInt(process.version.substring(1).split('.')[0]);
@@ -23,24 +27,28 @@ if (nodeMajVer < 14) {
 
 program
   .name('auto-lang')
-  .description('Generate translation files for multiple languages')
-  .version('1.0.2')
-  .requiredOption('-f, --from <lang>', 'language to translate from')
-  .requiredOption(
+  .description('Generate translation files for multiple languages (i18n)')
+  .version(APP_VERSION)
+  .option('-f, --from <lang>', 'language to translate from')
+  .option(
     '-t, --to <lang...>',
-    'Languages to translate to (Seperated by space)'
+    'languages to translate to (seperated by space)'
+  )
+  .option(
+    '-d, --dir <directory>',
+    'directory containing the language files',
+    'translations'
   )
-  .option('-g, --gen-types', 'generate typescript declaration file')
+  .option('-g, --gen-type <lang>', 'generate types from language file')
   .parse();
 
-const { from, to, genTypes } = program.opts();
-
-const inputFile = path.join(process.cwd(), 'translations', `${from}.json`);
+const { from, to, genType, inputFile, genTypeFile, dir } = validateOptions(
+  program.opts()
+);
 
-if (!existsSync(inputFile)) {
-  Logger.error(`File 'translations/${from}.json' not found`);
-  exit(1);
-}
+const inputJson = JSON.parse(
+  await fs.readFile(inputFile, { encoding: 'utf-8' })
+);
 
 async function makeTranslatedCopy(obj1, obj2, options) {
   for (let [key, value] of Object.entries(obj1)) {
@@ -48,12 +56,18 @@ async function makeTranslatedCopy(obj1, obj2, options) {
       obj2[key] = {};
       await makeTranslatedCopy(value, obj2[key], options);
     } else {
-      obj2[key] = await translate(value, { from, to: options.to });
+      try {
+        obj2[key] = await translate(value, { from, to: options.to });
+      } catch (err) {
+        console.log('\n');
+        Logger.error(err.message);
+        exit(1);
+      }
     }
   }
 }
 
-const getTranslation = (inputJson, language) =>
+const getTranslation = (language) =>
   new Promise(async (resolve, reject) => {
     const translatedObj = {};
 
@@ -62,58 +76,58 @@ const getTranslation = (inputJson, language) =>
     resolve(JSON.stringify(translatedObj, null, 4));
   });
 
-async function createDeclarationFile(json) {
-  const spinner = createSpinner('Creating typescript declaration file').start();
+async function createDeclarationFile() {
+  const spinner = createSpinner('Creating language type file').start();
 
-  const interfaces = JsonToTS(json, { rootName: 'GlobalTranslation' });
-  const typesDir = path.join(process.cwd(), 'translations', 'types');
+  const interfaces = JsonToTS(inputJson, { rootName: 'GlobalTranslationType' });
+  const typesDir = path.join(process.cwd(), dir, 'types');
 
   if (!existsSync(typesDir)) {
     fs.mkdir(typesDir);
   }
 
-  const declarationFile = path.join(typesDir, 'index.d.ts');
+  const declarationFile = path.join(typesDir, 'index.ts');
 
   const result = `
     /* eslint-disable no-var */
 
-    declare global {
-      ${interfaces[0]}\n\n
-    }
-
-    ${interfaces.slice(1).join('\n\n')}
+    type NestedKeyOf<ObjectType extends object> = {
+    [Key in keyof ObjectType & string]: ObjectType[Key] extends object
+      ? // @ts-ignore
+        \`$\{Key}.$\{NestedKeyOf<ObjectType[Key]>}\`
+      : \`$\{Key}\`
+    }[keyof ObjectType & string]
 
-    export {};
+    export type GlobalTranslation = NestedKeyOf<GlobalTranslationType>;
+    
+    ${interfaces.join('\n\n')}
   `;
 
   const formattedResult = prettier.format(result, { parser: 'typescript' });
 
   fs.writeFile(declarationFile, formattedResult);
-  spinner.success({ text: 'TS declaration file created' });
+  spinner.success({ text: 'Language type file created' });
 }
 
-async function translateFile(inputFile) {
-  const inputJson = JSON.parse(
-    await fs.readFile(inputFile, { encoding: 'utf-8' })
-  );
+async function translateFile() {
   let spinner, langFile, tranlatedJson;
 
   for (let lang of to) {
-    langFile = path.join(process.cwd(), 'translations', `${lang}.json`);
+    langFile = path.join(process.cwd(), dir, `${lang}.json`);
     spinner = createSpinner(`Translating to ${lang}...`).start();
 
-    tranlatedJson = await getTranslation(inputJson, lang);
+    tranlatedJson = await getTranslation(lang);
     // await sleep(1000);
     await fs.writeFile(langFile, tranlatedJson);
 
     spinner.success({ text: `Complete` });
   }
-
-  return inputJson;
 }
 
-const json = await translateFile(inputFile);
+if (from && to) {
+  await translateFile();
+}
 
-if (genTypes) {
-  await createDeclarationFile(json);
+if (genType) {
+  await createDeclarationFile();
 }

package/src/test.ts

@@ -0,0 +1,3 @@
+import { GlobalTranslation } from './translations/types';
+
+const t = (key: GlobalTranslation) => {};

package/src/utils/validation.mjs

@@ -0,0 +1,37 @@
+import chalk from 'chalk';
+import { existsSync } from 'fs';
+import path from 'path';
+
+import { Logger } from './Logger.mjs';
+
+export function validateOptions(opts) {
+  if (!Object.keys(opts).length) {
+    Logger.error(`Invalid arguments. Use ${chalk.gray('--help')} for usage`);
+
+    exit(1);
+  }
+
+  const { to, from, dir, genType } = opts;
+
+  if ((from && !to) || (to && !from)) {
+    Logger.error(
+      `${chalk.gray('--from')} and ${chalk.gray('--to')} are dependent options`
+    );
+    exit(1);
+  }
+
+  const inputFile = path.join(process.cwd(), dir, `${from}.json`);
+  const genTypeFile = path.join(process.cwd(), dir, `${genType}.json`);
+
+  if (!existsSync(inputFile) && from) {
+    Logger.error(`File "${inputFile}" not found`);
+    exit(1);
+  }
+
+  if (!existsSync(genTypeFile) && genType) {
+    Logger.error(`File "${genType}" not found`);
+    exit(1);
+  }
+
+  return { ...opts, inputFile, genTypeFile };
+}