forked from microsoft/pxt
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcrowdin.ts
More file actions
357 lines (328 loc) · 17.3 KB
/
crowdin.ts
File metadata and controls
357 lines (328 loc) · 17.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
import * as nodeutil from './nodeutil';
import * as fs from 'fs';
import * as path from 'path';
import Map = pxt.Map;
import * as commandParser from './commandparser';
interface CrowdinCredentials { prj: string; key: string; branch: string; }
function crowdinCredentialsAsync(): Promise<CrowdinCredentials> {
const prj = pxt.appTarget.appTheme.crowdinProject;
const branch = pxt.appTarget.appTheme.crowdinBranch;
if (!prj) {
pxt.log(`crowdin upload skipped, Crowdin project missing in target theme`);
return Promise.resolve(undefined);
}
let key: string;
if (pxt.crowdin.testMode)
key = pxt.crowdin.TEST_KEY;
else
key = process.env[pxt.crowdin.KEY_VARIABLE];
if (!key) {
pxt.log(`Crowdin operation skipped: '${pxt.crowdin.KEY_VARIABLE}' variable is missing`);
return Promise.resolve(undefined);
}
return Promise.resolve({ prj, key, branch });
}
export function uploadTargetTranslationsAsync(parsed?: commandParser.ParsedCommand) {
const uploadDocs = parsed && !!parsed.flags["docs"];
const uploadApiStrings = parsed && !!parsed.flags["apis"]
if (parsed && !!parsed.flags["test"])
pxt.crowdin.setTestMode();
return internalUploadTargetTranslationsAsync(uploadApiStrings, uploadDocs);
}
export function internalUploadTargetTranslationsAsync(uploadApiStrings: boolean, uploadDocs: boolean) {
pxt.log(`uploading translations (apis ${uploadApiStrings ? "yes" : "no"}, docs ${uploadDocs ? "yes" : "no"})...`);
return crowdinCredentialsAsync()
.then(cred => {
if (!cred) return Promise.resolve();
pxt.log("got Crowdin credentials");
const crowdinDir = pxt.appTarget.id;
if (crowdinDir == "core") {
if (!uploadDocs) {
pxt.log('missing --docs flag, skipping')
return Promise.resolve();
}
return uploadDocsTranslationsAsync("docs", crowdinDir, cred.branch, cred.prj, cred.key)
.then(() => uploadDocsTranslationsAsync("common-docs", crowdinDir, cred.branch, cred.prj, cred.key))
} else {
let p = Promise.resolve();
if (uploadApiStrings)
p = p.then(() => execCrowdinAsync("upload", "built/target-strings.json", crowdinDir))
.then(() => fs.existsSync("built/sim-strings.json") ? execCrowdinAsync("upload", "built/sim-strings.json", crowdinDir) : Promise.resolve())
.then(() => uploadBundledTranslationsAsync(crowdinDir, cred.branch, cred.prj, cred.key));
else
p = p.then(() => pxt.log(`translations: skipping api strings upload`));
if (uploadDocs)
p = p.then(() => uploadDocsTranslationsAsync("docs", crowdinDir, cred.branch, cred.prj, cred.key))
// scan for docs in bundled packages
.then(() => Promise.all(pxt.appTarget.bundleddirs
// there must be a folder under .../docs
.filter(pkgDir => nodeutil.existsDirSync(path.join(pkgDir, "docs")))
// upload to crowdin
.map(pkgDir => uploadDocsTranslationsAsync(path.join(pkgDir, "docs"), crowdinDir, cred.branch, cred.prj, cred.key)
)).then(() => {
pxt.log("docs uploaded");
}));
else
p = p.then(() => pxt.log(`translations: skipping docs upload`));
return p;
}
});
}
function uploadDocsTranslationsAsync(srcDir: string, crowdinDir: string, branch: string, prj: string, key: string): Promise<void> {
pxt.log(`uploading from ${srcDir} to ${crowdinDir} under project ${prj}/${branch || ""}`)
let ignoredDirectories: Map<boolean> = {};
nodeutil.allFiles(srcDir).filter(d => nodeutil.fileExistsSync(path.join(path.dirname(d), ".crowdinignore"))).forEach(f => ignoredDirectories[path.dirname(f)] = true);
const ignoredDirectoriesList = Object.keys(ignoredDirectories);
const todo = nodeutil.allFiles(srcDir).filter(f => /\.md$/.test(f) && !/_locales/.test(f)).reverse();
const knownFolders: Map<boolean> = {};
const ensureFolderAsync = (crowdd: string) => {
if (!knownFolders[crowdd]) {
knownFolders[crowdd] = true;
pxt.log(`creating folder ${crowdd}`);
return pxt.crowdin.createDirectoryAsync(branch, prj, key, crowdd);
}
return Promise.resolve();
}
const nextFileAsync = (f: string): Promise<void> => {
if (!f) return Promise.resolve();
const crowdf = path.join(crowdinDir, f);
const crowdd = path.dirname(crowdf);
// check if file should be ignored
if (ignoredDirectoriesList.filter(d => path.dirname(f).indexOf(d) == 0).length > 0) {
pxt.log(`skpping ${f} because of .crowdinignore file`)
return nextFileAsync(todo.pop());
}
const data = fs.readFileSync(f, 'utf8');
pxt.log(`uploading ${f} to ${crowdf}`);
return ensureFolderAsync(crowdd)
.then(() => pxt.crowdin.uploadTranslationAsync(branch, prj, key, crowdf, data))
.then(() => nextFileAsync(todo.pop()));
}
return ensureFolderAsync(path.join(crowdinDir, srcDir))
.then(() => nextFileAsync(todo.pop()));
}
function uploadBundledTranslationsAsync(crowdinDir: string, branch: string, prj: string, key: string): Promise<void> {
const todo: string[] = [];
pxt.appTarget.bundleddirs.forEach(dir => {
const locdir = path.join(dir, "_locales");
if (fs.existsSync(locdir))
fs.readdirSync(locdir)
.filter(f => /strings\.json$/i.test(f))
.forEach(f => todo.push(path.join(locdir, f)))
});
pxt.log(`uploading bundled translations to Crowdin (${todo.length} files)`);
const nextFileAsync = (): Promise<void> => {
const f = todo.pop();
if (!f) return Promise.resolve();
const data = JSON.parse(fs.readFileSync(f, 'utf8')) as Map<string>;
const crowdf = path.join(crowdinDir, path.basename(f));
pxt.log(`uploading ${f} to ${crowdf}`);
return pxt.crowdin.uploadTranslationAsync(branch, prj, key, crowdf, JSON.stringify(data))
.then(nextFileAsync);
}
return nextFileAsync();
}
export function downloadTargetTranslationsAsync(parsed?: commandParser.ParsedCommand) {
const name = (parsed && parsed.args[0]) || "";
const crowdinDir = pxt.appTarget.id;
return crowdinCredentialsAsync()
.then(cred => {
if (!cred) return Promise.resolve();
return downloadFilesAsync(cred, ["sim-strings.json"], "sim")
.then(() => downloadFilesAsync(cred, ["target-strings.json"], "target"))
.then(() => {
const files: string[] = [];
pxt.appTarget.bundleddirs
.filter(dir => !name || dir == "libs/" + name)
.forEach(dir => {
const locdir = path.join(dir, "_locales");
if (fs.existsSync(locdir))
fs.readdirSync(locdir)
.filter(f => /\.json$/i.test(f))
.forEach(f => files.push(path.join(locdir, f)))
});
return downloadFilesAsync(cred, files, "bundled");
});
});
function downloadFilesAsync(cred: CrowdinCredentials, todo: string[], outputName: string) {
const locs: pxt.Map<pxt.Map<string>> = {};
const nextFileAsync = (): Promise<void> => {
const f = todo.pop();
if (!f) {
return Promise.resolve();
}
const errors: pxt.Map<number> = {};
const fn = path.basename(f);
const crowdf = path.join(crowdinDir, fn);
const locdir = path.dirname(f);
const projectdir = path.dirname(locdir);
pxt.log(`downloading ${crowdf}`);
pxt.debug(`projectdir: ${projectdir}`)
return pxt.crowdin.downloadTranslationsAsync(cred.branch, cred.prj, cred.key, crowdf, { translatedOnly: true, validatedOnly: true })
.then(data => {
Object.keys(data)
.filter(lang => Object.keys(data[lang]).some(k => !!data[lang][k]))
.forEach(lang => {
const dataLang = data[lang];
const langTranslations = stringifyTranslations(dataLang);
if (!langTranslations) return;
// validate translations
if (/-strings\.json$/.test(fn) && !/jsdoc-strings\.json$/.test(fn)) {
// block definitions
Object.keys(dataLang).forEach(id => {
const tr = dataLang[id];
pxt.blocks.normalizeBlock(tr, err => {
const errid = `${fn}.${lang}`;
errors[`${fn}.${lang}`] = 1
pxt.log(`error ${errid}: ${err}`)
});
});
}
// merge translations
let strings = locs[lang];
if (!strings) strings = locs[lang] = {};
Object.keys(dataLang)
.filter(k => !!dataLang[k] && !strings[k])
.forEach(k => strings[k] = dataLang[k]);
})
const errorIds = Object.keys(errors);
if (errorIds.length) {
pxt.log(`${errorIds.length} errors`);
errorIds.forEach(blockid => pxt.log(`error in ${blockid}`));
pxt.reportError("loc.errors", "invalid translation", errors);
}
return nextFileAsync()
});
}
return nextFileAsync()
.then(() => {
Object.keys(locs).forEach(lang => {
const tf = path.join(`sim/public/locales/${lang}/${outputName}-strings.json`);
pxt.log(`writing ${tf}`);
const dataLang = locs[lang];
const langTranslations = stringifyTranslations(dataLang);
nodeutil.writeFileSync(tf, langTranslations, { encoding: "utf8" });
})
})
}
}
function stringifyTranslations(strings: pxt.Map<string>): string {
const trg: pxt.Map<string> = {};
Object.keys(strings).sort().forEach(k => {
const v = strings[k].trim();
if (v) trg[k] = v;
})
if (Object.keys(trg).length == 0) return undefined;
else return JSON.stringify(trg, null, 2);
}
export function execCrowdinAsync(cmd: string, ...args: string[]): Promise<void> {
pxt.log(`executing Crowdin command ${cmd}...`);
const prj = pxt.appTarget.appTheme.crowdinProject;
if (!prj) {
console.log(`crowdin operation skipped, crowdin project not specified in pxtarget.json`);
return Promise.resolve();
}
const branch = pxt.appTarget.appTheme.crowdinBranch;
return crowdinCredentialsAsync()
.then(crowdinCredentials => {
if (!crowdinCredentials) return Promise.resolve();
const key = crowdinCredentials.key;
cmd = cmd.toLowerCase();
if (!args[0] && (cmd != "clean" && cmd != "stats")) throw new Error(cmd == "status" ? "language missing" : "filename missing");
switch (cmd) {
case "stats": return statsCrowdinAsync(prj, key, args[0]);
case "clean": return cleanCrowdinAsync(prj, key, args[0] || "docs");
case "upload": return uploadCrowdinAsync(branch, prj, key, args[0], args[1]);
case "download": {
if (!args[1]) throw new Error("output path missing");
const fn = path.basename(args[0]);
return pxt.crowdin.downloadTranslationsAsync(branch, prj, key, args[0], { translatedOnly: true, validatedOnly: true })
.then(r => {
Object.keys(r).forEach(k => {
const rtranslations = stringifyTranslations(r[k]);
if (!rtranslations) return;
nodeutil.mkdirP(path.join(args[1], k));
const outf = path.join(args[1], k, fn);
console.log(`writing ${outf}`)
nodeutil.writeFileSync(
outf,
rtranslations,
{ encoding: "utf8" });
})
})
}
default: throw new Error("unknown command");
}
})
}
function cleanCrowdinAsync(prj: string, key: string, dir: string): Promise<void> {
const p = pxt.appTarget.id + "/" + dir;
return pxt.crowdin.listFilesAsync(prj, key, p)
.then(files => {
files.filter(f => !nodeutil.fileExistsSync(f.fullName.substring(pxt.appTarget.id.length + 1)))
.forEach(f => pxt.log(`crowdin: dead file: ${f.branch ? f.branch + "/" : ""}${f.fullName}`));
})
}
function statsCrowdinAsync(prj: string, key: string, preferredLang?: string): Promise<void> {
pxt.log(`collecting crowdin stats for ${prj} ${preferredLang ? `for language ${preferredLang}` : `all languages`}`);
console.log(`context\t language\t translated%\t approved%\t phrases\t translated\t approved`)
const fn = `crowdinstats.csv`;
let headers = 'sep=\t\r\n';
headers += `id\t file\t language\t phrases\t translated\t approved\r\n`;
nodeutil.writeFileSync(fn, headers, { encoding: "utf8" });
return pxt.crowdin.projectInfoAsync(prj, key)
.then(info => {
if (!info) throw new Error("info failed")
let languages = info.languages;
// remove in-context language
languages = languages.filter(l => l.code != ts.pxtc.Util.TRANSLATION_LOCALE);
if (preferredLang)
languages = languages.filter(lang => lang.code.toLowerCase() == preferredLang.toLowerCase());
return Promise.all(languages.map(lang => langStatsCrowdinAsync(prj, key, lang.code)))
}).then(() => {
console.log(`stats written to ${fn}`)
})
function langStatsCrowdinAsync(prj: string, key: string, lang: string): Promise<void> {
return pxt.crowdin.languageStatsAsync(prj, key, lang)
.then(stats => {
let uiphrases = 0;
let uitranslated = 0;
let uiapproved = 0;
let corephrases = 0;
let coretranslated = 0;
let coreapproved = 0;
let phrases = 0;
let translated = 0;
let approved = 0;
let r = '';
stats.forEach(stat => {
const cfn = `${stat.branch ? stat.branch + "/" : ""}${stat.fullName}`;
r += `${stat.id}\t ${cfn}\t ${lang}\t ${stat.phrases}\t ${stat.translated}\t ${stat.approved}\r\n`;
if (stat.fullName == "strings.json") {
uiapproved += Number(stat.approved);
uitranslated += Number(stat.translated);
uiphrases += Number(stat.phrases);
} else if (/core-strings\.json$/.test(stat.fullName)) {
coreapproved += Number(stat.approved);
coretranslated += Number(stat.translated);
corephrases += Number(stat.phrases);
} else if (/-strings\.json$/.test(stat.fullName)) {
approved += Number(stat.approved);
translated += Number(stat.translated);
phrases += Number(stat.phrases);
}
})
fs.appendFileSync(fn, r, { encoding: "utf8" });
console.log(`ui\t ${lang}\t ${(uitranslated / uiphrases * 100) >> 0}%\t ${(uiapproved / uiphrases * 100) >> 0}%\t ${uiphrases}\t ${uitranslated}\t ${uiapproved}`)
console.log(`core\t ${lang}\t ${(coretranslated / corephrases * 100) >> 0}%\t ${(coreapproved / corephrases * 100) >> 0}%\t ${corephrases}\t ${coretranslated}\t ${coreapproved}`)
console.log(`blocks\t ${lang}\t ${(translated / phrases * 100) >> 0}%\t ${(approved / phrases * 100) >> 0}%\t ${phrases}\t ${translated}\t ${approved}`)
})
}
}
function uploadCrowdinAsync(branch: string, prj: string, key: string, p: string, dir?: string): Promise<void> {
let fn = path.basename(p);
if (dir) fn = dir.replace(/[\\/]*$/g, '') + '/' + fn;
const data = JSON.parse(fs.readFileSync(p, "utf8")) as Map<string>;
pxt.log(`upload ${fn} (${Object.keys(data).length} strings) to https://crowdin.com/project/${prj}${branch ? `?branch=${branch}` : ''}`);
return pxt.crowdin.uploadTranslationAsync(branch, prj, key, fn, JSON.stringify(data));
}