gpt-po 1.0.8 → 1.0.10

package/README.md

@@ -21,25 +21,29 @@ 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]
+Usage: gpt-po [options] [command]
 
 command tool for translate po files by gpt
 
 Options:
-  -V, --version        output the version number
-  -h, --help           display help for command
+  -V, --version           output the version number
+  -h, --help              display help for command
 
 Commands:
-  translate [options]  translate po file (default command)
-  sync [options]       update po from pot file
-  systemprompt         open/edit system prompt
-  userdict             open/edit user dictionary
-  help [command]       display help for command
+  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
 ```
 
 ```
@@ -60,3 +64,20 @@ Options:
   -o, --output <file>    output file path, overwirte po file by default
   -h, --help             display help for command
 ```
+
+```
+Usage: gpt-po remove [options]
+
+remove po entries by options
+
+Options:
+  --po <file>                       po file path
+  --fuzzy                           remove fuzzy entries
+  -obs, --obsolete                  remove obsolete entries
+  -ut, --untranslated               remove untranslated entries
+  -t, --translated                  remove translated entries
+  -tnf, --translated-not-fuzzy      remove translated not fuzzy entries
+  -ft, --fuzzy-translated           remove fuzzy translated entries
+  -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
+```

package/README_zh-CN.md

@@ -21,25 +21,29 @@ 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]
+Usage: gpt-po [options] [command]
 
 command tool for translate po files by gpt
 
 Options:
-  -V, --version        output the version number
-  -h, --help           display help for command
+  -V, --version           output the version number
+  -h, --help              display help for command
 
 Commands:
-  translate [options]  translate po file (default command)
-  sync [options]       update po from pot file
-  systemprompt         open/edit system prompt
-  userdict             open/edit user dictionary
-  help [command]       display help for command
+  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
 ```
 
 ```
@@ -53,10 +57,27 @@ Options:
   --model <model>        openai model (choices: "gpt-4", "gpt-4-0314", "gpt-4-32k", "gpt-4-32k-0314", "gpt-3.5-turbo", "gpt-3.5-turbo-0301",
                          default: "gpt-3.5-turbo")
   --po <file>            po file path
-  --dir <dir>            po files directory
+  --dir <dir>            po file directory
   -src, --source <lang>  source language (default: "english")
   --verbose              show verbose log
   -l, --lang <lang>      target language (default: "simplified chinese")
   -o, --output <file>    output file path, overwirte po file by default
   -h, --help             display help for command
 ```
+
+```
+Usage: gpt-po remove [options]
+
+remove po entries by options
+
+Options:
+  --po <file>                       po file path
+  --fuzzy                           remove fuzzy entries
+  -obs, --obsolete                  remove obsolete entries
+  -ut, --untranslated               remove untranslated entries
+  -t, --translated                  remove translated entries
+  -tnf, --translated-not-fuzzy      remove translated not fuzzy entries
+  -ft, --fuzzy-translated           remove fuzzy translated entries
+  -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
+```

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gpt-po",
-    "version": "1.0.8",
+    "version": "1.0.10",
     "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

@@ -15,6 +15,7 @@ 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();
 program.name(pkg.name).version(pkg.version).description(pkg.description);
 program
@@ -92,13 +93,47 @@ program
 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);
 });
+// program command `remove` with help text `remove po entries by options`
+program
+    .command("remove")
+    .description("remove po entries by options")
+    .requiredOption("--po <file>", "po file path")
+    .option("--fuzzy", "remove fuzzy entries")
+    .option("-obs, --obsolete", "remove obsolete entries")
+    .option("-ut, --untranslated", "remove untranslated entries")
+    .option("-t, --translated", "remove translated entries")
+    .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* () {
+    const { po, fuzzy, obsolete, untranslated, translated, translatedNotFuzzy, fuzzyTranslated, referenceContains } = args;
+    const options = {
+        fuzzy,
+        obsolete,
+        untranslated,
+        translated,
+        translatedNotFuzzy,
+        fuzzyTranslated,
+        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);
+    console.log("done");
+}));
 program.parse(process.argv);
 //# sourceMappingURL=index.js.map

package/lib/src/manipulate.d.ts

@@ -0,0 +1,14 @@
+import { GetTextTranslations } from "gettext-parser";
+export interface RemoveByOptions {
+    fuzzy?: boolean;
+    obsolete?: boolean;
+    untranslated?: boolean;
+    translated?: boolean;
+    translatedNotFuzzy?: boolean;
+    fuzzyTranslated?: boolean;
+    referenceContains?: string;
+}
+/**
+ * remove entity by options
+ */
+export declare function removeByOptions(potrans: GetTextTranslations, options: RemoveByOptions | undefined): GetTextTranslations;

package/lib/src/manipulate.js

@@ -0,0 +1,58 @@
+"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;
+    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)
+        : 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) || "")) {
+                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) || "")) {
+                delete potrans.translations[ctx][msgid];
+            }
+            // remove untranslated
+            if ((options === null || options === void 0 ? void 0 : 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) {
+                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) || "")) {
+                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) || "")) {
+                delete potrans.translations[ctx][msgid];
+            }
+            // remove reference contains
+            if (options === null || options === void 0 ? void 0 : 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)) {
+                        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)) {
+                    delete potrans.translations[ctx][msgid];
+                }
+            }
+        }
+    }
+    return potrans;
+}
+exports.removeByOptions = removeByOptions;
+//# sourceMappingURL=manipulate.js.map

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 },
@@ -56,7 +58,7 @@ function translate(text, src, lang, model = "gpt-3.5-turbo") {
         messages: [
             {
                 role: "system",
-                content: _systemprompt + ` Translate the ${src} user content into ${lang} language. Please translate it as a text, not as a table. The parts that cannot be translated will retain their original format.`
+                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,
@@ -70,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 = /(?:^ )|(?: $)/;

package/lib/src/utils.d.ts

@@ -11,4 +11,17 @@ export declare function parsePo(poFile: string, defaultCharset?: string): Promis
 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");
@@ -88,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;
@@ -107,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.8",
+  "version": "1.0.10",
   "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"
   }
-}
+}