auto-lang 1.0.5 → 1.0.6

package/README.md

@@ -10,13 +10,159 @@ Write once for a single language and automatically get translated json files for
     $ yarn add auto-lang
 
 ## Usage
-Run `auto-lang [options]`
+You could either install the package and add a script to `package.json` or use the `npx` command directly from the terminal.
 
-### Options
+### 1. Using the `npx` command
+    $ npx auto-lang [options]
+
+### 2. Using a script in `package.json`
+
+```json:
+    {
+        "scripts": {
+            "gen-lang": "auto-lang [options]"
+        }
+    }
+```
+
+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
+    -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.5",
+  "version": "1.0.6",
   "description": "Automatically create language json files for internationalization",
   "main": "./src/index.js",
   "scripts": {

package/src/index.js

@@ -14,7 +14,7 @@ import { Logger } from './utils/Logger.mjs';
 import chalk from 'chalk';
 import { validateOptions } from './utils/validation.mjs';
 
-const APP_VERSION = '1.0.5';
+const APP_VERSION = '1.0.6';
 
 const program = new Command();
 const nodeMajVer = parseInt(process.version.substring(1).split('.')[0]);
@@ -22,7 +22,7 @@ const nodeMajVer = parseInt(process.version.substring(1).split('.')[0]);
 if (nodeMajVer < 14) {
   Logger.error(`Node version >= 14.x.x is required`);
 
-  exit(1);
+  process.exit(1);
 }
 
 program
@@ -47,7 +47,7 @@ const { from, to, genType, inputFile, genTypeFile, dir } = validateOptions(
 );
 
 const inputJson = JSON.parse(
-  await fs.readFile(inputFile, { encoding: 'utf-8' })
+  await fs.readFile(from ? inputFile : genTypeFile, { encoding: 'utf-8' })
 );
 
 async function makeTranslatedCopy(obj1, obj2, options) {
@@ -61,7 +61,7 @@ async function makeTranslatedCopy(obj1, obj2, options) {
       } catch (err) {
         console.log('\n');
         Logger.error(err.message);
-        exit(1);
+        process.exit(1);
       }
     }
   }
@@ -89,8 +89,6 @@ async function createDeclarationFile() {
   const declarationFile = path.join(typesDir, 'index.ts');
 
   const result = `
-    /* eslint-disable no-var */
-
     type NestedKeyOf<ObjectType extends object> = {
     [Key in keyof ObjectType & string]: ObjectType[Key] extends object
       ? // @ts-ignore

package/src/utils/validation.mjs

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

package/src/test.ts

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