gpt-po 1.2.0 → 1.2.3

package/README.md

@@ -60,7 +60,7 @@ Options:
   --verbose              show verbose log
   -l, --lang <lang>      target language (ISO 639-1 code)
   -o, --output <file>    output file path, overwirte po file by default
-  --context              context file path (provides additional context to the bot)
+  --context <file>       context file path (provides additional context to the bot)
   -h, --help             display help for command
 ```
 

package/README_zh-CN.md

@@ -62,7 +62,7 @@ npm install gpt-po
   --verbose              显示详细日志
   -l, --lang <lang>      目标语言 (ISO 639-1 代码)
   -o, --output <file>    输出文件路径，默认覆盖 po 文件
-  --context              上下文文件路径（为机器人提供额外的上下文）
+  --context <file>       上下文文件路径（为机器人提供额外的上下文）
   -h, --help             显示命令帮助
 ```
 

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gpt-po",
-    "version": "1.2.0",
+    "version": "1.2.3",
     "description": "command tool for translate po files by gpt",
     "main": "lib/src/index.js",
     "type": "module",

package/lib/src/index.d.ts

@@ -1,2 +1,2 @@
-#!/usr/bin/env node --no-warnings=ExperimentalWarning
+#!/usr/bin/env -S node --no-warnings=ExperimentalWarning
 export {};

package/lib/src/index.js

@@ -1,18 +1,34 @@
-#!/usr/bin/env node --no-warnings=ExperimentalWarning
+#!/usr/bin/env -S node --no-warnings=ExperimentalWarning
 import { Command, Option } from "commander";
 import path from "path";
 import { fileURLToPath } from "url";
 import pkg from "../package.json" with { type: "json" };
+import { removeByOptions } from "./manipulate.js";
 import { sync } from "./sync.js";
 import { init, translatePo, translatePoDir } from "./translate.js";
-import { copyFileIfNotExists, compilePo, findConfig, openFileByDefault, openFileExplorer, parsePo } from "./utils.js";
-import { removeByOptions } from "./manipulate.js";
+import { compilePo, copyFileIfNotExists, findConfig, openFileByDefault, openFileExplorer, parsePo } from "./utils.js";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const program = new Command();
 program.name(pkg.name).version(pkg.version).description(pkg.description);
-program
-    .command("translate", { isDefault: true })
+const getCompileOptions = (args) => {
+    const foldLength = args.poFoldLen === "false" ? 0 : parseInt(args.poFoldLen);
+    const sort = args.poSort;
+    const escapeCharacters = args.poEscChars;
+    if (isNaN(foldLength)) {
+        console.error("--po-fold-len must be a number or false");
+        process.exit(1);
+    }
+    return { foldLength, sort, escapeCharacters };
+};
+class SharedOptionsCommand extends Command {
+    addCompileOptions() {
+        return this.option("--po-fold-len <length>", "a gettext compile option, the length at which to fold message strings into newlines, set to 0 or false to disable folding", "120")
+            .option("--po-sort", "a gettext compile option, sort entries by msgid", false)
+            .option("--po-esc-chars", "a gettext compile option, escape characters in output, if false, will skip escape newlines and quotes characters functionality", true);
+    }
+}
+const translateCommand = new SharedOptionsCommand("translate")
     .description("translate po file (default command)")
     .addOption(new Option("-k, --key <key>", "openai api key").env("OPENAI_API_KEY"))
     .addOption(new Option("--host <host>", "openai api host").env("OPENAI_API_HOST"))
@@ -24,6 +40,7 @@ program
     .option("--verbose", "print verbose log")
     .option("--context <file>", "text file that provides the bot additional context")
     .addOption(new Option("-o, --output <file>", "output file path, overwirte po file by default").conflicts("dir"))
+    .addCompileOptions()
     .action(async (args) => {
     const { key, host, model, po, dir, source, lang, verbose, output, context } = args;
     if (host) {
@@ -38,25 +55,30 @@ program
         process.exit(1);
     }
     init();
+    const compileOptions = getCompileOptions(args);
     if (po) {
-        await translatePo(model, po, source, lang, verbose, output, context);
+        await translatePo(model, po, source, lang, verbose, output, context, compileOptions);
     }
     else if (dir) {
-        await translatePoDir(model, dir, source, lang, verbose, context);
+        await translatePoDir(model, dir, source, lang, verbose, context, compileOptions);
     }
     else {
         console.error("po file or directory is required");
         process.exit(1);
     }
 });
-program
-    .command("sync")
+program.addCommand(translateCommand, { isDefault: true });
+const syncCommand = new SharedOptionsCommand("sync")
     .description("update po from pot file")
     .requiredOption("--po <file>", "po file path")
     .requiredOption("--pot <file>", "pot file path")
-    .action(async ({ po, pot }) => {
-    await sync(po, pot);
+    .option("-o, --output <file>", "output file path, overwirte po file by default")
+    .addCompileOptions()
+    .action(async (args) => {
+    const { po, pot } = args;
+    await sync(po, pot, getCompileOptions(args));
 });
+program.addCommand(syncCommand);
 // program command `userdict` with help text `open/edit user dictionary`
 program
     .command("userdict")
@@ -78,8 +100,7 @@ program
     openFileByDefault(dictFile);
 });
 // program command `remove` with help text `remove po entries by options`
-program
-    .command("remove")
+const removeCommand = new SharedOptionsCommand("remove")
     .description("remove po entries by options")
     .requiredOption("--po <file>", "po file path")
     .option("--fuzzy", "remove fuzzy entries")
@@ -89,7 +110,10 @@ program
     .option("-tnf, --translated-not-fuzzy", "remove translated not fuzzy entries")
     .option("-ft, --fuzzy-translated", "remove fuzzy translated entries")
     .option("-rc, --reference-contains <text>", "remove entries whose reference contains text, text can be a regular expression like /text/ig")
+    .option("-o, --output <file>", "output file path, overwirte po file by default")
+    .addCompileOptions()
     .action(async (args) => {
+    this;
     const { po, fuzzy, obsolete, untranslated, translated, translatedNotFuzzy, fuzzyTranslated, referenceContains } = args;
     const options = {
         fuzzy,
@@ -102,8 +126,9 @@ program
     };
     const output = args.output || po;
     const translations = await parsePo(po);
-    await compilePo(removeByOptions(translations, options), output);
+    await compilePo(removeByOptions(translations, options), output, getCompileOptions(args));
     console.log("done");
 });
+program.addCommand(removeCommand);
 program.parse(process.argv);
 //# sourceMappingURL=index.js.map

package/lib/src/sync.d.ts

@@ -1 +1,2 @@
-export declare function sync(po: string, pot: string): Promise<void>;
+import { CompileOptions } from "./utils.js";
+export declare function sync(po: string, pot: string, compileOptions?: CompileOptions): Promise<void>;

package/lib/src/sync.js

@@ -1,5 +1,5 @@
 import { compilePo, parsePo } from "./utils.js";
-export async function sync(po, pot) {
+export async function sync(po, pot, compileOptions) {
     const potrans = await parsePo(po);
     const potrans2 = await parsePo(pot);
     for (const [ctx, entries] of Object.entries(potrans2.translations)) {
@@ -13,6 +13,6 @@ export async function sync(po, pot) {
         }
     }
     potrans.translations = potrans2.translations;
-    await compilePo(potrans, po);
+    await compilePo(potrans, po, compileOptions);
 }
 //# sourceMappingURL=sync.js.map

package/lib/src/translate.d.ts

@@ -1,6 +1,7 @@
 import { GetTextTranslation } from "gettext-parser";
 import { OpenAI } from "openai";
+import { CompileOptions } from "./utils.js";
 export declare function init(force?: boolean): OpenAI;
 export declare function translate(src: string, lang: string, model: string, translations: GetTextTranslation[], contextFile: string): Promise<void>;
-export declare function translatePo(model: string, po: string, source: string, lang: string, verbose: boolean, output: string, contextFile: string): Promise<void>;
-export declare function translatePoDir(model: string | undefined, dir: string, source: string, lang: string, verbose: boolean, contextFile: string): Promise<void>;
+export declare function translatePo(model: string, po: string, source: string, lang: string, verbose: boolean, output: string, contextFile: string, compileOptions?: CompileOptions): Promise<void>;
+export declare function translatePoDir(model: string | undefined, dir: string, source: string, lang: string, verbose: boolean, contextFile: string, compileOptions?: CompileOptions): Promise<void>;

package/lib/src/translate.js

@@ -58,7 +58,10 @@ export async function translate(src, lang, model, translations, contextFile) {
         .join("\n");
     const context = contextFile ? "\n\nContext: " + fs.readFileSync(contextFile, "utf-8") : "";
     const translationsContent = translations
-        .map((tr, idx) => `<translate index="${idx + dicts.user.length + 1}">${tr.msgid}</translate>`)
+        .map((tr, idx) => {
+        const contextAttr = tr.msgctxt ? ` context="${tr.msgctxt}"` : "";
+        return `<translate index="${idx + dicts.user.length + 1}"${contextAttr}>${tr.msgid}</translate>`;
+    })
         .join("\n");
     const res = await _openai.chat.completions.create({
         model: model,
@@ -107,7 +110,7 @@ export async function translate(src, lang, model, translations, contextFile) {
         }
     });
 }
-export async function translatePo(model, po, source, lang, verbose, output, contextFile) {
+export async function translatePo(model, po, source, lang, verbose, output, contextFile, compileOptions) {
     const potrans = await parsePo(po);
     if (!lang)
         lang = potrans.headers["Language"];
@@ -132,11 +135,16 @@ export async function translatePo(model, po, source, lang, verbose, output, cont
     let trimed = false;
     for (const [ctx, entries] of Object.entries(potrans.translations)) {
         for (const [msgid, trans] of Object.entries(entries)) {
-            if (msgid == "")
+            if (msgid === "")
                 continue;
             if (!trans.msgstr[0]) {
-                list.push(trans);
-                continue;
+                list.push({
+                    msgctxt: trans.msgctxt || ctx,
+                    msgid,
+                    msgid_plural: trans.msgid_plural,
+                    msgstr: trans.msgstr,
+                    comments: trans.comments
+                });
             }
             else if (trimRegx.test(trans.msgstr[0])) {
                 trimed = true;
@@ -145,7 +153,7 @@ export async function translatePo(model, po, source, lang, verbose, output, cont
         }
     }
     if (trimed) {
-        await compilePo(potrans, po);
+        await compilePo(potrans, po, compileOptions);
     }
     if (list.length == 0) {
         console.log("done.");
@@ -180,7 +188,7 @@ export async function translatePo(model, po, source, lang, verbose, output, cont
                 // update progress
                 printProgress(i + 1, list.length);
                 // save po file after each 2000 characters
-                await compilePo(potrans, output || po);
+                await compilePo(potrans, output || po, compileOptions);
             }
             catch (error) {
                 if (error.response) {
@@ -205,13 +213,13 @@ export async function translatePo(model, po, source, lang, verbose, output, cont
     }
     console.log("done.");
 }
-export async function translatePoDir(model = "gpt-3.5-turbo", dir, source, lang, verbose, contextFile) {
+export async function translatePoDir(model = "gpt-3.5-turbo", dir, source, lang, verbose, contextFile, compileOptions) {
     const files = fs.readdirSync(dir);
     for (const file of files) {
         if (file.endsWith(".po")) {
             const po = path.join(dir, file);
             console.log(`translating ${po}`);
-            await translatePo(model, po, source, lang, verbose, po, contextFile);
+            await translatePo(model, po, source, lang, verbose, po, contextFile, compileOptions);
         }
     }
 }

package/lib/src/userprompt.txt

@@ -12,7 +12,14 @@ Translation guidelines are as follows:
    - Input messages will be wrapped in `<translate>` XML tags with an index attribute, e.g., `<translate index="1">`.
    - Respond with the translated message wrapped in `<translated>` XML tags, including the same index attribute, e.g., `<translated index="1">`.
 
-4. **Multiple Translations**:
+4. **Context Handling**:
+   - Some messages will include a context attribute in the translate tag, e.g., `<translate index="1" context="Menu">`.
+   - Use this context to inform your translation but only return the translated text.
+   - Example:
+     Input: `<translate index="1" context="Menu">File</translate>`
+     Output: `<translated index="1">Fichier</translated>`
+
+5. **Multiple Translations**:
    - You may receive multiple translation requests in a single input, each with a unique index.
    - Ensuring the complete number of requests are translated, even if they are repeated, while maintaining the original order when possible.
 

package/lib/src/utils.d.ts

@@ -8,12 +8,12 @@ import { GetTextTranslations } from "gettext-parser";
 export declare function copyFileIfNotExists(file: string, copyFile: string, force?: boolean): void;
 export declare function openFileByDefault(filePath: string): void;
 export declare function parsePo(poFile: string, defaultCharset?: string): Promise<GetTextTranslations>;
-export type compileOptions = {
+export type CompileOptions = {
     foldLength?: number;
     sort?: boolean | ((a: never, b: never) => number);
     escapeCharacters?: boolean;
 };
-export declare function compilePo(data: GetTextTranslations, poFile: string, options?: compileOptions): Promise<void>;
+export declare function compilePo(data: GetTextTranslations, poFile: string, options?: CompileOptions): Promise<void>;
 export declare function printProgress(progress: number, total: number, extra?: string): void;
 export declare function gitRootDir(dir?: string): string | null;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gpt-po",
-  "version": "1.2.0",
+  "version": "1.2.3",
   "description": "command tool for translate po files by gpt",
   "main": "lib/src/index.js",
   "type": "module",