add command to replace key

Author: BjoernRave

.gitignore

@@ -3,4 +3,9 @@
 node_modules
 dist
 
-.yarn
+.yarn
+
+.env
+test.tsx
+locales
+i18n-magic.js

package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18n-magic",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "license": "MIT",
   "author": "BjoernRave",
   "main": "dist/index.js",
@@ -48,7 +48,7 @@
     }
   ],
   "dependencies": {
-    "@inquirer/input": "^1.2.5",
+    "@inquirer/prompts": "^3.0.0",
     "chalk": "^5.3.0",
     "commander": "^11.0.0",
     "dotenv": "^16.3.1",

src/commands/replace.ts

@@ -0,0 +1,76 @@
+import { input } from '@inquirer/prompts';
+import { Configuration } from '../lib/types';
+import { loadLocalesFile, translateKey, writeLocalesFile } from '../lib/utils';
+
+const getKeyToReplace = async (keys: any) => {
+  const keyToReplace = await input({
+    message: 'Enter the key to replace the translation for: ',
+  });
+
+  if (!keys[keyToReplace]) {
+    console.log(`The key "${keyToReplace}" does not exist.`);
+    return await getKeyToReplace(keys);
+  } else {
+    console.log(`The key "${keyToReplace}" exists.`);
+    return keyToReplace;
+  }
+};
+
+export const replaceTranslation = async (config: Configuration) => {
+  const {
+    loadPath,
+    savePath,
+    defaultLocale,
+    defaultNamespace,
+    namespaces,
+    locales,
+    globPatterns,
+    context,
+    openai,
+  } = config;
+
+  const keys = loadLocalesFile(
+    config.loadPath,
+    config.defaultLocale,
+    config.defaultNamespace
+  );
+
+  const keyToReplace = await getKeyToReplace(keys);
+
+  console.log(
+    `The current translation in ${defaultLocale} for "${keyToReplace}" is "${keys[keyToReplace]}".`
+  );
+
+  const newTranslation = await input({
+    message: `Enter the new translation: `,
+  });
+
+  for (const locale of locales) {
+    let newValue = '';
+    if (locale === defaultLocale) {
+      newValue = newTranslation;
+    } else {
+      const translation = await translateKey({
+        context,
+        inputLanguage: defaultLocale,
+        outputLanguage: locale,
+        object: {
+          [keyToReplace]: newTranslation,
+        },
+        openai,
+      });
+
+      newValue = translation[keyToReplace];
+    }
+
+    const existingKeys = loadLocalesFile(loadPath, locale, defaultNamespace);
+
+    existingKeys[keyToReplace] = newValue;
+
+    writeLocalesFile(savePath, locale, defaultNamespace, existingKeys);
+
+    console.log(
+      `The new translation for "${keyToReplace}" in ${locale} is "${newValue}".`
+    );
+  }
+};

src/commands/scan.ts

@@ -1,15 +1,15 @@
-import input from '@inquirer/input';
+import { input } from '@inquirer/prompts';
 import glob from 'fast-glob';
 import fs from 'fs';
 import { Parser } from 'i18next-scanner';
-import OpenAI from 'openai';
 
 import { Configuration } from '../lib/types';
 import {
   getPureKey,
   loadLocalesFile,
   removeDuplicatesFromArray,
   translateKey,
+  writeLocalesFile,
 } from '../lib/utils';
 
 export const translateMissing = async ({
@@ -21,11 +21,8 @@ export const translateMissing = async ({
   locales,
   globPatterns,
   context,
+  openai,
 }: Configuration) => {
-  const openai = new OpenAI({
-    apiKey: process.env.OPENAI_KEY,
-  });
-
   const parser = new Parser({
     nsSeparator: false,
     keySeparator: false,
@@ -69,15 +66,15 @@ export const translateMissing = async ({
     }
   }
 
-  console.log(
-    `Please provide the values for the following keys in ${defaultLocale}:`
-  );
-
   if (newKeys.length === 0) {
     console.log('No new keys found.');
     return;
   }
 
+  console.log(
+    `Please provide the values for the following keys in ${defaultLocale}:`
+  );
+
   const newKeysWithDefaultLocale = [];
 
   for (const newKey of newKeys) {
@@ -127,11 +124,9 @@ export const translateMissing = async ({
         existingKeys[key.key] = translatedValues[key.key];
       }
 
-      const resolvedSavePath = savePath
-        .replace('{{lng}}', locale)
-        .replace('{{ns}}', namespace);
-
-      fs.writeFileSync(resolvedSavePath, JSON.stringify(existingKeys, null, 2));
+      writeLocalesFile(savePath, locale, namespace, existingKeys);
     }
   }
+
+  console.log(`Successfully translated ${newKeys.length} keys.`);
 };

src/index.ts

@@ -1,4 +1,6 @@
 import { Command } from 'commander';
+import OpenAI from 'openai';
+import { replaceTranslation } from './commands/replace';
 import { translateMissing } from './commands/scan';
 import { loadConfig } from './lib/utils';
 
@@ -19,6 +21,11 @@ const commands = [
     description: 'Scan for missing translations',
     action: translateMissing,
   },
+  {
+    name: 'replace',
+    description: 'Replace a translation',
+    action: replaceTranslation,
+  },
 ];
 
 for (const command of commands) {
@@ -27,6 +34,9 @@ for (const command of commands) {
     .description(command.description)
     .action(async () => {
       const config = await loadConfig();
+      const openai = new OpenAI({
+        apiKey: process.env.OPENAI_KEY,
+      });
 
       if (!process.env.OPENAI_KEY) {
         console.error(
@@ -35,7 +45,7 @@ for (const command of commands) {
         process.exit(1);
       }
 
-      command.action(config);
+      command.action({ ...config, openai });
     });
 }
 

src/lib/types.ts

@@ -1,3 +1,5 @@
+import OpenAI from 'openai';
+
 export interface Configuration {
   loadPath: string;
   savePath: string;
@@ -7,4 +9,5 @@ export interface Configuration {
   locales: string[];
   globPatterns: string[];
   context?: string;
+  openai: OpenAI;
 }

src/lib/utils.ts

@@ -76,7 +76,20 @@ export const loadLocalesFile = (
   const content = fs.readFileSync(resolvedPath, 'utf-8');
   const json = JSON.parse(content);
 
-  return json;
+  return json as Record<string, string>;
+};
+
+export const writeLocalesFile = (
+  path: string,
+  locale: string,
+  namespace: string,
+  data: Record<string, string>
+) => {
+  const resolvedSavePath = path
+    .replace('{{lng}}', locale)
+    .replace('{{ns}}', namespace);
+
+  fs.writeFileSync(resolvedSavePath, JSON.stringify(data, null, 2));
 };
 
 export const getPureKey = (