gpt-po 1.0.7 → 1.0.9

package/README.md

@@ -21,9 +21,12 @@ Set `OPENAI_API_KEY` before using this tool.
 
 - `gpt-po sync --po <file> --pot <file>` Update the po file based on the pot file, while preserving the original translations.
 - `gpt-po --po <file>` Translate specified po files to a designated target language. By default, the target language is Simplified Chinese.
+- `gpt-po --po <file> --lang <lang>` Translate specified po files to a designated target language.
 - `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-simplified-chinese.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 [command] [options]

package/README_zh-CN.md

@@ -21,9 +21,12 @@ npm install gpt-po
 
 - `gpt-po sync --po <file> --pot <file>` 根据pot文件更新po文件，保留原有翻译
 - `gpt-po --po <file>` 翻译指定的po文件到指定的目标语言，默认目标语言是简体中文
+- `gpt-po --po <file> --lang <lang>` Translate specified po files to a designated target language.
 - `gpt-po --dir .` 翻译当前目录下的所有po文件到指定的目标语言，默认目标语言是简体中文
 - `gpt-po userdict` 修改或查看用户字典
+- `gpt-po userdict --explore` 用于浏览字典目录, 如果你想要增加或修改现有的字典。字典可以按`dictionary-<lang>.json`格式命令, 例如, `dictionary-simplified-chinese.json` 是针对简体中文的字典.
 - `gpt-po systemprompt` 修改或查看系统提示词，如果你不确定如何使用，可以不用修改
+- `gpt-po systemprompt --reset` 重置系统提示词
 
 ```
 Usage: gpt-po [command] [options]

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gpt-po",
-    "version": "1.0.7",
+    "version": "1.0.9",
     "description": "command tool for translate po files by gpt",
     "main": "lib/src/index.js",
     "bin": {
@@ -37,7 +37,7 @@
         "@types/jest": "^29.5.1",
         "jest": "^29.5.0",
         "ncp": "^2.0.0",
-        "prettier": "^3.0.0-alpha.7-for-vscode",
+        "prettier": "^3.0.3",
         "rimraf": "^5.0.0",
         "ts-jest": "^29.1.0",
         "tslint": "^6.1.3",

package/lib/src/index.js

@@ -46,6 +46,11 @@ program
     if (key) {
         process.env.OPENAI_API_KEY = key;
     }
+    // process.env.OPENAI_API_KEY is not set, exit
+    if (!process.env.OPENAI_API_KEY) {
+        console.error("OPENAI_API_KEY is required");
+        process.exit(1);
+    }
     (0, translate_1.init)();
     if (po) {
         yield (0, translate_1.translatePo)(model, po, source, lang, verbose, output);
@@ -70,23 +75,34 @@ program
 program
     .command("systemprompt")
     .description("open/edit system prompt")
-    .action(() => {
+    .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);
+    (0, utils_1.copyFileIfNotExists)(promptFile, copyFile, reset);
+    if (reset) {
+        console.log("systemprompt.txt reset to default");
+    }
     (0, utils_1.openFileByDefault)(promptFile);
 });
 // program command `userdict` with help text `open/edit user dictionary`
 program
     .command("userdict")
     .description("open/edit user dictionary")
-    .action(() => {
+    .option("--explore", "open user dictionary directory")
+    .action((args) => {
+    const { explore } = 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");
+    if (explore) {
+        // open user dictionary directory
+        return (0, utils_1.openFileExplorer)(dictFile);
+    }
     (0, utils_1.copyFileIfNotExists)(dictFile, copyFile);
     (0, utils_1.openFileByDefault)(dictFile);
 });

package/lib/src/systemprompt.txt

@@ -1 +1 @@
-You are a translation expert, follow the user's instructions carefully, translate the text in a colloquial, professional and elegant manner without sounding like a machine translation. Remember to only translate the text and not further interpret it.
+You are a translation expert, translate the text in a colloquial, professional and elegant manner without sounding like a machine translation. Remember to only translate the text and not interpret it further.

package/lib/src/translate.js

@@ -38,13 +38,15 @@ function init(force) {
     if (!_userdict || force) {
         const userdict = (0, utils_1.findConfig)("dictionary.json");
         (0, utils_1.copyFileIfNotExists)(userdict, (0, path_1.join)(__dirname, "dictionary.json"));
-        _userdict = JSON.parse(fs.readFileSync(userdict, "utf-8"));
+        _userdict = { "default": JSON.parse(fs.readFileSync(userdict, "utf-8")) };
     }
     return _openai;
 }
 exports.init = init;
 function translate(text, src, lang, model = "gpt-3.5-turbo") {
-    const dicts = Object.entries(_userdict)
+    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 },
@@ -54,14 +56,9 @@ function translate(text, src, lang, model = "gpt-3.5-turbo") {
         model,
         temperature: 0.1,
         messages: [
-            { role: "system", content: _systemprompt },
             {
-                role: "user",
-                content: `Translate the ${src} content I will post later into ${lang}, and keep the untranslated parts such as symbols in the result.`,
-            },
-            {
-                role: "assistant",
-                content: "Sure, Please send me the content that needs to be translated.",
+                role: "system",
+                content: _systemprompt + ` Translate the ${src} content provided by the user into ${lang}. Please translate it as a text, not as a table. The parts that cannot be translated will retain their original format.`
             },
             // add userdict here
             ...dicts,
@@ -75,6 +72,15 @@ exports.translate = translate;
 function translatePo(model = "gpt-3.5-turbo", po, source, lang, verbose, output) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
+        // 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 potrans = yield (0, utils_1.parsePo)(po);
         const list = [];
         const trimRegx = /(?:^ )|(?: $)/;
@@ -136,6 +142,9 @@ function translatePo(model = "gpt-3.5-turbo", po, source, lang, verbose, output)
                 }
                 else {
                     console.error(error.message);
+                    if (error.code == "ECONNABORTED") {
+                        console.log('you may need to set "HTTPS_PROXY" to reach openai api.');
+                    }
                 }
             }
         }

package/lib/src/utils.d.ts

@@ -3,11 +3,25 @@ import { GetTextTranslations } from "gettext-parser";
  * 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
  */
-export declare function copyFileIfNotExists(file: string, copyFile: string): void;
+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 declare function printProgress(progress: number, total: number, extra?: string): void;
 export declare function gitRootDir(dir?: string): string | null;
+/**
+ * find config file in the following order:
+ * 1. current directory
+ * 2. git root directory
+ * 3. home directory
+ * @param fileName
+ * @returns full path of the config file
+ */
 export declare function findConfig(fileName: string): string;
+/**
+ * open file explorer by platform
+ * @param location folder or file path
+ */
+export declare function openFileExplorer(location: string): void;

package/lib/src/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findConfig = exports.gitRootDir = exports.printProgress = exports.compilePo = exports.parsePo = exports.openFileByDefault = exports.copyFileIfNotExists = void 0;
+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");
@@ -10,15 +10,18 @@ const path = require("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) {
+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
     try {
         fs.accessSync(file, fs.constants.F_OK);
-        // check if the file is empty else copy the file
-        fs.statSync(file).size === 0 && fs.copyFileSync(copyFile, file);
+        // check if the file is empty or force, copy the file
+        if (force || fs.statSync(file).size === 0) {
+            fs.copyFileSync(copyFile, file);
+        }
     }
     catch (err) {
         fs.copyFileSync(copyFile, file);
@@ -85,6 +88,14 @@ function gitRootDir(dir) {
     }
 }
 exports.gitRootDir = gitRootDir;
+/**
+ * find config file in the following order:
+ * 1. current directory
+ * 2. git root directory
+ * 3. home directory
+ * @param fileName
+ * @returns full path of the config file
+ */
 function findConfig(fileName) {
     const currentDir = process.cwd();
     const gitDir = gitRootDir() || currentDir;
@@ -104,4 +115,21 @@ function findConfig(fileName) {
     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)}"`);
+    }
+    else if ((0, os_1.platform)() === 'darwin') {
+        (0, child_process_1.exec)(`open "${path.dirname(location)}"`);
+    }
+    else {
+        // Assuming a Linux-based system
+        (0, child_process_1.exec)(`xdg-open "${path.dirname(location)}"`);
+    }
+}
+exports.openFileExplorer = openFileExplorer;
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gpt-po",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "command tool for translate po files by gpt",
   "main": "lib/src/index.js",
   "bin": {
@@ -37,7 +37,7 @@
     "@types/jest": "^29.5.1",
     "jest": "^29.5.0",
     "ncp": "^2.0.0",
-    "prettier": "^3.0.0-alpha.7-for-vscode",
+    "prettier": "^3.0.3",
     "rimraf": "^5.0.0",
     "ts-jest": "^29.1.0",
     "tslint": "^6.1.3",
@@ -52,4 +52,4 @@
   "engines": {
     "node": ">=12.0.0"
   }
-}
+}