@ttoss/i18n-cli 0.7.3 → 0.7.4

package/README.md

@@ -21,19 +21,24 @@ Add this script to your `package.json`
 ```json
 {
   "scripts": {
-    "i18n": "ttoss-i18n",
-    "i18n:extract": "ttoss-i18n --no-compile",
-    "i18n:ignore-ttoss-pkg": "ttoss-i18n --ignore-ttoss-packages"
+    "i18n": "ttoss-i18n"
   }
 }
 ```
 
+Add to your `.gitignore`:
+
+```
+i18n/compiled/
+i18n/missing/
+```
+
 ## Usage
 
 ### Extract only:
 
 ```sh
-pnpm run i18n:extract
+pnpm i18n --no-compile # ttoss-i18n --no-compile
 ```
 
 This command extracts translations from your code but doesn't compile them. And created a new path (`i18n/lang/en.json`) if doesn't exists with extracted translations. As followed below:
@@ -64,20 +69,28 @@ To translate your text, you only need to duplicate the file `i18n/lang/en.json`
 }
 ```
 
+`en` is the default language, so you don't need to create a file for it. But you need to create a file for each language you want to translate.
+
 ### Extract and compile:
 
 ```sh
-pnpm run i18n
+pnpm i18n # ttoss-i18n
 ```
 
-This command extracts translations from your code and compiles them into a usable format. And create a new path (`i18n/compiled/en.json`) if doesn't exists with compiled translations based in all of the files on path `i18n/lang`. As followed below:
+This command extracts translations from your code and compiles them into a usable format. And create a new path (`i18n/compiled/LANG.json` and `i18n/missing/LANG.json`) if doesn't exists with compiled translations based in all of the files on path `i18n/lang`. As followed below:
 
 - 📂 i18n
   - 📂 compiled
     - 📄 en.json
     - 📄 pt-BR.json
+  - 📂 lang
+    - 📄 en.json
+    - 📄 pt-BR.json
+  - 📂 missing
+    - 📄 en.json
+    - 📄 pt-BR.json
 
-#### en.json
+#### i18n/compiled/en.json
 
 ```json
 // i18n/compiled/en.json
@@ -91,7 +104,7 @@ This command extracts translations from your code and compiles them into a usabl
 }
 ```
 
-#### pt-BR.json
+#### i18n/compiled/pt-BR.json
 
 ```json
 // i18n/compiled/pt-BR.json
@@ -105,10 +118,12 @@ This command extracts translations from your code and compiles them into a usabl
 }
 ```
 
+The `i18n/missing` folder contains all the translations that are missing in the `i18n/lang/LANG.json` file, compared with `i18n/lang/en.json`. This folder is useful to know which translations are missing in your application.
+
 ### Ignoring ttoss packages:
 
 ```sh
-pnpm run i18n:ignore-ttoss-pkg
+pnpm i18n --ignore-ttoss-packages # ttoss-i18n --ignore-ttoss-packages
 ```
 
 This command extracts and compiles translations, ignoring translations from all ttoss packages, if you have them installed in your project.

package/dist/index.js

@@ -31,12 +31,13 @@ var fs = __toESM(require("fs"));
 var glob = __toESM(require("glob"));
 var path = __toESM(require("path"));
 var import_cli_lib = require("@formatjs/cli-lib");
+var import_minimist = __toESM(require("minimist"));
 var DEFAULT_DIR = "i18n";
 var EXTRACT_DIR = path.join(DEFAULT_DIR, "lang");
 var EXTRACT_FILE = path.join(EXTRACT_DIR, "en.json");
 var COMPILE_DIR = path.join(DEFAULT_DIR, "compiled");
 var MISSING_DIR = path.join(DEFAULT_DIR, "missing");
-var args = process.argv.slice(2);
+var argv = (0, import_minimist.default)(process.argv.slice(2));
 var getTtossExtractedTranslations = async () => {
   const packageJsonAsString = await fs.promises.readFile(path.join(process.cwd(), "package.json"));
   const packageJson = JSON.parse(packageJsonAsString.toString());
@@ -91,12 +92,14 @@ var getTtossExtractedTranslations = async () => {
   return ttossExtractedTranslations;
 };
 (async () => {
-  const extractedDataAsString = await (0, import_cli_lib.extract)(glob.sync("src/**/*.{ts,tsx}", {
-    ignore: ["src/**/*.test.{ts,tsx}", "src/**/*.d.ts"]
+  const pattern = argv.pattern || "src/**/*.{ts,tsx}";
+  const ignore = argv.ignore || ["src/**/*.test.{ts,tsx}", "src/**/*.d.ts"];
+  const extractedDataAsString = await (0, import_cli_lib.extract)(glob.sync(pattern, {
+    ignore
   }), {
     idInterpolationPattern: "[sha512:contenthash:base64:6]"
   });
-  const ignoreTtossPackages = args.includes("--ignore-ttoss-packages");
+  const ignoreTtossPackages = argv["ignore-ttoss-packages"];
   const ttossExtractedTranslations = await getTtossExtractedTranslations();
   const finalExtractedData = (() => {
     if (ignoreTtossPackages) {
@@ -113,7 +116,7 @@ var getTtossExtractedTranslations = async () => {
     recursive: true
   });
   await fs.promises.writeFile(EXTRACT_FILE, finalExtractedData);
-  if (args.includes("--no-compile")) {
+  if (argv["no-compile"]) {
     return;
   }
   const translations = glob.sync(EXTRACT_DIR + "/*.json");
@@ -146,7 +149,9 @@ var getTtossExtractedTranslations = async () => {
         acc[key] = extractedTranslations[key];
       }
       return acc;
-    }, {});
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    {});
     if (filename) {
       await fs.promises.writeFile(path.join(MISSING_DIR, filename), JSON.stringify(missingTranslations, null, 2));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/i18n-cli",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "author": "ttoss",
   "contributors": [
     "Pedro Arantes <arantespp@gmail.com> (https://arantespp.com)"
@@ -19,7 +19,8 @@
   ],
   "dependencies": {
     "@formatjs/cli-lib": "^6.3.3",
-    "glob": "^10.3.10"
+    "glob": "^10.3.10",
+    "minimist": "^1.2.8"
   },
   "devDependencies": {
     "tsup": "^8.0.1",