@scoutello/i18n-magic 0.14.0 → 0.15.0

package/README.md

@@ -2,7 +2,7 @@
 
 Your CLI toolkit to help you with managing your translations in your project.
 
-This currently only works for JSON based translation systems, like: [Next-Translate](https://github.com/aralroca/next-translate)
+This currently works for JSON based translation systems
 
 To use:
 
@@ -23,28 +23,31 @@ module.exports = {
   context:
     'This is a context which increases the quality of the translations by giving context to the LLM',
   // Optional configurations
-  model: 'gemini-2.0-flash-lite', // or any OpenAI/Gemini model like 'gemini-2.0-flash'
+  model: 'gemini-2.0-flash-lite', // or any OpenAI/Gemini model like 'gpt-4.1-mini'
   OPENAI_API_KEY: '.', // Alternative to using .env file
   GEMINI_API_KEY: '', // Alternative to using .env file
-  disableTranslation: false, // Set to true to skip automatic translations during the scan step. Useful if you want to sync the other languages during CI/CD for example.
+  disableTranslation: false, // Set to true to skip automatic translations during the scan step. Useful if you want to sync the other languages during CI/CD using sync.
 };
 ```
 
 You can also provide custom functions for `loadPath` and `savePath` to store translations in other systems like S3:
 
 ```js
-module.exports = {
-  // Basic configurations
-  globPatterns: ['./components/**/*.tsx', './pages/**/*.tsx', './lib/**/*.ts'],
-  locales: ['en', 'de'],
-  defaultLocale: 'de',
-  defaultNamespace: 'common',
-  namespaces: ['common', 'forms'],
+const { S3Client, PutObjectCommand } = require("@aws-sdk/client-s3")
 
+const s3Client = new S3Client({
+  region: process.env.S3_REGION,
+  credentials: {
+    accessKeyId: process.env.S3_ACCESS_KEY,
+    secretAccessKey: process.env.S3_SECRET_KEY,
+  },
+})
+
+module.exports = {
+  ...
   // Custom load function
   loadPath: async (locale, namespace) => {
     // Example: Load from S3
-    const s3Client = new S3Client({ region: 'us-east-1' });
     const response = await s3Client.send(
       new GetObjectCommand({
         Bucket: 'my-translations-bucket',
@@ -58,7 +61,6 @@ module.exports = {
   // Custom save function
   savePath: async (locale, namespace, data) => {
     // Example: Save to S3
-    const s3Client = new S3Client({ region: 'us-east-1' });
     await s3Client.send(
       new PutObjectCommand({
         Bucket: 'my-translations-bucket',
@@ -74,7 +76,7 @@ module.exports = {
 then just run:
 
 ```bash
-npx i18n-magic [command]
+npx @scoutello/i18n-magic [command]
 ```
 
 `scan`
@@ -85,10 +87,14 @@ Scan for missing translations, get prompted for each, translate it to the other
 
 Replace a translation based on the key, and translate it to the other locales and save it to the JSON file.
 
+Optional arguments:
+
+- `-k, --key <key>`: Specify the translation key to replace directly.
+
 `check-missing`
 
 Checks if there are any missing translations. Useful for CI/CD or for a husky hook.
 
 `sync`
 
-Sync the translations from the default locale to the other locales. Useful for a CI/CD pipeline or husky hook.
+Sync the translations from the default locale to the other locales. Useful for a CI/CD pipeline or husky hook. Should be used together with `disableTranslation: true`

package/dist/commands/replace.d.ts

@@ -1,2 +1,2 @@
 import type { Configuration } from "../lib/types";
-export declare const replaceTranslation: (config: Configuration) => Promise<void>;
+export declare const replaceTranslation: (config: Configuration, key?: string) => Promise<void>;

package/dist/i18n-magic.cjs.development.js

@@ -995,7 +995,7 @@ var getKeyToReplace = /*#__PURE__*/function () {
   };
 }();
 var replaceTranslation = /*#__PURE__*/function () {
-  var _ref2 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(config) {
+  var _ref2 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(config, key) {
     var loadPath, savePath, defaultLocale, defaultNamespace, locales, context, openai, keys, keyToReplace, newTranslation, _iterator, _step, locale, newValue, _object, translation, existingKeys;
     return _regeneratorRuntime().wrap(function _callee2$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
@@ -1005,32 +1005,55 @@ var replaceTranslation = /*#__PURE__*/function () {
           return loadLocalesFile(config.loadPath, config.defaultLocale, config.defaultNamespace);
         case 3:
           keys = _context2.sent;
-          _context2.next = 6;
+          if (!key) {
+            _context2.next = 16;
+            break;
+          }
+          if (!keys[key]) {
+            _context2.next = 10;
+            break;
+          }
+          keyToReplace = key;
+          console.log("The key \"" + keyToReplace + "\" exists.");
+          _context2.next = 14;
+          break;
+        case 10:
+          console.log("The key \"" + key + "\" does not exist.");
+          _context2.next = 13;
           return getKeyToReplace(keys);
-        case 6:
+        case 13:
+          keyToReplace = _context2.sent;
+        case 14:
+          _context2.next = 19;
+          break;
+        case 16:
+          _context2.next = 18;
+          return getKeyToReplace(keys);
+        case 18:
           keyToReplace = _context2.sent;
+        case 19:
           console.log("The current translation in " + defaultLocale + " for \"" + keyToReplace + "\" is \"" + keys[keyToReplace] + "\".");
-          _context2.next = 10;
+          _context2.next = 22;
           return getTextInput("Enter the new translation: ");
-        case 10:
+        case 22:
           newTranslation = _context2.sent;
           _iterator = _createForOfIteratorHelperLoose(locales);
-        case 12:
+        case 24:
           if ((_step = _iterator()).done) {
-            _context2.next = 31;
+            _context2.next = 43;
             break;
           }
           locale = _step.value;
           newValue = "";
           if (!(locale === defaultLocale)) {
-            _context2.next = 19;
+            _context2.next = 31;
             break;
           }
           newValue = newTranslation;
-          _context2.next = 23;
+          _context2.next = 35;
           break;
-        case 19:
-          _context2.next = 21;
+        case 31:
+          _context2.next = 33;
           return translateKey({
             context: context,
             inputLanguage: defaultLocale,
@@ -1039,27 +1062,27 @@ var replaceTranslation = /*#__PURE__*/function () {
             openai: openai,
             model: config.model
           });
-        case 21:
+        case 33:
           translation = _context2.sent;
           newValue = translation[keyToReplace];
-        case 23:
-          _context2.next = 25;
+        case 35:
+          _context2.next = 37;
           return loadLocalesFile(loadPath, locale, defaultNamespace);
-        case 25:
+        case 37:
           existingKeys = _context2.sent;
           existingKeys[keyToReplace] = newValue;
           writeLocalesFile(savePath, locale, defaultNamespace, existingKeys);
           console.log("The new translation for \"" + keyToReplace + "\" in " + locale + " is \"" + newValue + "\".");
-        case 29:
-          _context2.next = 12;
+        case 41:
+          _context2.next = 24;
           break;
-        case 31:
+        case 43:
         case "end":
           return _context2.stop();
       }
     }, _callee2);
   }));
-  return function replaceTranslation(_x2) {
+  return function replaceTranslation(_x2, _x3) {
     return _ref2.apply(this, arguments);
   };
 }();
@@ -1363,44 +1386,60 @@ var commands = [{
 }];
 var _loop = function _loop() {
   var command = _commands[_i];
-  program.command(command.name).description(command.description).action( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
-    var _config$model;
-    var res, config, isGemini, openaiKey, geminiKey, key, keyType, openai;
-    return _regeneratorRuntime().wrap(function _callee$(_context) {
-      while (1) switch (_context.prev = _context.next) {
-        case 0:
-          res = dotenv.config({
-            path: program.opts().env || ".env"
-          });
-          _context.next = 3;
-          return loadConfig({
-            configPath: program.opts().config
-          });
-        case 3:
-          config = _context.sent;
-          isGemini = (_config$model = config.model) == null ? void 0 : _config$model.includes("gemini"); // Get API key from environment or config
-          openaiKey = res.parsed.OPENAI_API_KEY || config.OPENAI_API_KEY;
-          geminiKey = res.parsed.GEMINI_API_KEY || config.GEMINI_API_KEY; // Select appropriate key based on model type
-          key = isGemini ? geminiKey : openaiKey;
-          if (!key) {
-            keyType = isGemini ? "GEMINI_API_KEY" : "OPENAI_API_KEY";
-            console.error("Please provide a" + (isGemini ? " Gemini" : "n OpenAI") + " API key in your .env file or config, called " + keyType + ".");
-            process.exit(1);
-          }
-          openai = new OpenAI(_extends({
-            apiKey: key
-          }, isGemini && {
-            baseURL: "https://generativelanguage.googleapis.com/v1beta/openai/"
-          }));
-          command.action(_extends({}, config, {
-            openai: openai
-          }));
-        case 11:
-        case "end":
-          return _context.stop();
-      }
-    }, _callee);
-  })));
+  var cmd = program.command(command.name).description(command.description);
+  // Add key option to replace command
+  if (command.name === "replace") {
+    cmd.option("-k, --key <key>", "translation key to replace");
+  }
+  cmd.action( /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(options) {
+      var _config$model;
+      var res, config, isGemini, openaiKey, geminiKey, key, keyType, openai;
+      return _regeneratorRuntime().wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            res = dotenv.config({
+              path: program.opts().env || ".env"
+            });
+            _context.next = 3;
+            return loadConfig({
+              configPath: program.opts().config
+            });
+          case 3:
+            config = _context.sent;
+            isGemini = (_config$model = config.model) == null ? void 0 : _config$model.includes("gemini"); // Get API key from environment or config
+            openaiKey = res.parsed.OPENAI_API_KEY || config.OPENAI_API_KEY;
+            geminiKey = res.parsed.GEMINI_API_KEY || config.GEMINI_API_KEY; // Select appropriate key based on model type
+            key = isGemini ? geminiKey : openaiKey;
+            if (!key) {
+              keyType = isGemini ? "GEMINI_API_KEY" : "OPENAI_API_KEY";
+              console.error("Please provide a" + (isGemini ? " Gemini" : "n OpenAI") + " API key in your .env file or config, called " + keyType + ".");
+              process.exit(1);
+            }
+            openai = new OpenAI(_extends({
+              apiKey: key
+            }, isGemini && {
+              baseURL: "https://generativelanguage.googleapis.com/v1beta/openai/"
+            }));
+            if (command.name === "replace" && options.key) {
+              command.action(_extends({}, config, {
+                openai: openai
+              }), options.key);
+            } else {
+              command.action(_extends({}, config, {
+                openai: openai
+              }));
+            }
+          case 11:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee);
+    }));
+    return function (_x) {
+      return _ref.apply(this, arguments);
+    };
+  }());
 };
 for (var _i = 0, _commands = commands; _i < _commands.length; _i++) {
   _loop();