auto-lang 1.0.8 → 1.1.0

package/README.md

@@ -1,176 +1,177 @@
-# Auto Lang
-
-Generate translation files for multiple languages.
-
-Write once for a single language and automatically get translated json files for others.
-## Installation
-### Using npm
-    $ npm install auto-lang
-### Using yarn
-    $ yarn add auto-lang
-
-## Usage
-You could either install the package and add a script to `package.json` or use the `npx` command directly from the terminal.
-
-### 1. Using the `npx` command
-    $ npx auto-lang [options]
-
-### 2. Using a script in `package.json`
-```json
-{
-    "scripts": {
-        "gen-lang": "auto-lang [options]"
-    }
-}
-```
-
-Now, in the terminal run:
-
-    $ npm run gen-lang
-
-Or, using yarn:
-
-    $ yarn gen-lang
-
-**Note:** You can give your script any name you wish. Also, replace `[options]` with any of the options below.
-
-#### Options
-
-    -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
-
-**Note:** `<lang>` must be a valid [ISO 639-1 language code](https://localizely.com/iso-639-1-list/).
-
-### Examples
-
-These examples  assume there's a folder `translations` in the root directory the command is executed.
-
-You can also pass `--dir <directory>` to change the folder that contains your language `json` files.
-
-There is a file `en.json` in the translations folder
-
-```json
-{
-  "GENERAL": {
-    "OK": "OK",
-    "CANCEL": "Cancel",
-    "ACCEPT": "Accept",
-    "DECLINE": "Decline"
-  },
-  "GREETINGS": {
-    "HELLO": "Hello",
-    "HI": "Hi",
-    "GOOD_MORNING": "Good morning"
-  }
-}
-```
-Get translation files for French (fr) and Spanish (es).
-
-    $ npx auto-lang --from en --to fr es
-
-Two files have been created; `fr.json` and `es.json` in the `translations` folder.
-
-    +-- root
-    |   +-- translations
-    |   |   +-- en.json
-    |   |   +-- fr.json
-    |   |   +-- es.json
-
-```json
-/* fr.json */
-
-{
-  "GENERAL": {
-    "OK": "D'ACCORD",
-    "CANCEL": "Annuler",
-    "ACCEPT": "Accepter",
-    "DECLINE": "Déclin"
-  },
-  "GREETINGS": {
-    "HELLO": "Bonjour",
-    "HI": "Salut",
-    "GOOD_MORNING": "Bonjour"
-  }
-}
-```
-
-```json
-/* es.json */
-
-{
-  "GENERAL": {
-    "OK": "OK",
-    "CANCEL": "Cancelar",
-    "ACCEPT": "Aceptar",
-    "DECLINE": "Rechazar"
-  },
-  "GREETINGS": {
-    "HELLO": "Hola",
-    "HI": "Hola",
-    "GOOD_MORNING": "Buenos dias"
-  }
-}
-```
-
-If you use typescript in your project, you can generate a typescript file to use in your code.
-
-    $ npx auto-lang --gen-type en
-
-This will generate a `GlobalTranslation` type based on the structure of the `translations/en.json` file.
-
-    +-- root
-    |   +-- translations
-    |   |   +-- types
-    |   |   |   +-- index.ts
-    |   |   +-- en.json
-    |   |   +-- fr.json
-    |   |   +-- es.json
-
-```ts
-/* translations/types/index.ts */
-
-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 type GlobalTranslation = NestedKeyOf<GlobalTranslationType>;
-
-interface GlobalTranslationType {
-  GENERAL: GENERAL;
-  GREETINGS: GREETINGS;
-}
-
-interface GREETINGS {
-  HELLO: string;
-  HI: string;
-  GOOD_MORNING: string;
-}
-
-interface GENERAL {
-  OK: string;
-  CANCEL: string;
-  ACCEPT: string;
-  DECLINE: string;
-}
-
-```
-
-Now you should be able to use `GlobalTranslation` in your code.
-
-```ts
-import { GlobalTranslation } from './translations/types';
-
-const translate = (key: GlobalTranslation) => {
-  // your code
-};
-
-translate('GENERAL.ACCEPT'); // Intellisense and type check from GlobalTranslation
-
-```
+# Auto Lang
+
+Generate translation files for multiple languages.
+
+Write once for a single language and automatically get translated json files for others.
+## Installation
+### Using npm
+    $ npm install auto-lang
+### Using yarn
+    $ yarn add auto-lang
+
+## Usage
+You could either install the package and add a script to `package.json` or use the `npx` command directly from the terminal.
+
+### 1. Using the `npx` command
+    $ npx auto-lang [options]
+
+### 2. Using a script in `package.json`
+```json
+{
+    "scripts": {
+        "gen-lang": "auto-lang [options]"
+    }
+}
+```
+
+Now, in the terminal run:
+
+    $ npm run gen-lang
+
+Or, using yarn:
+
+    $ yarn gen-lang
+
+**Note:** You can give your script any name you wish. Also, replace `[options]` with any of the options below.
+
+#### Options
+
+    -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")
+    -s, --skip-existing    skip existing keys during translation
+    -g, --gen-type <lang>  generate types from language file
+    -h, --help             display help for command
+
+**Note:** `<lang>` must be a valid [ISO 639-1 language code](https://localizely.com/iso-639-1-list/).
+
+### Examples
+
+These examples  assume there's a folder `translations` in the root directory the command is executed.
+
+You can also pass `--dir <directory>` to change the folder that contains your language `json` files.
+
+There is a file `en.json` in the translations folder
+
+```json
+{
+  "GENERAL": {
+    "OK": "OK",
+    "CANCEL": "Cancel",
+    "ACCEPT": "Accept",
+    "DECLINE": "Decline"
+  },
+  "GREETINGS": {
+    "HELLO": "Hello",
+    "HI": "Hi",
+    "GOOD_MORNING": "Good morning"
+  }
+}
+```
+Get translation files for French (fr) and Spanish (es).
+
+    $ npx auto-lang --from en --to fr es
+
+Two files have been created; `fr.json` and `es.json` in the `translations` folder.
+
+    +-- root
+    |   +-- translations
+    |   |   +-- en.json
+    |   |   +-- fr.json
+    |   |   +-- es.json
+
+```json
+/* fr.json */
+
+{
+  "GENERAL": {
+    "OK": "D'ACCORD",
+    "CANCEL": "Annuler",
+    "ACCEPT": "Accepter",
+    "DECLINE": "Déclin"
+  },
+  "GREETINGS": {
+    "HELLO": "Bonjour",
+    "HI": "Salut",
+    "GOOD_MORNING": "Bonjour"
+  }
+}
+```
+
+```json
+/* es.json */
+
+{
+  "GENERAL": {
+    "OK": "OK",
+    "CANCEL": "Cancelar",
+    "ACCEPT": "Aceptar",
+    "DECLINE": "Rechazar"
+  },
+  "GREETINGS": {
+    "HELLO": "Hola",
+    "HI": "Hola",
+    "GOOD_MORNING": "Buenos dias"
+  }
+}
+```
+
+If you use typescript in your project, you can generate a typescript file to use in your code.
+
+    $ npx auto-lang --gen-type en
+
+This will generate a `GlobalTranslation` type based on the structure of the `translations/en.json` file.
+
+    +-- root
+    |   +-- translations
+    |   |   +-- types
+    |   |   |   +-- index.ts
+    |   |   +-- en.json
+    |   |   +-- fr.json
+    |   |   +-- es.json
+
+```ts
+/* translations/types/index.ts */
+
+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 type GlobalTranslation = NestedKeyOf<GlobalTranslationType>;
+
+interface GlobalTranslationType {
+  GENERAL: GENERAL;
+  GREETINGS: GREETINGS;
+}
+
+interface GREETINGS {
+  HELLO: string;
+  HI: string;
+  GOOD_MORNING: string;
+}
+
+interface GENERAL {
+  OK: string;
+  CANCEL: string;
+  ACCEPT: string;
+  DECLINE: string;
+}
+
+```
+
+Now you should be able to use `GlobalTranslation` in your code.
+
+```ts
+import { GlobalTranslation } from './translations/types';
+
+const translate = (key: GlobalTranslation) => {
+  // your code
+};
+
+translate('GENERAL.ACCEPT'); // Intellisense and type check from GlobalTranslation
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-lang",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "Automatically create language json files for internationalization",
   "main": "./src/index.js",
   "scripts": {

package/src/index.js

@@ -1,131 +1,136 @@
-#!/usr/bin/env node
-
-import path from 'path';
-import { promises as fs } from 'fs';
-import { existsSync } from 'fs';
-import { Command } from 'commander';
-import { exit } from 'process';
-import { createSpinner } from 'nanospinner';
-import translate from 'translate';
-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.8';
-
-const program = new Command();
-const nodeMajVer = parseInt(process.version.substring(1).split('.')[0]);
-
-if (nodeMajVer < 14) {
-  Logger.error(`Node version >= 14.x.x is required`);
-
-  process.exit(1);
-}
-
-program
-  .name('auto-lang')
-  .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)'
-  )
-  .option(
-    '-d, --dir <directory>',
-    'directory containing the language files',
-    'translations'
-  )
-  .option('-g, --gen-type <lang>', 'generate types from language file')
-  .parse();
-
-const { from, to, genType, inputFile, genTypeFile, dir } = validateOptions(
-  program.opts()
-);
-
-const inputJson = JSON.parse(
-  await fs.readFile(from ? inputFile : genTypeFile, { encoding: 'utf-8' })
-);
-
-async function makeTranslatedCopy(obj1, obj2, options) {
-  for (let [key, value] of Object.entries(obj1)) {
-    if (typeof value === 'object') {
-      obj2[key] = {};
-      await makeTranslatedCopy(value, obj2[key], options);
-    } else {
-      try {
-        obj2[key] = await translate(value, { from, to: options.to });
-      } catch (err) {
-        console.log('\n');
-        Logger.error(err.message);
-        process.exit(1);
-      }
-    }
-  }
-}
-
-const getTranslation = (language) =>
-  new Promise(async (resolve, reject) => {
-    const translatedObj = {};
-
-    await makeTranslatedCopy(inputJson, translatedObj, { to: language });
-
-    resolve(JSON.stringify(translatedObj, null, 4));
-  });
-
-async function createDeclarationFile() {
-  const spinner = createSpinner('Creating language type file').start();
-
-  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.ts');
-
-  const result = `
-    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 type GlobalTranslation = NestedKeyOf<GlobalTranslationType>;
-    
-    ${interfaces.join('\n\n')}
-  `;
-
-  const formattedResult = prettier.format(result, { parser: 'typescript' });
-
-  fs.writeFile(declarationFile, formattedResult);
-  spinner.success({ text: 'Language type file created' });
-}
-
-async function translateFile() {
-  let spinner, langFile, tranlatedJson;
-
-  for (let lang of to) {
-    langFile = path.join(process.cwd(), dir, `${lang}.json`);
-    spinner = createSpinner(`Translating to ${lang}...`).start();
-
-    tranlatedJson = await getTranslation(lang);
-    // await sleep(1000);
-    await fs.writeFile(langFile, tranlatedJson);
-
-    spinner.success({ text: `Complete` });
-  }
-}
-
-if (from && to) {
-  await translateFile();
-}
-
-if (genType) {
-  await createDeclarationFile();
-}
+#!/usr/bin/env node
+
+import path from 'path';
+import {existsSync, promises as fs} from 'fs';
+import {Command} from 'commander';
+import {createSpinner} from 'nanospinner';
+import translate from 'translate';
+import JsonToTS from 'json-to-ts';
+import prettier from 'prettier';
+
+import {Logger} from './utils/Logger.mjs';
+import {validateOptions} from './utils/validation.mjs';
+
+const APP_VERSION = '1.0.8';
+
+const program = new Command();
+const nodeMajVer = parseInt(process.version.substring(1).split('.')[0]);
+
+if (nodeMajVer < 14) {
+  Logger.error(`Node version >= 14.x.x is required`);
+
+  process.exit(1);
+}
+
+program
+  .name('auto-lang')
+  .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)'
+  )
+  .option(
+    '-d, --dir <directory>',
+    'directory containing the language files',
+    'translations'
+  )
+  .option('-s, --skip-existing', 'skip existing keys during translation')
+  .option('-g, --gen-type <lang>', 'generate types from language file')
+  .parse();
+
+const { from, to, genType, inputFile, genTypeFile, dir, skipExisting } = validateOptions(
+  program.opts()
+);
+
+const inputJson = JSON.parse(
+  await fs.readFile(from ? inputFile : genTypeFile, { encoding: 'utf-8' })
+);
+
+async function makeTranslatedCopy(obj1, obj2, options) {
+  for (let [key, value] of Object.entries(obj1)) {
+    if (typeof value === 'object') {
+      obj2[key] = {};
+      await makeTranslatedCopy(value, obj2[key], options);
+    } else {
+      try {
+        if(!(obj2[key] && skipExisting)) obj2[key] = await translate(value, { from, to: options.to });
+      } catch (err) {
+        console.log('\n');
+        Logger.error(err.message);
+        process.exit(1);
+      }
+    }
+  }
+}
+
+const getTranslation = (language) =>
+  new Promise(async (resolve, reject) => {
+    let translatedObj = {};
+    const outputFile = path.join(process.cwd(), dir, `${language}.json`);
+
+    if(existsSync(outputFile)) {
+      translatedObj = JSON.parse(
+          await fs.readFile(outputFile, { encoding: 'utf-8' })
+      );
+    }
+
+    await makeTranslatedCopy(inputJson, translatedObj, { to: language });
+
+    resolve(JSON.stringify(translatedObj, null, 4));
+  });
+
+async function createDeclarationFile() {
+  const spinner = createSpinner('Creating language type file').start();
+
+  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.ts');
+
+  const result = `
+    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 type GlobalTranslation = NestedKeyOf<GlobalTranslationType>;
+    
+    ${interfaces.join('\n\n')}
+  `;
+
+  const formattedResult = prettier.format(result, { parser: 'typescript' });
+
+  fs.writeFile(declarationFile, formattedResult);
+  spinner.success({ text: 'Language type file created' });
+}
+
+async function translateFile() {
+  let spinner, langFile, tranlatedJson;
+
+  for (let lang of to) {
+    langFile = path.join(process.cwd(), dir, `${lang}.json`);
+    spinner = createSpinner(`Translating to ${lang}...`).start();
+
+    tranlatedJson = await getTranslation(lang);
+    // await sleep(1000);
+    await fs.writeFile(langFile, tranlatedJson);
+
+    spinner.success({ text: `Complete` });
+  }
+}
+
+if (from && to) {
+  await translateFile();
+}
+
+if (genType) {
+  await createDeclarationFile();
+}

package/src/utils/Logger.mjs

@@ -1,7 +1,7 @@
-import chalk from 'chalk';
-
-export class Logger {
-  static error(message) {
-    console.log(`${chalk.bgRed(' ERROR ')} ${message}`);
-  }
-}
+import chalk from 'chalk';
+
+export class Logger {
+  static error(message) {
+    console.log(`${chalk.bgRed(' ERROR ')} ${message}`);
+  }
+}

package/src/utils/validation.mjs

@@ -1,37 +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`);
-
-    process.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`
-    );
-    process.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`);
-    process.exit(1);
-  }
-
-  if (!existsSync(genTypeFile) && genType) {
-    Logger.error(`File "${genTypeFile}" not found`);
-    process.exit(1);
-  }
-
-  return { ...opts, inputFile, genTypeFile };
-}
+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`);
+
+    process.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`
+    );
+    process.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`);
+    process.exit(1);
+  }
+
+  if (!existsSync(genTypeFile) && genType) {
+    Logger.error(`File "${genTypeFile}" not found`);
+    process.exit(1);
+  }
+
+  return { ...opts, inputFile, genTypeFile };
+}