scancscode 1.0.56 → 1.0.57

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,194 @@
1
+ # scancscode
2
+
3
+ C# 代码字符串提取与国际化处理工具集。
4
+
5
+ ## 功能简介
6
+
7
+ scancscode 是一个用于处理 C# 代码国际化的命令行工具集,主要功能包括:
8
+
9
+ - **扫描代码字符串**:从 C# 代码中自动提取需要国际化的字符串字面量, 生成 CSV 文件
10
+ - **CSV 文件处理**:合并、精简 CSV 语言文件
11
+ - **自动翻译**:调用翻译 API 批量翻译 CSV 文件中的内容
12
+
13
+ ## 安装
14
+
15
+ ```bash
16
+ # 克隆项目
17
+ git clone <repository-url>
18
+ cd scancscode
19
+
20
+ # 安装依赖
21
+ npm install
22
+
23
+ # 构建项目
24
+ npm run build
25
+ ```
26
+
27
+ ## 命令行工具
28
+
29
+ ### 1. scanliterals - 扫描代码字符串
30
+
31
+ 扫描 C# 代码中的字符串字面量,并输出到 CSV 文件。
32
+
33
+ ```bash
34
+ npx scanliterals --cscodedir <目录> --configdir <目录> --outcsv <文件> --langs <语言>
35
+ ```
36
+
37
+ **参数说明**:
38
+
39
+ | 参数 | 说明 |
40
+ | ------------- | --------------- |
41
+ | `--cscodedir` | C# 代码目录,支持多个目录 |
42
+ | `--configdir` | 配置文件目录,支持多个目录 |
43
+ | `--outcsv` | 输出 CSV 文件路径 |
44
+ | `--langs` | 语言列表(默认 zh\_cn) |
45
+ | `--verbose` | 显示详细日志 |
46
+
47
+ **示例**:
48
+
49
+ ```bash
50
+ npx scanliterals \
51
+ --cscodedir ./GameClient/Assets/Bundles/FGUI/ \
52
+ --configdir ./GameClient/Assets/Bundles/GameConfigs/ \
53
+ --outcsv ./output/Translation.csv \
54
+ --langs zh_cn
55
+ ```
56
+
57
+ ### 2. slimlangs - 精简 CSV 文件列
58
+
59
+ 将多个 CSV 文件合并,并按指定语言列表精简列。
60
+
61
+ ```bash
62
+ npx slimlangs --incsv <文件> --outcsv <文件> --langs <语言>
63
+ ```
64
+
65
+ **参数说明**:
66
+
67
+ | 参数 | 说明 |
68
+ | ---------- | ------------------ |
69
+ | `--incsv` | 输入 CSV 文件路径,支持多个文件 |
70
+ | `--outcsv` | 输出 CSV 文件路径 |
71
+ | `--langs` | 要保留的语言列表 |
72
+
73
+ **示例**:
74
+
75
+ ```bash
76
+ npx slimlangs \
77
+ --incsv ./Auto.csv ./Manual.csv \
78
+ --outcsv ./ScriptTrans.csv \
79
+ --langs zh_cn
80
+ ```
81
+
82
+ ### 3. transcsv - 翻译 CSV 文件
83
+
84
+ 使用翻译 API 将 CSV 文件中的内容从源语言翻译到目标语言。
85
+
86
+ - 暂时仅支持小牛翻译API: <https://niutrans.com/documents/contents/transapi_batch_v2#accessMode>
87
+
88
+ ```bash
89
+ npx transcsv --incsv <文件> --outcsv <文件> --fromLang <语言> --toLangs <语言> --apiKey <密钥> --appId <应用ID>
90
+ ```
91
+
92
+ **参数说明**:
93
+
94
+ | 参数 | 说明 |
95
+ | ------------ | ------------- |
96
+ | `--incsv` | 输入 CSV 文件路径 |
97
+ | `--outcsv` | 输出 CSV 文件路径 |
98
+ | `--fromLang` | 源语言(如 zh\_cn) |
99
+ | `--toLangs` | 目标语言列表 |
100
+ | `--apiKey` | 翻译 API 密钥 |
101
+ | `--appId` | 翻译 API 应用 ID |
102
+
103
+ **示例**:
104
+
105
+ ```bash
106
+ npx transcsv \
107
+ --incsv ./ScriptTrans.csv \
108
+ --outcsv ./ScriptTrans_translated.csv \
109
+ --fromLang zh_cn \
110
+ --toLangs zh_hk en_us \
111
+ --apiKey your_api_key \
112
+ --appId your_app_id
113
+ ```
114
+
115
+ ## 核心模块
116
+
117
+ ### CSharpStringExtractor
118
+
119
+ C# 代码字符串提取器,支持多种字符串格式:
120
+
121
+ - 普通字符串:`"Hello World"`
122
+ - 插值字符串:`$"Hello {name}"`
123
+ - 原生插值字符串:`$@"Hello {name}"`
124
+ - string.Format 调用:`string.Format("Hello {0}", name)`
125
+ - Tr.Format 调用:`Tr.Format("Hello {0}", name)`
126
+ - .text/.title 赋值:`label.text = "Hello"`
127
+ - 三元表达式:`condition ? "Yes" : "No"`
128
+ - 字符串拼接:`"Hello " + name`
129
+ - switch case:`case "value":`
130
+
131
+ ### CsvAutoTranslator
132
+
133
+ CSV 文件自动翻译器,基于百度翻译 API 实现批量翻译功能。
134
+
135
+ ### CSVUtils
136
+
137
+ CSV 文件处理工具集,提供 CSV 文件的读取、写入、合并和精简功能。
138
+
139
+ ## 工作流示例
140
+
141
+ ### 完整国际化处理流程
142
+
143
+ ```bash
144
+ # 步骤 1: 扫描代码中的字符串字面量
145
+ npx scanliterals \
146
+ --cscodedir ./GameClient/Assets/Bundles/FGUI/ \
147
+ --configdir ./GameClient/Assets/Bundles/GameConfigs/ \
148
+ --outcsv ./Translation/Auto.csv \
149
+ --langs zh_cn
150
+
151
+ # 步骤 2: 合并并精简 CSV(可选)
152
+ npx slimlangs \
153
+ --incsv ./Translation/Auto.csv ./Translation/Manual.csv \
154
+ --outcsv ./Translation/ScriptTrans.csv \
155
+ --langs zh_cn
156
+
157
+ # 步骤 3: 翻译到目标语言
158
+ npx transcsv \
159
+ --incsv ./Translation/ScriptTrans.csv \
160
+ --outcsv ./Translation/ScriptTrans.csv \
161
+ --fromLang zh_cn \
162
+ --toLangs zh_hk \
163
+ --apiKey your_api_key \
164
+ --appId your_app_id
165
+ ```
166
+
167
+ ## 开发
168
+
169
+ ### 运行测试
170
+
171
+ ```bash
172
+ npm test
173
+ ```
174
+
175
+ ### 构建项目
176
+
177
+ ```bash
178
+ npm run build
179
+ ```
180
+
181
+ ## 语言代码参考
182
+
183
+ | 语言 | 代码 |
184
+ | -------- | ------ |
185
+ | 简体中文 | zh\_cn |
186
+ | 繁体中文(香港) | zh\_hk |
187
+ | 繁体中文(台湾) | zh\_tw |
188
+ | 英语 | en\_us |
189
+ | 日语 | ja\_jp |
190
+ | 韩语 | ko\_kr |
191
+
192
+ ## 许可证
193
+
194
+ ISC
@@ -224,9 +224,114 @@ class CsvAutoTranslator {
224
224
  return result;
225
225
  }
226
226
  langMap = new Map([
227
- ["zh_cn", "zh"],
228
- ["zh_hk", "cht"],
229
- ["en_us", "en"],
227
+ // 中文相关
228
+ ["zh_cn", "zh"], // 简体中文
229
+ ["zh_hk", "cht"], // 香港繁体中文
230
+ ["zh_tw", "cht"], // 台湾繁体中文
231
+ // 英语相关
232
+ ["en_us", "en"], // 美式英语
233
+ ["en_gb", "en"], // 英式英语
234
+ ["en_au", "en"], // 澳大利亚英语
235
+ ["en_ca", "en"], // 加拿大英语
236
+ ["en_nz", "en"], // 新西兰英语
237
+ // 日语
238
+ ["ja_jp", "ja"], // 日语
239
+ // 韩语
240
+ ["ko_kr", "ko"], // 韩语
241
+ // 法语
242
+ ["fr_fr", "fr"], // 法语
243
+ ["fr_ca", "fr"], // 加拿大法语
244
+ // 德语
245
+ ["de_de", "de"], // 德语
246
+ // 西班牙语
247
+ ["es_es", "es"], // 西班牙语
248
+ ["es_mx", "es"], // 墨西哥西班牙语
249
+ // 俄语
250
+ ["ru_ru", "ru"], // 俄语
251
+ // 葡萄牙语
252
+ ["pt_pt", "pt"], // 葡萄牙语
253
+ ["pt_br", "pt"], // 巴西葡萄牙语
254
+ // 意大利语
255
+ ["it_it", "it"], // 意大利语
256
+ // 阿拉伯语
257
+ ["ar_sa", "ar"], // 阿拉伯语
258
+ // 荷兰语
259
+ ["nl_nl", "nl"], // 荷兰语
260
+ // 瑞典语
261
+ ["sv_se", "sv"], // 瑞典语
262
+ // 丹麦语
263
+ ["da_dk", "da"], // 丹麦语
264
+ // 挪威语
265
+ ["no_no", "no"], // 挪威语
266
+ ["nb_no", "no"], // 挪威语(博克马尔语)
267
+ // 芬兰语
268
+ ["fi_fi", "fi"], // 芬兰语
269
+ // 波兰语
270
+ ["pl_pl", "pl"], // 波兰语
271
+ // 匈牙利语
272
+ ["hu_hu", "hu"], // 匈牙利语
273
+ // 捷克语
274
+ ["cs_cz", "cs"], // 捷克语
275
+ // 斯洛伐克语
276
+ ["sk_sk", "sk"], // 斯洛伐克语
277
+ // 罗马尼亚语
278
+ ["ro_ro", "ro"], // 罗马尼亚语
279
+ // 希腊语
280
+ ["el_gr", "el"], // 希腊语
281
+ // 土耳其语
282
+ ["tr_tr", "tr"], // 土耳其语
283
+ // 希伯来语
284
+ ["he_il", "he"], // 希伯来语
285
+ // 印地语
286
+ ["hi_in", "hi"], // 印地语
287
+ // 泰语
288
+ ["th_th", "th"], // 泰语
289
+ // 越南语
290
+ ["vi_vn", "vi"], // 越南语
291
+ // 印尼语
292
+ ["id_id", "id"], // 印尼语
293
+ // 马来语
294
+ ["ms_my", "ms"], // 马来语
295
+ // 菲律宾语
296
+ ["tl_ph", "tl"], // 菲律宾语
297
+ // 乌克兰语
298
+ ["uk_ua", "uk"], // 乌克兰语
299
+ // 保加利亚语
300
+ ["bg_bg", "bg"], // 保加利亚语
301
+ // 克罗地亚语
302
+ ["hr_hr", "hr"], // 克罗地亚语
303
+ // 塞尔维亚语
304
+ ["sr_rs", "sr"], // 塞尔维亚语
305
+ // 斯洛文尼亚语
306
+ ["sl_si", "sl"], // 斯洛文尼亚语
307
+ // 爱沙尼亚语
308
+ ["et_ee", "et"], // 爱沙尼亚语
309
+ // 拉脱维亚语
310
+ ["lv_lv", "lv"], // 拉脱维亚语
311
+ // 立陶宛语
312
+ ["lt_lt", "lt"], // 立陶宛语
313
+ // 波斯语
314
+ ["fa_ir", "fa"], // 波斯语
315
+ // 乌尔都语
316
+ ["ur_pk", "ur"], // 乌尔都语
317
+ // 孟加拉语
318
+ ["bn_in", "bn"], // 孟加拉语
319
+ // 泰米尔语
320
+ ["ta_in", "ta"], // 泰米尔语
321
+ // 泰卢固语
322
+ ["te_in", "te"], // 泰卢固语
323
+ // 卡纳达语
324
+ ["kn_in", "kn"], // 卡纳达语
325
+ // 马拉雅拉姆语
326
+ ["ml_in", "ml"], // 马拉雅拉姆语
327
+ // 古吉拉特语
328
+ ["gu_in", "gu"], // 古吉拉特语
329
+ // 马拉地语
330
+ ["mr_in", "mr"], // 马拉地语
331
+ // 奥里亚语
332
+ ["or_in", "or"], // 奥里亚语
333
+ // 阿萨姆语
334
+ ["as_in", "as"] // 阿萨姆语
230
335
  ]);
231
336
  async translateCsvRows(rows, fromLang, toLangs) {
232
337
  if (rows.length === 0) {