gpt-po 1.1.1 → 1.2.0

package/.github/FUNDING.yml

@@ -0,0 +1 @@
+buy_me_a_coffee: ryanhex

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [1.2.0] - 2024-11-26
+- Submit multiple entries per chat to boost speed and reduce tokens
+- Command `systemprompt` has been removed
+- Bug fixes
+
+## [1.1.2] - 2024-11-12
+- Update command options for OpenAI model
+- Dependency updates, target es2022, module(Nodejs 18+)
+
+## [1.0.11] - 2023-10-26
+- Add `gpt-po remove` command
+- improve prompt for translation
+
+## [1.0.9] - 2023-09-08
+- Can add dictionaries for each languages

package/README.md

@@ -7,6 +7,8 @@ Translation tool for gettext (po) files that supports custom system prompts and
 
 Read in other languages: English | [简体中文](./README_zh-CN.md)
 
+<a href="https://buymeacoffee.com/ryanhex" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-red.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+
 ## Installation
 
 ```
@@ -25,8 +27,6 @@ Set `OPENAI_API_KEY` before using this tool.
 - `gpt-po --dir .` Translate all po files in current directory to a designated target language.
 - `gpt-po userdict` Modify or view user dictionaries
 - `gpt-po userdict --explore` Explore user dictionaries, if you want add new dictionaries or modify existing dictionaries. dictionaries can be named as `dictionary-<lang>.json`, for example, `dictionary-zh.json` is the dictionary for Simplified Chinese.
-- `gpt-po systemprompt` Modify or view system prompts, if you are not sure how to use it, you can leave it alone
-- `gpt-po systemprompt --reset` Reset system prompts
 
 ```
 Usage: gpt-po [options] [command]
@@ -40,7 +40,6 @@ Options:
 Commands:
   translate [options]     translate po file (default command)
   sync [options]          update po from pot file
-  systemprompt [options]  open/edit system prompt
   userdict [options]      open/edit user dictionary
   remove [options]        remove po entries by options
   help [command]          display help for command
@@ -54,8 +53,7 @@ translate po file (default command)
 Options:
   -k, --key <key>        openai api key (env: OPENAI_API_KEY)
   --host <host>          openai api host (env: OPENAI_API_HOST)
-  --model <model>        openai model (choices: "gpt-4o", "gpt-4-turbo", "gpt-4", "gpt-4-0314", "gpt-4-32k", "gpt-4-32k-0314", "gpt-3.5-turbo", "gpt-3.5-turbo-0301",
-                         default: "gpt-4o")
+  --model <model>        openai model (default: "gpt-4o-mini", env: OPENAI_MODEL)
   --po <file>            po file path
   --dir <dir>            po file directory
   -src, --source <lang>  source language (default: "english")
@@ -82,3 +80,14 @@ Options:
   -rc, --reference-contains <text>  remove entries whose reference contains text, text can be a regular expression like /text/ig
   -h, --help                        display help for command
 ```
+
+```
+Usage: gpt-po sync [options]
+
+update po from pot file
+
+Options:
+  --po <file>   po file path
+  --pot <file>  pot file path
+  -h, --help    display help for command
+```

package/README_zh-CN.md

@@ -7,6 +7,8 @@ gettext(po)文件翻译工具，支持自定义系统提示词和用户字典，
 
 使用其他语言阅读：[English](./README.md) | 简体中文
 
+<a href="https://buymeacoffee.com/ryanhex" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-red.png" alt="请我喝杯咖啡" height="41" width="174"></a>
+
 ## 安装
 
 ```
@@ -27,8 +29,6 @@ npm install gpt-po
 - `gpt-po --dir .` 将当前目录下的所有 po 文件翻译成目标语言。
 - `gpt-po userdict` 修改或查看用户词典。
 - `gpt-po userdict --explore` 浏览用户词典，如果您想添加新词典或修改现有词典，词典可以命名为 `dictionary-<lang>.json`，例如 `dictionary-zh.json` 是简体中文词典。
-- `gpt-po systemprompt` 修改或查看系统提示，如果您不确定如何使用它，可以忽略。
-- `gpt-po systemprompt --reset` 重置系统提示。
 
 ```
 用法: gpt-po [options] [command]
@@ -42,7 +42,6 @@ npm install gpt-po
 命令:
   translate [options]     翻译 po 文件（默认命令）
   sync [options]          根据 pot 文件更新 po 文件
-  systemprompt [options]  打开/编辑系统提示
   userdict [options]      打开/编辑用户词典
   remove [options]        通过选项删除 po 条目
   help [command]          显示命令帮助
@@ -56,7 +55,7 @@ npm install gpt-po
 选项:
   -k, --key <key>        openai api key (环境变量: OPENAI_API_KEY)
   --host <host>          openai api host (环境变量: OPENAI_API_HOST)
-  --model <model>        openai 模型 (选项: "gpt-4o", "gpt-4-turbo", "gpt-4", "gpt-4-0314", "gpt-4-32k", "gpt-4-32k-0314", "gpt-3.5-turbo", "gpt-3.5-turbo-0301", 默认: "gpt-4o")
+  --model <model>        openai 模型 (默认: "gpt-4o-mini", 环境变量: OPENAI_MODEL)
   --po <file>            po 文件路径
   --dir <dir>            po 文件目录
   -src, --source <lang>  源语言 (默认: "english")
@@ -83,3 +82,14 @@ npm install gpt-po
   -rc, --reference-contains <text>  删除引用包含文本的条目，文本可以是正则表达式，例如 /text/ig
   -h, --help                        显示命令帮助
 ```
+
+```
+用法: gpt-po sync [options]
+
+从 pot 文件中更新条目到 po 文件
+
+Options:
+  --po <file>   po 文件路径
+  --pot <file>  pot 文件路径
+  -h, --help    显示命令帮助
+```

package/lib/package.json

@@ -1,8 +1,9 @@
 {
     "name": "gpt-po",
-    "version": "1.1.1",
+    "version": "1.2.0",
     "description": "command tool for translate po files by gpt",
     "main": "lib/src/index.js",
+    "type": "module",
     "bin": {
         "gpt-po": "lib/src/index.js"
     },
@@ -33,23 +34,23 @@
         "openai"
     ],
     "devDependencies": {
-        "@types/gettext-parser": "^4.0.2",
-        "@types/jest": "^29.5.1",
-        "jest": "^29.5.0",
+        "@types/gettext-parser": "^4.0.4",
+        "@types/jest": "^29.5.12",
+        "jest": "^29.7.0",
         "ncp": "^2.0.0",
-        "prettier": "^3.0.3",
-        "rimraf": "^5.0.0",
-        "ts-jest": "^29.1.0",
+        "prettier": "^3.3.3",
+        "rimraf": "^6.0.1",
+        "ts-jest": "^29.2.5",
         "tslint": "^6.1.3",
         "tslint-config-prettier": "^1.18.0",
-        "typescript": "^5.0.4"
+        "typescript": "^5.5.4"
     },
     "dependencies": {
-        "commander": "^10.0.1",
-        "gettext-parser": "^6.0.0",
-        "openai": "^3.2.1"
+        "commander": "^12.1.0",
+        "gettext-parser": "^8.0.0",
+        "openai": "^4.56.0"
     },
     "engines": {
-        "node": ">=12.0.0"
+        "node": ">=18.0.0"
     }
 }

package/lib/src/index.d.ts

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

package/lib/src/index.js

@@ -1,48 +1,30 @@
-#!/usr/bin/env node
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const pkg = require("../package.json");
-const sync_1 = require("./sync");
-const translate_1 = require("./translate");
-const utils_1 = require("./utils");
-const manipulate_1 = require("./manipulate");
-const program = new commander_1.Command();
+#!/usr/bin/env 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 { 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";
+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 })
     .description("translate po file (default command)")
-    .addOption(new commander_1.Option("-k, --key <key>", "openai api key").env("OPENAI_API_KEY"))
-    .addOption(new commander_1.Option("--host <host>", "openai api host").env("OPENAI_API_HOST"))
-    .addOption(new commander_1.Option("--model <model>", "openai model")
-    .default("gpt-4o")
-    .choices([
-    "gpt-4o",
-    "gpt-4-turbo",
-    "gpt-4",
-    "gpt-4-0314",
-    "gpt-4-32k",
-    "gpt-4-32k-0314",
-    "gpt-3.5-turbo",
-    "gpt-3.5-turbo-0301",
-]))
-    .addOption(new commander_1.Option("--po <file>", "po file path").conflicts("dir"))
-    .addOption(new commander_1.Option("--dir <dir>", "po file directory").conflicts("po"))
+    .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"))
+    .addOption(new Option("--model <model>", "openai model").env("OPENAI_MODEL").default("gpt-4o-mini"))
+    .addOption(new Option("--po <file>", "po file path").conflicts("dir"))
+    .addOption(new Option("--dir <dir>", "po file directory").conflicts("po"))
     .option("-src, --source <lang>", "source language (ISO 639-1)", "en")
     .option("-l, --lang <lang>", "target language (ISO 639-1)")
     .option("--verbose", "print verbose log")
     .option("--context <file>", "text file that provides the bot additional context")
-    .addOption(new commander_1.Option("-o, --output <file>", "output file path, overwirte po file by default").conflicts("dir"))
-    .action((args) => __awaiter(void 0, void 0, void 0, function* () {
+    .addOption(new Option("-o, --output <file>", "output file path, overwirte po file by default").conflicts("dir"))
+    .action(async (args) => {
     const { key, host, model, po, dir, source, lang, verbose, output, context } = args;
     if (host) {
         process.env.OPENAI_API_HOST = host;
@@ -55,60 +37,45 @@ program
         console.error("OPENAI_API_KEY is required");
         process.exit(1);
     }
-    (0, translate_1.init)();
+    init();
     if (po) {
-        yield (0, translate_1.translatePo)(model, po, source, lang, verbose, output, context);
+        await translatePo(model, po, source, lang, verbose, output, context);
     }
     else if (dir) {
-        yield (0, translate_1.translatePoDir)(model, dir, source, lang, verbose, context);
+        await translatePoDir(model, dir, source, lang, verbose, context);
     }
     else {
         console.error("po file or directory is required");
         process.exit(1);
     }
-}));
+});
 program
     .command("sync")
     .description("update po from pot file")
     .requiredOption("--po <file>", "po file path")
     .requiredOption("--pot <file>", "pot file path")
-    .action(({ po, pot }) => __awaiter(void 0, void 0, void 0, function* () {
-    yield (0, sync_1.sync)(po, pot);
-}));
-// program command `systemprompt` with help text `open/edit system prompt`
-program
-    .command("systemprompt")
-    .description("open/edit system prompt")
-    .option("--reset", "reset system prompt to default")
-    .action((args) => {
-    const { reset } = args;
-    // open `systemprompt.txt` file by system text default editor
-    const copyFile = __dirname + "/systemprompt.txt";
-    // user home path
-    const promptFile = (0, utils_1.findConfig)("systemprompt.txt");
-    (0, utils_1.copyFileIfNotExists)(promptFile, copyFile, reset);
-    if (reset) {
-        console.log("systemprompt.txt reset to default");
-    }
-    (0, utils_1.openFileByDefault)(promptFile);
+    .action(async ({ po, pot }) => {
+    await sync(po, pot);
 });
 // program command `userdict` with help text `open/edit user dictionary`
 program
     .command("userdict")
     .description("open/edit user dictionary")
     .option("--explore", "open user dictionary directory")
+    .option("-l, --lang <lang>", "target language (ISO 639-1)")
     .action((args) => {
-    const { explore } = args;
+    const { explore, lang } = args;
     // open `dictionary.json` file by system text default editor
     const copyFile = __dirname + "/dictionary.json";
-    // user home path
-    const dictFile = (0, utils_1.findConfig)("dictionary.json");
+    // find from user home path
+    const dictFile = findConfig(`dictionary${lang ? "-" + lang : ""}.json`);
     if (explore) {
         // open user dictionary directory
-        return (0, utils_1.openFileExplorer)(dictFile);
+        return openFileExplorer(dictFile);
     }
-    (0, utils_1.copyFileIfNotExists)(dictFile, copyFile);
-    (0, utils_1.openFileByDefault)(dictFile);
+    if (!lang)
+        copyFileIfNotExists(dictFile, copyFile);
+    openFileByDefault(dictFile);
 });
 // program command `remove` with help text `remove po entries by options`
 program
@@ -122,7 +89,7 @@ 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")
-    .action((args) => __awaiter(void 0, void 0, void 0, function* () {
+    .action(async (args) => {
     const { po, fuzzy, obsolete, untranslated, translated, translatedNotFuzzy, fuzzyTranslated, referenceContains } = args;
     const options = {
         fuzzy,
@@ -131,12 +98,12 @@ program
         translated,
         translatedNotFuzzy,
         fuzzyTranslated,
-        referenceContains,
+        referenceContains
     };
     const output = args.output || po;
-    const translations = yield (0, utils_1.parsePo)(po);
-    yield (0, utils_1.compilePo)((0, manipulate_1.removeByOptions)(translations, options), output);
+    const translations = await parsePo(po);
+    await compilePo(removeByOptions(translations, options), output);
     console.log("done");
-}));
+});
 program.parse(process.argv);
 //# sourceMappingURL=index.js.map

package/lib/src/manipulate.js

@@ -1,52 +1,48 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeByOptions = void 0;
 /**
  * remove entity by options
  */
-function removeByOptions(potrans, options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
+export function removeByOptions(potrans, options) {
     const fuzzyRegx = /\bfuzzy\b/;
     const obsoleteRegx = /\bobsolete\b/;
-    const refRegMatch = (options === null || options === void 0 ? void 0 : options.referenceContains)
-        ? /^\/([^\/]+)\/([igmsuy]*)/.exec(options === null || options === void 0 ? void 0 : options.referenceContains)
+    const refRegMatch = options?.referenceContains
+        ? /^\/([^\/]+)\/([igmsuy]*)/.exec(options?.referenceContains)
         : null;
     const refRegx = refRegMatch ? new RegExp(refRegMatch[1], refRegMatch[2]) : null;
     for (const [ctx, entries] of Object.entries(potrans.translations)) {
         for (const [msgid, entry] of Object.entries(entries)) {
             const msgstr = entry.msgstr.join("\n");
             // remove fuzzy
-            if ((options === null || options === void 0 ? void 0 : options.fuzzy) && fuzzyRegx.test(((_a = entry.comments) === null || _a === void 0 ? void 0 : _a.flag) || "")) {
+            if (options?.fuzzy && fuzzyRegx.test(entry.comments?.flag || "")) {
                 delete potrans.translations[ctx][msgid];
             }
             // remove obsolete
-            if ((options === null || options === void 0 ? void 0 : options.obsolete) && obsoleteRegx.test(((_b = entry.comments) === null || _b === void 0 ? void 0 : _b.flag) || "")) {
+            if (options?.obsolete && obsoleteRegx.test(entry.comments?.flag || "")) {
                 delete potrans.translations[ctx][msgid];
             }
             // remove untranslated
-            if ((options === null || options === void 0 ? void 0 : options.untranslated) && msgstr.length === 0) {
+            if (options?.untranslated && msgstr.length === 0) {
                 delete potrans.translations[ctx][msgid];
             }
             // remove translated
-            if ((options === null || options === void 0 ? void 0 : options.translated) && msgstr.length > 0) {
+            if (options?.translated && msgstr.length > 0) {
                 delete potrans.translations[ctx][msgid];
             }
             // remove translated not fuzzy
-            if ((options === null || options === void 0 ? void 0 : options.translatedNotFuzzy) && msgstr.length > 0 && !fuzzyRegx.test(((_c = entry.comments) === null || _c === void 0 ? void 0 : _c.flag) || "")) {
+            if (options?.translatedNotFuzzy && msgstr.length > 0 && !fuzzyRegx.test(entry.comments?.flag || "")) {
                 delete potrans.translations[ctx][msgid];
             }
             // remove fuzzy translated
-            if ((options === null || options === void 0 ? void 0 : options.fuzzyTranslated) && msgstr.length > 0 && fuzzyRegx.test(((_d = entry.comments) === null || _d === void 0 ? void 0 : _d.flag) || "")) {
+            if (options?.fuzzyTranslated && msgstr.length > 0 && fuzzyRegx.test(entry.comments?.flag || "")) {
                 delete potrans.translations[ctx][msgid];
             }
             // remove reference contains
-            if (options === null || options === void 0 ? void 0 : options.referenceContains) {
+            if (options?.referenceContains) {
                 if (refRegx) {
-                    if (((_e = entry.comments) === null || _e === void 0 ? void 0 : _e.reference) && refRegx.test((_f = entry.comments) === null || _f === void 0 ? void 0 : _f.reference)) {
+                    if (entry.comments?.reference && refRegx.test(entry.comments?.reference)) {
                         delete potrans.translations[ctx][msgid];
                     }
                 }
-                else if ((_h = (_g = entry.comments) === null || _g === void 0 ? void 0 : _g.reference) === null || _h === void 0 ? void 0 : _h.includes(options === null || options === void 0 ? void 0 : options.referenceContains)) {
+                else if (entry.comments?.reference?.includes(options?.referenceContains)) {
                     delete potrans.translations[ctx][msgid];
                 }
             }
@@ -54,5 +50,4 @@ function removeByOptions(potrans, options) {
     }
     return potrans;
 }
-exports.removeByOptions = removeByOptions;
 //# sourceMappingURL=manipulate.js.map

package/lib/src/sync.js

@@ -1,33 +1,18 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sync = void 0;
-const utils_1 = require("./utils");
-function sync(po, pot) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const potrans = yield (0, utils_1.parsePo)(po);
-        const potrans2 = yield (0, utils_1.parsePo)(pot);
-        for (const [ctx, entries] of Object.entries(potrans2.translations)) {
-            // copy msgstr from potrans to potrans2
-            for (const [msgid, _] of Object.entries(entries)) {
-                if (potrans.translations[ctx] &&
-                    potrans.translations[ctx][msgid] &&
-                    potrans.translations[ctx][msgid].msgstr[0]) {
-                    potrans2.translations[ctx][msgid] = potrans.translations[ctx][msgid];
-                }
+import { compilePo, parsePo } from "./utils.js";
+export async function sync(po, pot) {
+    const potrans = await parsePo(po);
+    const potrans2 = await parsePo(pot);
+    for (const [ctx, entries] of Object.entries(potrans2.translations)) {
+        // copy msgstr from potrans to potrans2
+        for (const [msgid, _] of Object.entries(entries)) {
+            if (potrans.translations[ctx] &&
+                potrans.translations[ctx][msgid] &&
+                potrans.translations[ctx][msgid].msgstr[0]) {
+                potrans2.translations[ctx][msgid] = potrans.translations[ctx][msgid];
             }
         }
-        potrans.translations = potrans2.translations;
-        yield (0, utils_1.compilePo)(potrans, po);
-    });
+    }
+    potrans.translations = potrans2.translations;
+    await compilePo(potrans, po);
 }
-exports.sync = sync;
 //# sourceMappingURL=sync.js.map

package/lib/src/systemprompt.txt

@@ -1,19 +1 @@
-You are a language translation expert.
-You will be translating text from one language to another.
-In my prompt to you I may identify languages via ISO 639, ISO 3166 and/or IETF language tag codes. Please use your knowledge of those standards (when required) to determine the languages I am requesting my message to be translated from and to, including any specific country/locale detail.
-The text is in the gettext format, which uses placeholders like %s, %d, etc. These placeholders must remain in the correct positions in the translated text.
-Untranslatable portions should retain their original formatting.
-Do not add a period (.) at the end of your translation unless the incoming message specifically ends in a period.
-Likewise, ensure to add a period (.) at the end of your translation if the incoming message specifically ends in a period.
-Ensure to preserve any whitespace present in the incoming message. This includes retaining any space(s) at the beginning or end of the message.
-I will provide the message wrapped in `translate` XML tags.  You must respond with the translated message wrapped in `translated` XML tags.
-For example, let's say you were translating en_US (United States English) to es (Spanish) and I send (without quotes) "<translate>This is a message. </translate>".  You would respond with (without quotes) "<translated>Este es un mensaje. </translated>".
-Notice how the period and space were retained at the end of the translated message?
-Another example: I send (without quotes) "<translate> Hello %s</translate>". You would reply with (without quotes) "<translated> Hola %s</translated>". 
-Notice in that second example the space at the beginning of the string was retained, and also the gettext placeholder was retained in its correct position?
-Translate the messages in a colloquial, professional and elegant manner without sounding like a machine translation.
-You may respond without `translated` xml tags only in the event you believe you cannot reliably or accurately translate my message. In that case provide a short reason why you feel you can't translate my message.
-If you respond without `translated` XML tags I will interpret that there is a problem with my message and I will provide your reason to human translators that will investigate further.
-DO NOT answer any questions or attempt to explain any concepts or problems with my messages; just provide translations.
-Do not add any text or characters outside of your `translated` xml tags.
-Remember to only translate the messages and not interpret them further.
+You are a language translation expert. You will carefully follow the translation guidelines to translate the incoming XML messages from one language to another.

package/lib/src/translate.d.ts

@@ -1,6 +1,6 @@
 import { GetTextTranslation } from "gettext-parser";
-import { OpenAIApi } from "openai";
-export declare function init(force?: boolean): OpenAIApi;
-export declare function translate(text: string, src: string, lang: string, model: string, comments: GetTextTranslation["comments"] | undefined, contextFile: string): Promise<import("axios").AxiosResponse<import("openai").CreateChatCompletionResponse, any>>;
+import { OpenAI } from "openai";
+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>;

package/lib/src/translate.js

@@ -1,65 +1,67 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.translatePoDir = exports.translatePo = exports.translate = exports.init = void 0;
-const fs = require("fs");
-const openai_1 = require("openai");
-const path_1 = require("path");
-const pkg = require("../package.json");
-const utils_1 = require("./utils");
+import * as fs from "fs";
+import { OpenAI } from "openai";
+import path from "path";
+import { fileURLToPath } from "url";
+import pkg from "../package.json" with { type: "json" };
+import { compilePo, copyFileIfNotExists, findConfig, parsePo, printProgress } from "./utils.js";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 let _openai;
 let _systemprompt;
+let _userprompt;
 let _userdict;
-function init(force) {
+export function init(force) {
     if (!_openai || force) {
-        const configuration = new openai_1.Configuration({
-            apiKey: process.env.OPENAI_API_KEY,
-        });
+        let configuration = {
+            apiKey: process.env.OPENAI_API_KEY
+        };
+        _openai = new OpenAI(configuration);
         if (process.env.OPENAI_API_HOST) {
-            configuration.basePath = process.env.OPENAI_API_HOST.replace(/\/+$/, "") + "/v1";
+            _openai.baseURL = process.env.OPENAI_API_HOST.replace(/\/+$/, "") + "/v1";
         }
-        _openai = new openai_1.OpenAIApi(configuration);
     }
-    // load systemprompt.txt from homedir
+    // load systemprompt.txt from project
     if (!_systemprompt || force) {
-        const systemprompt = (0, utils_1.findConfig)("systemprompt.txt");
-        (0, utils_1.copyFileIfNotExists)(systemprompt, (0, path_1.join)(__dirname, "systemprompt.txt"));
-        _systemprompt = fs.readFileSync(systemprompt, "utf-8");
+        _systemprompt = fs.readFileSync(path.join(__dirname, "systemprompt.txt"), "utf-8");
+    }
+    // load userprompt.txt from project
+    if (!_userprompt || force) {
+        _userprompt = fs.readFileSync(path.join(__dirname, "userprompt.txt"), "utf-8");
     }
     // load dictionary.json from homedir
     if (!_userdict || force) {
-        const userdict = (0, utils_1.findConfig)("dictionary.json");
-        (0, utils_1.copyFileIfNotExists)(userdict, (0, path_1.join)(__dirname, "dictionary-template.json"));
-        _userdict = { "default": JSON.parse(fs.readFileSync(userdict, "utf-8")) };
+        const userdict = findConfig("dictionary.json");
+        copyFileIfNotExists(userdict, path.join(__dirname, "dictionary.json"));
+        _userdict = { default: JSON.parse(fs.readFileSync(userdict, "utf-8")) };
     }
     return _openai;
 }
-exports.init = init;
-function translate(text, src, lang, model, comments, contextFile) {
-    const lang_code = lang.toLowerCase().trim().replace(/[\W_]+/g, "-");
-    const dicts = Object.entries(_userdict[lang_code] || _userdict["default"])
-        .filter(([k, _]) => text.toLowerCase().includes(k.toLowerCase()))
-        .map(([k, v]) => [
-        { role: "user", content: k },
-        { role: "assistant", content: v },
-    ])
-        .flat();
-    var notes = "";
-    if (comments != undefined && comments.extracted != undefined)
-        notes = comments.extracted;
-    var context = "";
-    if (contextFile !== undefined)
-        context = "\n\n" + fs.readFileSync(contextFile, "utf-8");
-    return _openai.createChatCompletion({
-        model,
+export async function translate(src, lang, model, translations, contextFile) {
+    const lang_code = lang
+        .toLowerCase()
+        .trim()
+        .replace(/[\W_]+/g, "-");
+    const dicts = Object.entries(_userdict[lang_code] || _userdict["default"]).reduce((acc, [k, v], idx) => {
+        if (translations.some((tr) => tr.msgid.toLowerCase().includes(k.toLowerCase()))) {
+            acc.user.push(`<translate index="${idx + 1}">${k}</translate>`);
+            acc.assistant.push(`<translated index="${idx + 1}">${v}</translated>`);
+        }
+        return acc;
+    }, { user: [], assistant: [] });
+    const notes = translations
+        .reduce((acc, tr) => {
+        if (tr.comments?.extracted) {
+            acc.push(tr.comments?.extracted);
+        }
+        return acc;
+    }, [])
+        .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>`)
+        .join("\n");
+    const res = await _openai.chat.completions.create({
+        model: model,
         temperature: 0.1,
         messages: [
             {
@@ -68,95 +70,117 @@ function translate(text, src, lang, model, comments, contextFile) {
             },
             {
                 role: "user",
-                content: `Wait for my incoming message in "${src}" and translate it into "${lang}", carefully following your system prompt. ` + notes
+                content: `${_userprompt}\n\nWait for my incoming message in "${src}" and translate it into "${lang}"(a language code and an optional region code). ` +
+                    notes
             },
             {
                 role: "assistant",
-                content: `Understood, I will translate your incoming "${src}" message into "${lang}", carefully following my system prompt. Please go ahead and send your message for translation.`
+                content: `Understood, I will translate your incoming "${src}" message into "${lang}", carefully following guidelines. Please go ahead and send your message for translation.`
             },
-            // add userdict here
-            ...dicts,
+            // add userdict
+            ...(dicts.user.length > 0
+                ? [
+                    { role: "user", content: dicts.user.join("\n") },
+                    { role: "assistant", content: dicts.assistant.join("\n") }
+                ]
+                : []),
+            // add user translations
             {
                 role: "user",
-                content: "<translate>" + text + "</translate>"
-            },
-        ],
+                content: translationsContent
+            }
+        ]
     }, {
         timeout: 20000,
+        stream: false
+    });
+    const content = res.choices[0].message.content ?? "";
+    translations.forEach((trans, idx) => {
+        const tag = `<translated index="${idx + dicts.user.length + 1}">`;
+        const s = content.indexOf(tag);
+        if (s > -1) {
+            const e = content.indexOf("</translated>", s);
+            trans.msgstr[0] = content.slice(s + tag.length, e);
+        }
+        else {
+            console.error("Error: Unable to find translation for string [" + trans.msgid + "]");
+        }
     });
 }
-exports.translate = translate;
-function translatePo(model, po, source, lang, verbose, output, contextFile) {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        const potrans = yield (0, utils_1.parsePo)(po);
-        if (!lang)
-            lang = potrans.headers["Language"];
-        if (!lang) {
-            console.error("No language specified via po file or args");
-            return;
+export async function translatePo(model, po, source, lang, verbose, output, contextFile) {
+    const potrans = await parsePo(po);
+    if (!lang)
+        lang = potrans.headers["Language"];
+    if (!lang) {
+        console.error("No language specified via po file or args");
+        return;
+    }
+    // try to load dictionary by lang-code if it not loaded
+    const lang_code = lang
+        .toLowerCase()
+        .trim()
+        .replace(/[\W_]+/g, "-");
+    if (!_userdict[lang_code]) {
+        const lang_dic_file = findConfig(`dictionary-${lang_code}.json`);
+        if (fs.existsSync(lang_dic_file)) {
+            _userdict[lang_code] = JSON.parse(fs.readFileSync(lang_dic_file, "utf-8"));
+            console.log(`dictionary-${lang_code}.json is loaded.`);
         }
-        // try to load dictionary by lang-code if it not loaded
-        const lang_code = lang.toLowerCase().trim().replace(/[\W_]+/g, "-");
-        if (!_userdict[lang_code]) {
-            const lang_dic_file = (0, utils_1.findConfig)(`dictionary-${lang_code}.json`);
-            if (fs.existsSync(lang_dic_file)) {
-                _userdict[lang_code] = JSON.parse(fs.readFileSync(lang_dic_file, "utf-8"));
-                console.log(`dictionary-${lang_code}.json is loaded.`);
+    }
+    const list = [];
+    const trimRegx = /(?:^ )|(?: $)/;
+    let trimed = false;
+    for (const [ctx, entries] of Object.entries(potrans.translations)) {
+        for (const [msgid, trans] of Object.entries(entries)) {
+            if (msgid == "")
+                continue;
+            if (!trans.msgstr[0]) {
+                list.push(trans);
+                continue;
             }
-        }
-        const list = [];
-        const trimRegx = /(?:^ )|(?: $)/;
-        let trimed = false;
-        for (const [ctx, entries] of Object.entries(potrans.translations)) {
-            for (const [msgid, trans] of Object.entries(entries)) {
-                if (msgid == "")
-                    continue;
-                if (!trans.msgstr[0]) {
-                    list.push(trans);
-                    continue;
-                }
-                else if (trimRegx.test(trans.msgstr[0])) {
-                    trimed = true;
-                    trans.msgstr[0] = trans.msgstr[0].trim();
-                }
+            else if (trimRegx.test(trans.msgstr[0])) {
+                trimed = true;
+                trans.msgstr[0] = trans.msgstr[0].trim();
             }
         }
-        if (trimed) {
-            yield (0, utils_1.compilePo)(potrans, po);
+    }
+    if (trimed) {
+        await compilePo(potrans, po);
+    }
+    if (list.length == 0) {
+        console.log("done.");
+        return;
+    }
+    potrans.headers["Last-Translator"] = `gpt-po v${pkg.version}`;
+    const translations = [];
+    let err429 = false;
+    for (let i = 0, c = 0; i < list.length; i++) {
+        if (i == 0)
+            printProgress(i, list.length);
+        if (err429) {
+            // sleep for 20 seconds.
+            await new Promise((resolve) => setTimeout(resolve, 20000));
         }
-        if (list.length == 0) {
-            console.log("done.");
-            return;
+        const trans = list[i];
+        if (c < 2000) {
+            translations.push(trans);
+            c += trans.msgid.length;
         }
-        potrans.headers["Last-Translator"] = `gpt-po v${pkg.version}`;
-        let err429 = false;
-        let modified = false;
-        for (let i = 0; i < list.length; i++) {
-            if (i == 0)
-                (0, utils_1.printProgress)(i, list.length);
-            if (err429) {
-                // sleep for 20 seconds.
-                yield new Promise((resolve) => setTimeout(resolve, 20000));
-            }
-            const trans = list[i];
+        if (c >= 2000 || i == list.length - 1) {
             try {
-                const res = yield translate(trans.msgid, source, lang, model, trans.comments, contextFile);
-                var translated = ((_a = res.data.choices[0].message) === null || _a === void 0 ? void 0 : _a.content) || trans.msgstr[0];
-                if (!translated.startsWith('<translated>') && !translated.endsWith('</translated>')) {
-                    // We got an error response
-                    console.log("Error: Unable to translate string [" + trans.msgid + "]. Bot says [" + translated + "]");
-                    continue;
-                }
-                // We got a valid translation response
-                trans.msgstr[0] = translated.replace('<translated>', '').replace('</translated>', '');
-                modified = true;
+                await translate(source, lang, model, translations, contextFile);
                 if (verbose) {
-                    console.log(trans.msgid);
-                    console.log(trans.msgstr[0]);
+                    translations.forEach((trans) => {
+                        console.log(trans.msgid);
+                        console.log(trans.msgstr[0]);
+                    });
                 }
-                (0, utils_1.printProgress)(i + 1, list.length);
-                yield (0, utils_1.compilePo)(potrans, output || po);
+                translations.length = 0;
+                c = 0;
+                // update progress
+                printProgress(i + 1, list.length);
+                // save po file after each 2000 characters
+                await compilePo(potrans, output || po);
             }
             catch (error) {
                 if (error.response) {
@@ -178,21 +202,17 @@ function translatePo(model, po, source, lang, verbose, output, contextFile) {
                 }
             }
         }
-        console.log("done.");
-    });
+    }
+    console.log("done.");
 }
-exports.translatePo = translatePo;
-function translatePoDir(model = "gpt-3.5-turbo", dir, source, lang, verbose, contextFile) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const files = fs.readdirSync(dir);
-        for (const file of files) {
-            if (file.endsWith(".po")) {
-                const po = (0, path_1.join)(dir, file);
-                console.log(`translating ${po}`);
-                yield translatePo(model, po, source, lang, verbose, po, contextFile);
-            }
+export async function translatePoDir(model = "gpt-3.5-turbo", dir, source, lang, verbose, contextFile) {
+    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);
         }
-    });
+    }
 }
-exports.translatePoDir = translatePoDir;
 //# sourceMappingURL=translate.js.map

package/lib/src/userprompt.txt

@@ -0,0 +1,27 @@
+Translation guidelines are as follows:
+
+1. **Placeholder Handling**:
+   - Maintain the positions of placeholders (e.g., %s, %d, {example}) in the translated text. Do not translate placeholders.
+
+2. **Formatting**:
+   - Preserve the formatting of untranslatable portions.
+   - Retain any whitespace at the beginning or end of the message.
+   - Add or omit a period (.) at the end of your translation to match the incoming message.
+
+3. **XML Tags and Indexing**:
+   - 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**:
+   - 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.
+
+**Examples**:
+- Input:
+  `<translate index="1">This is a message. </translate>`
+  `<translate index="2"> Hello %s</translate>`
+- Output:
+  `<translated index="1">这是一条信息</translated>`
+  `<translated index="2"> 你好 %s</translated>`
+
+Do not answer questions or explain concepts. Only provide translations within `<translated>` XML tags unless you need to respond with a short error reason.

package/lib/src/utils.d.ts

@@ -8,7 +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 declare function compilePo(data: GetTextTranslations, poFile: string): Promise<void>;
+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 printProgress(progress: number, total: number, extra?: string): void;
 export declare function gitRootDir(dir?: string): string | null;
 /**

package/lib/src/utils.js

@@ -1,18 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.openFileExplorer = exports.findConfig = exports.gitRootDir = exports.printProgress = exports.compilePo = exports.parsePo = exports.openFileByDefault = exports.copyFileIfNotExists = void 0;
-const child_process_1 = require("child_process");
-const fs = require("fs");
-const gettext_parser_1 = require("gettext-parser");
-const os_1 = require("os");
-const path = require("path");
+import { exec, spawn } from "child_process";
+import * as fs from "fs";
+import { po } from "gettext-parser";
+import { homedir, platform } from "os";
+import * as path from "path";
 /**
  * copy source file to destination file if destination file does not exist
  * @param file destination file path
  * @param copyFile source file path
  * @param force force copy file
  */
-function copyFileIfNotExists(file, copyFile, force = false) {
+export function copyFileIfNotExists(file, copyFile, force = false) {
     // make sure the directory exists
     fs.mkdirSync(path.dirname(file), { recursive: true });
     // check if file exists else create it
@@ -27,28 +24,25 @@ function copyFileIfNotExists(file, copyFile, force = false) {
         fs.copyFileSync(copyFile, file);
     }
 }
-exports.copyFileIfNotExists = copyFileIfNotExists;
-function openFileByDefault(filePath) {
+export function openFileByDefault(filePath) {
     // Use the 'open' command on macOS or 'start' command on Windows to open the file with the default system editor
     const command = process.platform === "darwin" ? "open" : process.platform === "win32" ? "start" : "xdg-open";
     // Spawn a new process for the default editor and pass the file name as an argument
-    (0, child_process_1.spawn)(command, [filePath], { shell: true });
+    spawn(command, [filePath], { shell: true });
 }
-exports.openFileByDefault = openFileByDefault;
-function parsePo(poFile, defaultCharset) {
+export function parsePo(poFile, defaultCharset) {
     // read poFile as buffer, then parse it
     return new Promise((resolve, reject) => {
         fs.readFile(poFile, (err, buffer) => {
             if (err)
                 reject(err);
-            var result = gettext_parser_1.po.parse(buffer, defaultCharset !== null && defaultCharset !== void 0 ? defaultCharset : "utf-8");
+            const result = po.parse(buffer, defaultCharset ?? "utf-8");
             resolve(result);
         });
     });
 }
-exports.parsePo = parsePo;
-function compilePo(data, poFile) {
-    const buffer = gettext_parser_1.po.compile(data, { foldLength: 120 });
+export function compilePo(data, poFile, options = { foldLength: 120, sort: false, escapeCharacters: true }) {
+    const buffer = po.compile(data, options);
     return new Promise((resolve, reject) => {
         fs.writeFile(poFile, buffer, (err) => {
             if (err)
@@ -57,8 +51,7 @@ function compilePo(data, poFile) {
         });
     });
 }
-exports.compilePo = compilePo;
-function printProgress(progress, total, extra) {
+export function printProgress(progress, total, extra) {
     const percent = Math.floor((progress / total) * 100);
     const bar = Array(Math.floor(percent / 5))
         .fill("█")
@@ -68,8 +61,7 @@ function printProgress(progress, total, extra) {
         .join("");
     process.stdout.write(`\r${bar}${dots} ${percent}% ${progress}/${total} ${extra || ""}`);
 }
-exports.printProgress = printProgress;
-function gitRootDir(dir) {
+export function gitRootDir(dir) {
     // if dir is not provided, use current working directory
     dir = dir || process.cwd();
     // check if dir is a git repository
@@ -87,7 +79,6 @@ function gitRootDir(dir) {
         }
     }
 }
-exports.gitRootDir = gitRootDir;
 /**
  * find config file in the following order:
  * 1. current working directory of the Node.js process
@@ -96,15 +87,15 @@ exports.gitRootDir = gitRootDir;
  * @param fileName
  * @returns full path of the config file
  */
-function findConfig(fileName) {
+export function findConfig(fileName) {
     const currentDir = process.cwd();
     const gitDir = gitRootDir() || currentDir;
-    const homeDir = (0, os_1.homedir)();
+    const homeDir = homedir();
     const filePaths = [
         path.join(currentDir, ".gpt-po", fileName),
         path.join(currentDir, fileName),
         path.join(gitDir, ".gpt-po", fileName),
-        path.join(homeDir, ".gpt-po", fileName)
+        path.join(homeDir, ".gpt-po", fileName),
     ];
     // check if file exists and return the first one
     for (const filePath of filePaths) {
@@ -115,22 +106,20 @@ function findConfig(fileName) {
     // if no file exists, return the default one
     return path.join(homeDir, ".gpt-po", fileName);
 }
-exports.findConfig = findConfig;
 /**
  * open file explorer by platform
  * @param location folder or file path
  */
-function openFileExplorer(location) {
-    if ((0, os_1.platform)() === 'win32') {
-        (0, child_process_1.exec)(`explorer.exe "${path.dirname(location)}"`);
+export function openFileExplorer(location) {
+    if (platform() === "win32") {
+        exec(`explorer.exe "${path.dirname(location)}"`);
     }
-    else if ((0, os_1.platform)() === 'darwin') {
-        (0, child_process_1.exec)(`open "${path.dirname(location)}"`);
+    else if (platform() === "darwin") {
+        exec(`open "${path.dirname(location)}"`);
     }
     else {
         // Assuming a Linux-based system
-        (0, child_process_1.exec)(`xdg-open "${path.dirname(location)}"`);
+        exec(`xdg-open "${path.dirname(location)}"`);
     }
 }
-exports.openFileExplorer = openFileExplorer;
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "gpt-po",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "command tool for translate po files by gpt",
   "main": "lib/src/index.js",
+  "type": "module",
   "bin": {
     "gpt-po": "lib/src/index.js"
   },
@@ -33,23 +34,23 @@
     "openai"
   ],
   "devDependencies": {
-    "@types/gettext-parser": "^4.0.2",
-    "@types/jest": "^29.5.1",
-    "jest": "^29.5.0",
+    "@types/gettext-parser": "^4.0.4",
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0",
     "ncp": "^2.0.0",
-    "prettier": "^3.0.3",
-    "rimraf": "^5.0.0",
-    "ts-jest": "^29.1.0",
+    "prettier": "^3.3.3",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^5.0.4"
+    "typescript": "^5.5.4"
   },
   "dependencies": {
-    "commander": "^10.0.1",
-    "gettext-parser": "^6.0.0",
-    "openai": "^3.2.1"
+    "commander": "^12.1.0",
+    "gettext-parser": "^8.0.0",
+    "openai": "^4.56.0"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=18.0.0"
   }
 }