Include localized diagnostics #18702
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| import * as fs from "fs"; | ||
| import * as path from "path"; | ||
| import * as xml2js from "xml2js"; | ||
|
|
||
| function main(): void { | ||
| const args = process.argv.slice(2); | ||
| if (args.length !== 3) { | ||
| console.log("Usage:"); | ||
| console.log("\tnode generateLocalizedDiagnosticMessages.js <lcl source directory> <output directory> <generated diagnostics map file>"); | ||
| return; | ||
| } | ||
|
|
||
| const inputPath = args[0]; | ||
| const outputPath = args[1]; | ||
| const diagnosticsMapFilePath = args[2]; | ||
|
|
||
| // generate the lcg file for enu | ||
| generateLCGFile(); | ||
|
|
||
| // generate other langs | ||
| fs.readdir(inputPath, (err, files) => { | ||
| handleError(err); | ||
| files.forEach(visitDirectory); | ||
| }); | ||
|
|
||
| return; | ||
|
|
||
| function visitDirectory(name: string) { | ||
| const inputFilePath = path.join(inputPath, name, "diagnosticMessages", "diagnosticMessages.generated.json.lcl"); | ||
| const outputFilePath = path.join(outputPath, name, "diagnosticMessages.generated.json"); | ||
| fs.readFile(inputFilePath, (err, data) => { | ||
| handleError(err); | ||
| xml2js.parseString(data.toString(), (err, result) => { | ||
| handleError(err); | ||
| writeFile(outputFilePath, xmlObjectToString(result)); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| function handleError(err: null | object) { | ||
| if (err) { | ||
| console.error(err); | ||
| process.exit(1); | ||
| } | ||
| } | ||
|
|
||
| function xmlObjectToString(o: any) { | ||
|
There was a problem hiding this comment. Add a comment here what we expect the incoming XML to look like |
||
| const out: any = {}; | ||
| for (const item of o["LCX"]["Item"][0]["Item"][0]["Item"]) { | ||
| let ItemId = item["$"]["ItemId"]; | ||
| let Val = item["Str"][0]["Tgt"] ? item["Str"][0]["Tgt"][0]["Val"][0] : item["Str"][0]["Val"][0]; | ||
|
|
||
| if (typeof ItemId !== "string" || typeof Val !== "string") { | ||
| console.error("Unexpected XML file structure"); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| if (ItemId.charAt(0) === ";") { | ||
| ItemId = ItemId.slice(1); // remove leading semicolon | ||
| } | ||
|
|
||
| Val = Val.replace(/]5D;/, "]"); // unescape `]` | ||
| out[ItemId] = Val; | ||
| } | ||
| return JSON.stringify(out, undefined, 2); | ||
| } | ||
|
|
||
|
|
||
| function ensureDirectoryExists(directoryPath: string, action: () => void) { | ||
| fs.exists(directoryPath, exists => { | ||
| if (!exists) { | ||
| const basePath = path.dirname(directoryPath); | ||
| if (basePath !== directoryPath) { | ||
| return ensureDirectoryExists(basePath, () => fs.mkdir(directoryPath, action)); | ||
| } | ||
| } | ||
| action(); | ||
| }); | ||
| } | ||
|
|
||
| function writeFile(fileName: string, contents: string) { | ||
| ensureDirectoryExists(path.dirname(fileName), () => { | ||
| fs.writeFile(fileName, contents, handleError); | ||
| }); | ||
| } | ||
|
|
||
| function objectToList(o: Record<string, string>) { | ||
| const list: { key: string, value: string }[] = []; | ||
| for (const key in o) { | ||
| list.push({ key, value: o[key] }); | ||
| } | ||
| return list; | ||
| } | ||
|
|
||
| function generateLCGFile() { | ||
| return fs.readFile(diagnosticsMapFilePath, (err, data) => { | ||
| handleError(err); | ||
| writeFile( | ||
| path.join(outputPath, "enu", "diagnosticMessages.generated.json.lcg"), | ||
| getLCGFileXML( | ||
| objectToList(JSON.parse(data.toString())) | ||
| .sort((a, b) => a.key > b.key ? 1 : -1) // lcg sorted by property keys | ||
| .reduce((s, { key, value }) => s + getItemXML(key, value), "") | ||
| )); | ||
| }); | ||
|
|
||
| function getItemXML(key: string, value: string) { | ||
| // escape entrt value | ||
| value = value.replace(/]/, "]5D;"); | ||
|
|
||
| return ` | ||
| <Item ItemId=";${key}" ItemType="0" PsrId="306" Leaf="true"> | ||
| <Str Cat="Text"> | ||
| <Val><![CDATA[${value}]]></Val> | ||
| </Str> | ||
| <Disp Icon="Str" /> | ||
| </Item>`; | ||
| } | ||
|
|
||
| function getLCGFileXML(items: string) { | ||
| return `<?xml version="1.0" encoding="utf-8"?> | ||
| <LCX SchemaVersion="6.0" Name="diagnosticMessages.generated.json" PsrId="306" FileType="1" SrcCul="en-US" xmlns="http://schemas.microsoft.com/locstudio/2006/6/lcx"> | ||
| <OwnedComments> | ||
| <Cmt Name="Dev" /> | ||
| <Cmt Name="LcxAdmin" /> | ||
| <Cmt Name="Rccx" /> | ||
| </OwnedComments> | ||
| <Item ItemId=";String Table" ItemType="0" PsrId="306" Leaf="false"> | ||
| <Disp Icon="Expand" Expand="true" Disp="true" LocTbl="false" /> | ||
| <Item ItemId=";Strings" ItemType="0" PsrId="306" Leaf="false"> | ||
| <Disp Icon="Str" Disp="true" LocTbl="false" />${items} | ||
| </Item> | ||
| </Item> | ||
| </LCX>`; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| main(); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rather than building the script in the gulpfile, can we just
importthe typescript directly, and call a function it exports (instead of shelling out)? We could do this with our other scripts in theGulpfileto cut away some cruft, too.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are we doing this anywhere else in gulpFile? i tried to stay close to the Jake file really. i am not a gulp user :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We were doing it for the old parallel runner, though I've removed it since it's in the harness now. It's no big deal; could just be a little cleaner-feeling, since then there'd be no (visible) compilation step for the script. Doesn't matter much, since we need to keep the compilation step in the
Jakefileanyway.