@rushstack/localization-utilities 0.1.0

package/LICENSE

@@ -0,0 +1,24 @@
+@rushstack/localization-utilities
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @rushstack/localization-utilities
+
+This library provides a set of utilities for working with localization files.

package/dist/localization-utilities.d.ts

@@ -0,0 +1,103 @@
+import { ITerminal } from '@rushstack/node-core-library';
+import { NewlineKind } from '@rushstack/node-core-library';
+import { StringValuesTypingsGenerator } from '@rushstack/typings-generator';
+
+/**
+ * Get a function that pseudolocalizes a string.
+ *
+ * @public
+ */
+export declare function getPseudolocalizer(options: IPseudolocaleOptions): (str: string) => string;
+
+/**
+ * @public
+ */
+export declare interface ILocalizationFile {
+    [stringName: string]: ILocalizedString;
+}
+
+/**
+ * @public
+ */
+export declare interface ILocalizedString {
+    value: string;
+    comment?: string;
+}
+
+/**
+ * @public
+ */
+export declare interface IParseLocFileOptions {
+    terminal: ITerminal;
+    filePath: string;
+    content: string;
+    resxNewlineNormalization: NewlineKind | undefined;
+    ignoreMissingResxComments: boolean | undefined;
+}
+
+/**
+ * Options for the pseudolocale library.
+ *
+ * @internalRemarks
+ * Eventually this should be replaced with DefinitelyTyped types.
+ *
+ * @public
+ */
+export declare interface IPseudolocaleOptions {
+    prepend?: string;
+    append?: string;
+    delimiter?: string;
+    startDelimiter?: string;
+    endDelimiter?: string;
+    extend?: number;
+    override?: string;
+}
+
+/**
+ * @public
+ */
+export declare interface IResxReaderOptions {
+    resxFilePath: string;
+    terminal: ITerminal;
+    newlineNormalization: NewlineKind | undefined;
+    warnOnMissingComment: boolean;
+}
+
+/**
+ * @public
+ */
+export declare interface ITypingsGeneratorOptions {
+    srcFolder: string;
+    generatedTsFolder: string;
+    terminal?: ITerminal;
+    exportAsDefault?: boolean;
+    globsToIgnore?: string[];
+    resxNewlineNormalization?: NewlineKind | undefined;
+    ignoreMissingResxComments?: boolean | undefined;
+}
+
+/**
+ * @public
+ */
+export declare function parseLocFile(options: IParseLocFileOptions): ILocalizationFile;
+
+/**
+ * @public
+ */
+export declare function readResxAsLocFile(resxContents: string, options: IResxReaderOptions): ILocalizationFile;
+
+/**
+ * @public
+ */
+export declare function readResxFileAsLocFile(options: IResxReaderOptions): ILocalizationFile;
+
+/**
+ * This is a simple tool that generates .d.ts files for .loc.json, .resx.json, .resjson, and .resx files.
+ *
+ * @public
+ */
+export declare class TypingsGenerator extends StringValuesTypingsGenerator {
+    constructor(options: ITypingsGeneratorOptions);
+}
+
+export { }

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.24.2"
+    }
+  ]
+}

package/lib/LocFileParser.d.ts

@@ -0,0 +1,17 @@
+import { ITerminal, NewlineKind } from '@rushstack/node-core-library';
+import { ILocalizationFile } from './interfaces';
+/**
+ * @public
+ */
+export interface IParseLocFileOptions {
+    terminal: ITerminal;
+    filePath: string;
+    content: string;
+    resxNewlineNormalization: NewlineKind | undefined;
+    ignoreMissingResxComments: boolean | undefined;
+}
+/**
+ * @public
+ */
+export declare function parseLocFile(options: IParseLocFileOptions): ILocalizationFile;
+//# sourceMappingURL=LocFileParser.d.ts.map

package/lib/LocFileParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocFileParser.d.ts","sourceRoot":"","sources":["../src/LocFileParser.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAwB,MAAM,8BAA8B,CAAC;AAE5F,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAKjD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,wBAAwB,EAAE,WAAW,GAAG,SAAS,CAAC;IAClD,yBAAyB,EAAE,OAAO,GAAG,SAAS,CAAC;CAChD;AASD;;GAEG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,oBAAoB,GAAG,iBAAiB,CA0D7E"}

package/lib/LocFileParser.js

@@ -0,0 +1,73 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseLocFile = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const ResxReader_1 = require("./ResxReader");
+const LOC_JSON_SCHEMA = node_core_library_1.JsonSchema.fromFile(`${__dirname}/schemas/locJson.schema.json`);
+const parseCache = new Map();
+/**
+ * @public
+ */
+function parseLocFile(options) {
+    const fileCacheKey = `${options.filePath}?${options.resxNewlineNormalization || 'none'}`;
+    if (parseCache.has(fileCacheKey)) {
+        const entry = parseCache.get(fileCacheKey);
+        if (entry.content === options.content) {
+            return entry.parsedFile;
+        }
+    }
+    let parsedFile;
+    if (/\.resx$/i.test(options.filePath)) {
+        parsedFile = (0, ResxReader_1.readResxAsLocFile)(options.content, {
+            terminal: options.terminal,
+            resxFilePath: options.filePath,
+            newlineNormalization: options.resxNewlineNormalization,
+            warnOnMissingComment: !options.ignoreMissingResxComments
+        });
+    }
+    else if (/\.(resx|loc)\.json$/i.test(options.filePath)) {
+        parsedFile = node_core_library_1.JsonFile.parseString(options.content);
+        try {
+            LOC_JSON_SCHEMA.validateObject(parsedFile, options.filePath);
+        }
+        catch (e) {
+            options.terminal.writeError(`The loc file is invalid. Error: ${e}`);
+        }
+    }
+    else if (/\.resjson$/i.test(options.filePath)) {
+        const resjsonFile = node_core_library_1.JsonFile.parseString(options.content);
+        parsedFile = {};
+        const comments = new Map();
+        for (const [key, value] of Object.entries(resjsonFile)) {
+            if (key.startsWith('_') && key.endsWith('.comment')) {
+                const commentKey = key.substring(1, key.length - '.comment'.length);
+                comments.set(commentKey, value);
+            }
+            else {
+                parsedFile[key] = { value };
+            }
+        }
+        const orphanComments = [];
+        for (const [key, comment] of comments) {
+            if (parsedFile[key]) {
+                parsedFile[key].comment = comment;
+            }
+            else {
+                orphanComments.push(key);
+            }
+        }
+        if (orphanComments.length > 0) {
+            options.terminal.writeErrorLine('The resjson file is invalid. Comments exist for the following string keys ' +
+                `that don't have values: ${orphanComments.join(', ')}.`);
+        }
+    }
+    else {
+        throw new Error(`Unsupported file extension in file: ${options.filePath}`);
+    }
+    parseCache.set(fileCacheKey, { content: options.content, parsedFile });
+    return parsedFile;
+}
+exports.parseLocFile = parseLocFile;
+//# sourceMappingURL=LocFileParser.js.map

package/lib/LocFileParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocFileParser.js","sourceRoot":"","sources":["../src/LocFileParser.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAA4F;AAG5F,6CAAiD;AAEjD,MAAM,eAAe,GAAe,8BAAU,CAAC,QAAQ,CAAC,GAAG,SAAS,8BAA8B,CAAC,CAAC;AAkBpG,MAAM,UAAU,GAAkC,IAAI,GAAG,EAA4B,CAAC;AAEtF;;GAEG;AACH,SAAgB,YAAY,CAAC,OAA6B;IACxD,MAAM,YAAY,GAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,wBAAwB,IAAI,MAAM,EAAE,CAAC;IACjG,IAAI,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE;QAChC,MAAM,KAAK,GAAqB,UAAU,CAAC,GAAG,CAAC,YAAY,CAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,EAAE;YACrC,OAAO,KAAK,CAAC,UAAU,CAAC;SACzB;KACF;IAED,IAAI,UAA6B,CAAC;IAClC,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACrC,UAAU,GAAG,IAAA,8BAAiB,EAAC,OAAO,CAAC,OAAO,EAAE;YAC9C,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,YAAY,EAAE,OAAO,CAAC,QAAQ;YAC9B,oBAAoB,EAAE,OAAO,CAAC,wBAAwB;YACtD,oBAAoB,EAAE,CAAC,OAAO,CAAC,yBAAyB;SACzD,CAAC,CAAC;KACJ;SAAM,IAAI,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACxD,UAAU,GAAG,4BAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnD,IAAI;YACF,eAAe,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;SAC9D;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,mCAAmC,CAAC,EAAE,CAAC,CAAC;SACrE;KACF;SAAM,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC/C,MAAM,WAAW,GAA2B,4BAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAClF,UAAU,GAAG,EAAE,CAAC;QAChB,MAAM,QAAQ,GAAwB,IAAI,GAAG,EAAE,CAAC;QAChD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YACtD,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;gBACnD,MAAM,UAAU,GAAW,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;gBAC5E,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;aACjC;iBAAM;gBACL,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC;aAC7B;SACF;QAED,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,QAAQ,EAAE;YACrC,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE;gBACnB,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC;aACnC;iBAAM;gBACL,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC1B;SACF;QAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;YAC7B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAC7B,4EAA4E;gBAC1E,2BAA2B,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC1D,CAAC;SACH;KACF;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,uCAAuC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;KAC5E;IAED,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACvE,OAAO,UAAU,CAAC;AACpB,CAAC;AA1DD,oCA0DC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { ITerminal, NewlineKind, JsonFile, JsonSchema } from '@rushstack/node-core-library';\n\nimport { ILocalizationFile } from './interfaces';\nimport { readResxAsLocFile } from './ResxReader';\n\nconst LOC_JSON_SCHEMA: JsonSchema = JsonSchema.fromFile(`${__dirname}/schemas/locJson.schema.json`);\n\n/**\n * @public\n */\nexport interface IParseLocFileOptions {\n  terminal: ITerminal;\n  filePath: string;\n  content: string;\n  resxNewlineNormalization: NewlineKind | undefined;\n  ignoreMissingResxComments: boolean | undefined;\n}\n\ninterface IParseCacheEntry {\n  content: string;\n  parsedFile: ILocalizationFile;\n}\n\nconst parseCache: Map<string, IParseCacheEntry> = new Map<string, IParseCacheEntry>();\n\n/**\n * @public\n */\nexport function parseLocFile(options: IParseLocFileOptions): ILocalizationFile {\n  const fileCacheKey: string = `${options.filePath}?${options.resxNewlineNormalization || 'none'}`;\n  if (parseCache.has(fileCacheKey)) {\n    const entry: IParseCacheEntry = parseCache.get(fileCacheKey)!;\n    if (entry.content === options.content) {\n      return entry.parsedFile;\n    }\n  }\n\n  let parsedFile: ILocalizationFile;\n  if (/\\.resx$/i.test(options.filePath)) {\n    parsedFile = readResxAsLocFile(options.content, {\n      terminal: options.terminal,\n      resxFilePath: options.filePath,\n      newlineNormalization: options.resxNewlineNormalization,\n      warnOnMissingComment: !options.ignoreMissingResxComments\n    });\n  } else if (/\\.(resx|loc)\\.json$/i.test(options.filePath)) {\n    parsedFile = JsonFile.parseString(options.content);\n    try {\n      LOC_JSON_SCHEMA.validateObject(parsedFile, options.filePath);\n    } catch (e) {\n      options.terminal.writeError(`The loc file is invalid. Error: ${e}`);\n    }\n  } else if (/\\.resjson$/i.test(options.filePath)) {\n    const resjsonFile: Record<string, string> = JsonFile.parseString(options.content);\n    parsedFile = {};\n    const comments: Map<string, string> = new Map();\n    for (const [key, value] of Object.entries(resjsonFile)) {\n      if (key.startsWith('_') && key.endsWith('.comment')) {\n        const commentKey: string = key.substring(1, key.length - '.comment'.length);\n        comments.set(commentKey, value);\n      } else {\n        parsedFile[key] = { value };\n      }\n    }\n\n    const orphanComments: string[] = [];\n    for (const [key, comment] of comments) {\n      if (parsedFile[key]) {\n        parsedFile[key].comment = comment;\n      } else {\n        orphanComments.push(key);\n      }\n    }\n\n    if (orphanComments.length > 0) {\n      options.terminal.writeErrorLine(\n        'The resjson file is invalid. Comments exist for the following string keys ' +\n          `that don't have values: ${orphanComments.join(', ')}.`\n      );\n    }\n  } else {\n    throw new Error(`Unsupported file extension in file: ${options.filePath}`);\n  }\n\n  parseCache.set(fileCacheKey, { content: options.content, parsedFile });\n  return parsedFile;\n}\n"]}

package/lib/LocFileTypingsGenerator.d.ts

@@ -0,0 +1,23 @@
+import { StringValuesTypingsGenerator } from '@rushstack/typings-generator';
+import { ITerminal, NewlineKind } from '@rushstack/node-core-library';
+/**
+ * @public
+ */
+export interface ITypingsGeneratorOptions {
+    srcFolder: string;
+    generatedTsFolder: string;
+    terminal?: ITerminal;
+    exportAsDefault?: boolean;
+    globsToIgnore?: string[];
+    resxNewlineNormalization?: NewlineKind | undefined;
+    ignoreMissingResxComments?: boolean | undefined;
+}
+/**
+ * This is a simple tool that generates .d.ts files for .loc.json, .resx.json, .resjson, and .resx files.
+ *
+ * @public
+ */
+export declare class LocFileTypingsGenerator extends StringValuesTypingsGenerator {
+    constructor(options: ITypingsGeneratorOptions);
+}
+//# sourceMappingURL=LocFileTypingsGenerator.d.ts.map

package/lib/LocFileTypingsGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocFileTypingsGenerator.d.ts","sourceRoot":"","sources":["../src/LocFileTypingsGenerator.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,4BAA4B,EAAsB,MAAM,8BAA8B,CAAC;AAChG,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAKtE;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,wBAAwB,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACnD,yBAAyB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACjD;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,4BAA4B;gBACpD,OAAO,EAAE,wBAAwB;CA2BrD"}

package/lib/LocFileTypingsGenerator.js

@@ -0,0 +1,36 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocFileTypingsGenerator = void 0;
+const typings_generator_1 = require("@rushstack/typings-generator");
+const LocFileParser_1 = require("./LocFileParser");
+/**
+ * This is a simple tool that generates .d.ts files for .loc.json, .resx.json, .resjson, and .resx files.
+ *
+ * @public
+ */
+class LocFileTypingsGenerator extends typings_generator_1.StringValuesTypingsGenerator {
+    constructor(options) {
+        super(Object.assign(Object.assign({}, options), { fileExtensions: ['.resx', '.resx.json', '.loc.json', '.resjson'], parseAndGenerateTypings: (fileContents, filePath) => {
+                const locFileData = (0, LocFileParser_1.parseLocFile)({
+                    filePath: filePath,
+                    content: fileContents,
+                    terminal: this._options.terminal,
+                    resxNewlineNormalization: options.resxNewlineNormalization,
+                    ignoreMissingResxComments: options.ignoreMissingResxComments
+                });
+                const typings = [];
+                // eslint-disable-next-line guard-for-in
+                for (const stringName in locFileData) {
+                    typings.push({
+                        exportName: stringName,
+                        comment: locFileData[stringName].comment
+                    });
+                }
+                return { typings };
+            } }));
+    }
+}
+exports.LocFileTypingsGenerator = LocFileTypingsGenerator;
+//# sourceMappingURL=LocFileTypingsGenerator.js.map

package/lib/LocFileTypingsGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocFileTypingsGenerator.js","sourceRoot":"","sources":["../src/LocFileTypingsGenerator.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAgG;AAIhG,mDAA+C;AAe/C;;;;GAIG;AACH,MAAa,uBAAwB,SAAQ,gDAA4B;IACvE,YAAmB,OAAiC;QAClD,KAAK,iCACA,OAAO,KACV,cAAc,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,CAAC,EAChE,uBAAuB,EAAE,CAAC,YAAoB,EAAE,QAAgB,EAAE,EAAE;gBAClE,MAAM,WAAW,GAAsB,IAAA,4BAAY,EAAC;oBAClD,QAAQ,EAAE,QAAQ;oBAClB,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAS;oBACjC,wBAAwB,EAAE,OAAO,CAAC,wBAAwB;oBAC1D,yBAAyB,EAAE,OAAO,CAAC,yBAAyB;iBAC7D,CAAC,CAAC;gBAEH,MAAM,OAAO,GAAyB,EAAE,CAAC;gBAEzC,wCAAwC;gBACxC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;oBACpC,OAAO,CAAC,IAAI,CAAC;wBACX,UAAU,EAAE,UAAU;wBACtB,OAAO,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC,OAAO;qBACzC,CAAC,CAAC;iBACJ;gBAED,OAAO,EAAE,OAAO,EAAE,CAAC;YACrB,CAAC,IACD,CAAC;IACL,CAAC;CACF;AA5BD,0DA4BC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { StringValuesTypingsGenerator, IStringValueTyping } from '@rushstack/typings-generator';\nimport { ITerminal, NewlineKind } from '@rushstack/node-core-library';\n\nimport { ILocalizationFile } from './interfaces';\nimport { parseLocFile } from './LocFileParser';\n\n/**\n * @public\n */\nexport interface ITypingsGeneratorOptions {\n  srcFolder: string;\n  generatedTsFolder: string;\n  terminal?: ITerminal;\n  exportAsDefault?: boolean;\n  globsToIgnore?: string[];\n  resxNewlineNormalization?: NewlineKind | undefined;\n  ignoreMissingResxComments?: boolean | undefined;\n}\n\n/**\n * This is a simple tool that generates .d.ts files for .loc.json, .resx.json, .resjson, and .resx files.\n *\n * @public\n */\nexport class LocFileTypingsGenerator extends StringValuesTypingsGenerator {\n  public constructor(options: ITypingsGeneratorOptions) {\n    super({\n      ...options,\n      fileExtensions: ['.resx', '.resx.json', '.loc.json', '.resjson'],\n      parseAndGenerateTypings: (fileContents: string, filePath: string) => {\n        const locFileData: ILocalizationFile = parseLocFile({\n          filePath: filePath,\n          content: fileContents,\n          terminal: this._options.terminal!,\n          resxNewlineNormalization: options.resxNewlineNormalization,\n          ignoreMissingResxComments: options.ignoreMissingResxComments\n        });\n\n        const typings: IStringValueTyping[] = [];\n\n        // eslint-disable-next-line guard-for-in\n        for (const stringName in locFileData) {\n          typings.push({\n            exportName: stringName,\n            comment: locFileData[stringName].comment\n          });\n        }\n\n        return { typings };\n      }\n    });\n  }\n}\n"]}

package/lib/Pseudolocalization.d.ts

@@ -0,0 +1,8 @@
+import { IPseudolocaleOptions } from './interfaces';
+/**
+ * Get a function that pseudolocalizes a string.
+ *
+ * @public
+ */
+export declare function getPseudolocalizer(options: IPseudolocaleOptions): (str: string) => string;
+//# sourceMappingURL=Pseudolocalization.d.ts.map

package/lib/Pseudolocalization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pseudolocalization.d.ts","sourceRoot":"","sources":["../src/Pseudolocalization.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,oBAAoB,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAUzF"}

package/lib/Pseudolocalization.js

@@ -0,0 +1,23 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPseudolocalizer = void 0;
+const decache_1 = __importDefault(require("decache"));
+/**
+ * Get a function that pseudolocalizes a string.
+ *
+ * @public
+ */
+function getPseudolocalizer(options) {
+    // pseudolocale maintains static state, so we need to load it as isolated modules
+    (0, decache_1.default)('pseudolocale');
+    const pseudolocale = require('pseudolocale'); // eslint-disable-line
+    pseudolocale.option = Object.assign(Object.assign({}, pseudolocale.option), options);
+    return pseudolocale.str;
+}
+exports.getPseudolocalizer = getPseudolocalizer;
+//# sourceMappingURL=Pseudolocalization.js.map

package/lib/Pseudolocalization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pseudolocalization.js","sourceRoot":"","sources":["../src/Pseudolocalization.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;AAE3D,sDAA8B;AAI9B;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,OAA6B;IAC9D,iFAAiF;IACjF,IAAA,iBAAO,EAAC,cAAc,CAAC,CAAC;IACxB,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,sBAAsB;IAEpE,YAAY,CAAC,MAAM,mCACd,YAAY,CAAC,MAAM,GACnB,OAAO,CACX,CAAC;IACF,OAAO,YAAY,CAAC,GAAG,CAAC;AAC1B,CAAC;AAVD,gDAUC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport decache from 'decache';\n\nimport { IPseudolocaleOptions } from './interfaces';\n\n/**\n * Get a function that pseudolocalizes a string.\n *\n * @public\n */\nexport function getPseudolocalizer(options: IPseudolocaleOptions): (str: string) => string {\n  // pseudolocale maintains static state, so we need to load it as isolated modules\n  decache('pseudolocale');\n  const pseudolocale = require('pseudolocale'); // eslint-disable-line\n\n  pseudolocale.option = {\n    ...pseudolocale.option,\n    ...options\n  };\n  return pseudolocale.str;\n}\n"]}

package/lib/ResxReader.d.ts

@@ -0,0 +1,20 @@
+import { ITerminal, NewlineKind } from '@rushstack/node-core-library';
+import { ILocalizationFile } from './interfaces';
+/**
+ * @public
+ */
+export interface IResxReaderOptions {
+    resxFilePath: string;
+    terminal: ITerminal;
+    newlineNormalization: NewlineKind | undefined;
+    warnOnMissingComment: boolean;
+}
+/**
+ * @public
+ */
+export declare function readResxFileAsLocFile(options: IResxReaderOptions): ILocalizationFile;
+/**
+ * @public
+ */
+export declare function readResxAsLocFile(resxContents: string, options: IResxReaderOptions): ILocalizationFile;
+//# sourceMappingURL=ResxReader.d.ts.map

package/lib/ResxReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResxReader.d.ts","sourceRoot":"","sources":["../src/ResxReader.ts"],"names":[],"mappings":"AAGA,OAAO,EAAc,SAAS,EAAQ,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAGxF,OAAO,EAAoB,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAInE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,SAAS,CAAC;IACpB,oBAAoB,EAAE,WAAW,GAAG,SAAS,CAAC;IAC9C,oBAAoB,EAAE,OAAO,CAAC;CAC/B;AAcD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,kBAAkB,GAAG,iBAAiB,CAGpF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,iBAAiB,CAmBtG"}

package/lib/ResxReader.js

@@ -0,0 +1,207 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readResxAsLocFile = exports.readResxFileAsLocFile = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const xmldoc_1 = require("xmldoc");
+const STRING_NAME_RESX = /^[A-z_$][A-z0-9_$]*$/;
+/**
+ * @public
+ */
+function readResxFileAsLocFile(options) {
+    const resxContents = node_core_library_1.FileSystem.readFile(options.resxFilePath);
+    return readResxAsLocFile(resxContents, options);
+}
+exports.readResxFileAsLocFile = readResxFileAsLocFile;
+/**
+ * @public
+ */
+function readResxAsLocFile(resxContents, options) {
+    const writeError = options.terminal.writeErrorLine.bind(options.terminal);
+    const writeWarning = options.terminal.writeWarningLine.bind(options.terminal);
+    const loggingFunctions = {
+        logError: (message) => writeError(message),
+        logWarning: (message) => writeWarning(message),
+        logFileError: (message, filePath, line, position) => {
+            _logWithLocation(writeError, message, filePath, line, position);
+        },
+        logFileWarning: (message, filePath, line, position) => {
+            _logWithLocation(writeWarning, message, filePath, line, position);
+        }
+    };
+    return _readResxAsLocFileInternal(Object.assign(Object.assign({}, options), { resxContents,
+        loggingFunctions }));
+}
+exports.readResxAsLocFile = readResxAsLocFile;
+function _readResxAsLocFileInternal(options) {
+    const xmlDocument = new xmldoc_1.XmlDocument(options.resxContents);
+    if (xmlDocument.name !== 'root') {
+        _logErrorWithLocation(options, `Expected RESX to have a "root" element, found "${xmlDocument.name}"`, xmlDocument);
+    }
+    const locFile = {};
+    for (const childNode of xmlDocument.children) {
+        switch (childNode.type) {
+            case 'element': {
+                switch (childNode.name) {
+                    case 'data': {
+                        const stringName = childNode.attr.name;
+                        if (!stringName) {
+                            _logErrorWithLocation(options, 'Unexpected missing or empty string name', childNode);
+                        }
+                        else if (!STRING_NAME_RESX.test(stringName)) {
+                            _logErrorWithLocation(options, `Invalid string name "${stringName}"`, childNode);
+                        }
+                        else {
+                            if (locFile.hasOwnProperty(stringName)) {
+                                _logErrorWithLocation(options, `Duplicate string value "${stringName}"`, childNode);
+                            }
+                            const locString = _readDataElement(options, childNode);
+                            if (locString) {
+                                locFile[stringName] = locString;
+                            }
+                        }
+                        break;
+                    }
+                    // Other allowed elements
+                    case 'xsd:schema':
+                    case 'resheader':
+                        break;
+                    default:
+                        _logErrorWithLocation(options, `Unexpected RESX element ${childNode.name}`, childNode);
+                }
+                break;
+            }
+            case 'text': {
+                if (childNode.text.trim() !== '') {
+                    _logErrorWithLocation(options, 'Found unexpected non-empty text node in RESX');
+                }
+                break;
+            }
+            case 'comment':
+                break;
+            default:
+                _logErrorWithLocation(options, `Unexpected ${childNode.type} child in RESX`);
+                break;
+        }
+    }
+    return locFile;
+}
+function _readDataElement(options, dataElement) {
+    let foundCommentElement = false;
+    let foundValueElement = false;
+    let comment = undefined;
+    let value = undefined;
+    for (const childNode of dataElement.children) {
+        switch (childNode.type) {
+            case 'element': {
+                switch (childNode.name) {
+                    case 'value': {
+                        if (foundValueElement) {
+                            _logErrorWithLocation(options, 'Duplicate <value> element found', childNode);
+                        }
+                        else {
+                            foundValueElement = true;
+                            value = _readTextElement(options, childNode);
+                            if (value && options.newlineNormalization) {
+                                value = node_core_library_1.Text.convertTo(value, options.newlineNormalization);
+                            }
+                        }
+                        break;
+                    }
+                    case 'comment': {
+                        if (foundCommentElement) {
+                            _logErrorWithLocation(options, 'Duplicate <comment> element found', childNode);
+                        }
+                        else {
+                            foundCommentElement = true;
+                            comment = _readTextElement(options, childNode);
+                        }
+                        break;
+                    }
+                    default:
+                        _logErrorWithLocation(options, `Unexpected RESX element ${childNode.name}`, childNode);
+                        break;
+                }
+                break;
+            }
+            case 'text': {
+                if (childNode.text.trim() !== '') {
+                    _logErrorWithLocation(options, 'Found unexpected non-empty text node in RESX <data> element', dataElement);
+                }
+                break;
+            }
+            case 'comment':
+                break;
+            default:
+                _logErrorWithLocation(options, `Unexpected ${childNode.type} child in RESX <data> element`, dataElement);
+        }
+    }
+    if (!foundValueElement) {
+        _logErrorWithLocation(options, 'Missing string value in <data> element', dataElement);
+    }
+    else {
+        if (comment === undefined && options.warnOnMissingComment) {
+            _logWarningWithLocation(options, 'Missing string comment in <data> element', dataElement);
+        }
+        return {
+            value: value || '',
+            comment
+        };
+    }
+}
+function _readTextElement(options, element) {
+    let foundText = undefined;
+    for (const childNode of element.children) {
+        switch (childNode.type) {
+            case 'cdata':
+            case 'text': {
+                if (foundText !== undefined) {
+                    _logErrorWithLocation(options, 'More than one child node found containing text content', element);
+                    break;
+                }
+                foundText = childNode.type === 'text' ? childNode.text : childNode.cdata;
+                break;
+            }
+            case 'comment':
+                break;
+            case 'element':
+                _logErrorWithLocation(options, `Unexpected element`, childNode);
+                break;
+            default:
+                _logErrorWithLocation(options, `Unexpected ${element.type} child`, element);
+                break;
+        }
+    }
+    return foundText;
+}
+function _logErrorWithLocation(options, message, element) {
+    if (element) {
+        options.loggingFunctions.logFileError(message, options.resxFilePath, element.line + 1, element.column + 1);
+    }
+    else {
+        options.loggingFunctions.logFileError(message, options.resxFilePath);
+    }
+}
+function _logWarningWithLocation(options, message, element) {
+    if (element) {
+        options.loggingFunctions.logFileWarning(message, options.resxFilePath, element.line + 1, element.column + 1);
+    }
+    else {
+        options.loggingFunctions.logFileWarning(message, options.resxFilePath);
+    }
+}
+function _logWithLocation(loggingFn, message, filePath, line, position) {
+    let location;
+    if (position !== undefined) {
+        location = `${filePath}(${line},${position})`;
+    }
+    else if (line !== undefined) {
+        location = `${filePath}(${line})`;
+    }
+    else {
+        location = filePath;
+    }
+    loggingFn(`${location}: ${message}`);
+}
+//# sourceMappingURL=ResxReader.js.map

package/lib/ResxReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResxReader.js","sourceRoot":"","sources":["../src/ResxReader.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAwF;AACxF,mCAAiD;AAIjD,MAAM,gBAAgB,GAAW,sBAAsB,CAAC;AAwBxD;;GAEG;AACH,SAAgB,qBAAqB,CAAC,OAA2B;IAC/D,MAAM,YAAY,GAAW,8BAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACvE,OAAO,iBAAiB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC;AAHD,sDAGC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,YAAoB,EAAE,OAA2B;IACjF,MAAM,UAAU,GAA8B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrG,MAAM,YAAY,GAA8B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzG,MAAM,gBAAgB,GAAsB;QAC1C,QAAQ,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;QAClD,UAAU,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC;QACtD,YAAY,EAAE,CAAC,OAAe,EAAE,QAAgB,EAAE,IAAa,EAAE,QAAiB,EAAE,EAAE;YACpF,gBAAgB,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAClE,CAAC;QACD,cAAc,EAAE,CAAC,OAAe,EAAE,QAAgB,EAAE,IAAa,EAAE,QAAiB,EAAE,EAAE;YACtF,gBAAgB,CAAC,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QACpE,CAAC;KACF,CAAC;IAEF,OAAO,0BAA0B,iCAC5B,OAAO,KACV,YAAY;QACZ,gBAAgB,IAChB,CAAC;AACL,CAAC;AAnBD,8CAmBC;AAED,SAAS,0BAA0B,CAAC,OAAmC;IACrE,MAAM,WAAW,GAAgB,IAAI,oBAAW,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAEvE,IAAI,WAAW,CAAC,IAAI,KAAK,MAAM,EAAE;QAC/B,qBAAqB,CACnB,OAAO,EACP,kDAAkD,WAAW,CAAC,IAAI,GAAG,EACrE,WAAW,CACZ,CAAC;KACH;IAED,MAAM,OAAO,GAAsB,EAAE,CAAC;IAEtC,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,QAAQ,EAAE;QAC5C,QAAQ,SAAS,CAAC,IAAI,EAAE;YACtB,KAAK,SAAS,CAAC,CAAC;gBACd,QAAQ,SAAS,CAAC,IAAI,EAAE;oBACtB,KAAK,MAAM,CAAC,CAAC;wBACX,MAAM,UAAU,GAAW,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;wBAC/C,IAAI,CAAC,UAAU,EAAE;4BACf,qBAAqB,CAAC,OAAO,EAAE,yCAAyC,EAAE,SAAS,CAAC,CAAC;yBACtF;6BAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;4BAC7C,qBAAqB,CAAC,OAAO,EAAE,wBAAwB,UAAU,GAAG,EAAE,SAAS,CAAC,CAAC;yBAClF;6BAAM;4BACL,IAAI,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;gCACtC,qBAAqB,CAAC,OAAO,EAAE,2BAA2B,UAAU,GAAG,EAAE,SAAS,CAAC,CAAC;6BACrF;4BAED,MAAM,SAAS,GAAiC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;4BAErF,IAAI,SAAS,EAAE;gCACb,OAAO,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;6BACjC;yBACF;wBAED,MAAM;qBACP;oBAED,yBAAyB;oBACzB,KAAK,YAAY,CAAC;oBAClB,KAAK,WAAW;wBACd,MAAM;oBAER;wBACE,qBAAqB,CAAC,OAAO,EAAE,2BAA2B,SAAS,CAAC,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;iBAC1F;gBAED,MAAM;aACP;YAED,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;oBAChC,qBAAqB,CAAC,OAAO,EAAE,8CAA8C,CAAC,CAAC;iBAChF;gBAED,MAAM;aACP;YAED,KAAK,SAAS;gBACZ,MAAM;YAER;gBACE,qBAAqB,CAAC,OAAO,EAAE,cAAc,SAAS,CAAC,IAAI,gBAAgB,CAAC,CAAC;gBAC7E,MAAM;SACT;KACF;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,gBAAgB,CACvB,OAAmC,EACnC,WAAuB;IAEvB,IAAI,mBAAmB,GAAY,KAAK,CAAC;IACzC,IAAI,iBAAiB,GAAY,KAAK,CAAC;IACvC,IAAI,OAAO,GAAuB,SAAS,CAAC;IAC5C,IAAI,KAAK,GAAuB,SAAS,CAAC;IAE1C,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,QAAQ,EAAE;QAC5C,QAAQ,SAAS,CAAC,IAAI,EAAE;YACtB,KAAK,SAAS,CAAC,CAAC;gBACd,QAAQ,SAAS,CAAC,IAAI,EAAE;oBACtB,KAAK,OAAO,CAAC,CAAC;wBACZ,IAAI,iBAAiB,EAAE;4BACrB,qBAAqB,CAAC,OAAO,EAAE,iCAAiC,EAAE,SAAS,CAAC,CAAC;yBAC9E;6BAAM;4BACL,iBAAiB,GAAG,IAAI,CAAC;4BACzB,KAAK,GAAG,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;4BAC7C,IAAI,KAAK,IAAI,OAAO,CAAC,oBAAoB,EAAE;gCACzC,KAAK,GAAG,wBAAI,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;6BAC7D;yBACF;wBAED,MAAM;qBACP;oBAED,KAAK,SAAS,CAAC,CAAC;wBACd,IAAI,mBAAmB,EAAE;4BACvB,qBAAqB,CAAC,OAAO,EAAE,mCAAmC,EAAE,SAAS,CAAC,CAAC;yBAChF;6BAAM;4BACL,mBAAmB,GAAG,IAAI,CAAC;4BAC3B,OAAO,GAAG,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;yBAChD;wBAED,MAAM;qBACP;oBAED;wBACE,qBAAqB,CAAC,OAAO,EAAE,2BAA2B,SAAS,CAAC,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;wBACvF,MAAM;iBACT;gBAED,MAAM;aACP;YAED,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;oBAChC,qBAAqB,CACnB,OAAO,EACP,6DAA6D,EAC7D,WAAW,CACZ,CAAC;iBACH;gBAED,MAAM;aACP;YAED,KAAK,SAAS;gBACZ,MAAM;YAER;gBACE,qBAAqB,CACnB,OAAO,EACP,cAAc,SAAS,CAAC,IAAI,+BAA+B,EAC3D,WAAW,CACZ,CAAC;SACL;KACF;IAED,IAAI,CAAC,iBAAiB,EAAE;QACtB,qBAAqB,CAAC,OAAO,EAAE,wCAAwC,EAAE,WAAW,CAAC,CAAC;KACvF;SAAM;QACL,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,oBAAoB,EAAE;YACzD,uBAAuB,CAAC,OAAO,EAAE,0CAA0C,EAAE,WAAW,CAAC,CAAC;SAC3F;QAED,OAAO;YACL,KAAK,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO;SACR,CAAC;KACH;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAmC,EAAE,OAAmB;IAChF,IAAI,SAAS,GAAuB,SAAS,CAAC;IAE9C,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,QAAQ,EAAE;QACxC,QAAQ,SAAS,CAAC,IAAI,EAAE;YACtB,KAAK,OAAO,CAAC;YACb,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,SAAS,KAAK,SAAS,EAAE;oBAC3B,qBAAqB,CAAC,OAAO,EAAE,wDAAwD,EAAE,OAAO,CAAC,CAAC;oBAClG,MAAM;iBACP;gBAED,SAAS,GAAG,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC;gBACzE,MAAM;aACP;YAED,KAAK,SAAS;gBACZ,MAAM;YAER,KAAK,SAAS;gBACZ,qBAAqB,CAAC,OAAO,EAAE,oBAAoB,EAAE,SAAS,CAAC,CAAC;gBAChE,MAAM;YAER;gBACE,qBAAqB,CAAC,OAAO,EAAE,cAAc,OAAO,CAAC,IAAI,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAC5E,MAAM;SACT;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,qBAAqB,CAC5B,OAAmC,EACnC,OAAe,EACf,OAAkC;IAElC,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,gBAAgB,CAAC,YAAY,CACnC,OAAO,EACP,OAAO,CAAC,YAAY,EACpB,OAAO,CAAC,IAAI,GAAG,CAAC,EAChB,OAAO,CAAC,MAAM,GAAG,CAAC,CACnB,CAAC;KACH;SAAM;QACL,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;KACtE;AACH,CAAC;AAED,SAAS,uBAAuB,CAC9B,OAAmC,EACnC,OAAe,EACf,OAAkC;IAElC,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,gBAAgB,CAAC,cAAc,CACrC,OAAO,EACP,OAAO,CAAC,YAAY,EACpB,OAAO,CAAC,IAAI,GAAG,CAAC,EAChB,OAAO,CAAC,MAAM,GAAG,CAAC,CACnB,CAAC;KACH;SAAM;QACL,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;KACxE;AACH,CAAC;AAED,SAAS,gBAAgB,CACvB,SAAoC,EACpC,OAAe,EACf,QAAgB,EAChB,IAAa,EACb,QAAiB;IAEjB,IAAI,QAAgB,CAAC;IACrB,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,QAAQ,GAAG,GAAG,QAAQ,IAAI,IAAI,IAAI,QAAQ,GAAG,CAAC;KAC/C;SAAM,IAAI,IAAI,KAAK,SAAS,EAAE;QAC7B,QAAQ,GAAG,GAAG,QAAQ,IAAI,IAAI,GAAG,CAAC;KACnC;SAAM;QACL,QAAQ,GAAG,QAAQ,CAAC;KACrB;IAED,SAAS,CAAC,GAAG,QAAQ,KAAK,OAAO,EAAE,CAAC,CAAC;AACvC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { FileSystem, ITerminal, Text, NewlineKind } from '@rushstack/node-core-library';\nimport { XmlDocument, XmlElement } from 'xmldoc';\n\nimport { ILocalizedString, ILocalizationFile } from './interfaces';\n\nconst STRING_NAME_RESX: RegExp = /^[A-z_$][A-z0-9_$]*$/;\n\n/**\n * @public\n */\nexport interface IResxReaderOptions {\n  resxFilePath: string;\n  terminal: ITerminal;\n  newlineNormalization: NewlineKind | undefined;\n  warnOnMissingComment: boolean;\n}\n\ninterface ILoggingFunctions {\n  logError: (message: string) => void;\n  logWarning: (message: string) => void;\n  logFileError: (message: string, filePath: string, line?: number, position?: number) => void;\n  logFileWarning: (message: string, filePath: string, line?: number, position?: number) => void;\n}\n\ninterface IResxReaderOptionsInternal extends Omit<IResxReaderOptions, 'terminal'> {\n  resxContents: string;\n  loggingFunctions: ILoggingFunctions;\n}\n\n/**\n * @public\n */\nexport function readResxFileAsLocFile(options: IResxReaderOptions): ILocalizationFile {\n  const resxContents: string = FileSystem.readFile(options.resxFilePath);\n  return readResxAsLocFile(resxContents, options);\n}\n\n/**\n * @public\n */\nexport function readResxAsLocFile(resxContents: string, options: IResxReaderOptions): ILocalizationFile {\n  const writeError: (message: string) => void = options.terminal.writeErrorLine.bind(options.terminal);\n  const writeWarning: (message: string) => void = options.terminal.writeWarningLine.bind(options.terminal);\n  const loggingFunctions: ILoggingFunctions = {\n    logError: (message: string) => writeError(message),\n    logWarning: (message: string) => writeWarning(message),\n    logFileError: (message: string, filePath: string, line?: number, position?: number) => {\n      _logWithLocation(writeError, message, filePath, line, position);\n    },\n    logFileWarning: (message: string, filePath: string, line?: number, position?: number) => {\n      _logWithLocation(writeWarning, message, filePath, line, position);\n    }\n  };\n\n  return _readResxAsLocFileInternal({\n    ...options,\n    resxContents,\n    loggingFunctions\n  });\n}\n\nfunction _readResxAsLocFileInternal(options: IResxReaderOptionsInternal): ILocalizationFile {\n  const xmlDocument: XmlDocument = new XmlDocument(options.resxContents);\n\n  if (xmlDocument.name !== 'root') {\n    _logErrorWithLocation(\n      options,\n      `Expected RESX to have a \"root\" element, found \"${xmlDocument.name}\"`,\n      xmlDocument\n    );\n  }\n\n  const locFile: ILocalizationFile = {};\n\n  for (const childNode of xmlDocument.children) {\n    switch (childNode.type) {\n      case 'element': {\n        switch (childNode.name) {\n          case 'data': {\n            const stringName: string = childNode.attr.name;\n            if (!stringName) {\n              _logErrorWithLocation(options, 'Unexpected missing or empty string name', childNode);\n            } else if (!STRING_NAME_RESX.test(stringName)) {\n              _logErrorWithLocation(options, `Invalid string name \"${stringName}\"`, childNode);\n            } else {\n              if (locFile.hasOwnProperty(stringName)) {\n                _logErrorWithLocation(options, `Duplicate string value \"${stringName}\"`, childNode);\n              }\n\n              const locString: ILocalizedString | undefined = _readDataElement(options, childNode);\n\n              if (locString) {\n                locFile[stringName] = locString;\n              }\n            }\n\n            break;\n          }\n\n          // Other allowed elements\n          case 'xsd:schema':\n          case 'resheader':\n            break;\n\n          default:\n            _logErrorWithLocation(options, `Unexpected RESX element ${childNode.name}`, childNode);\n        }\n\n        break;\n      }\n\n      case 'text': {\n        if (childNode.text.trim() !== '') {\n          _logErrorWithLocation(options, 'Found unexpected non-empty text node in RESX');\n        }\n\n        break;\n      }\n\n      case 'comment':\n        break;\n\n      default:\n        _logErrorWithLocation(options, `Unexpected ${childNode.type} child in RESX`);\n        break;\n    }\n  }\n\n  return locFile;\n}\n\nfunction _readDataElement(\n  options: IResxReaderOptionsInternal,\n  dataElement: XmlElement\n): ILocalizedString | undefined {\n  let foundCommentElement: boolean = false;\n  let foundValueElement: boolean = false;\n  let comment: string | undefined = undefined;\n  let value: string | undefined = undefined;\n\n  for (const childNode of dataElement.children) {\n    switch (childNode.type) {\n      case 'element': {\n        switch (childNode.name) {\n          case 'value': {\n            if (foundValueElement) {\n              _logErrorWithLocation(options, 'Duplicate <value> element found', childNode);\n            } else {\n              foundValueElement = true;\n              value = _readTextElement(options, childNode);\n              if (value && options.newlineNormalization) {\n                value = Text.convertTo(value, options.newlineNormalization);\n              }\n            }\n\n            break;\n          }\n\n          case 'comment': {\n            if (foundCommentElement) {\n              _logErrorWithLocation(options, 'Duplicate <comment> element found', childNode);\n            } else {\n              foundCommentElement = true;\n              comment = _readTextElement(options, childNode);\n            }\n\n            break;\n          }\n\n          default:\n            _logErrorWithLocation(options, `Unexpected RESX element ${childNode.name}`, childNode);\n            break;\n        }\n\n        break;\n      }\n\n      case 'text': {\n        if (childNode.text.trim() !== '') {\n          _logErrorWithLocation(\n            options,\n            'Found unexpected non-empty text node in RESX <data> element',\n            dataElement\n          );\n        }\n\n        break;\n      }\n\n      case 'comment':\n        break;\n\n      default:\n        _logErrorWithLocation(\n          options,\n          `Unexpected ${childNode.type} child in RESX <data> element`,\n          dataElement\n        );\n    }\n  }\n\n  if (!foundValueElement) {\n    _logErrorWithLocation(options, 'Missing string value in <data> element', dataElement);\n  } else {\n    if (comment === undefined && options.warnOnMissingComment) {\n      _logWarningWithLocation(options, 'Missing string comment in <data> element', dataElement);\n    }\n\n    return {\n      value: value || '',\n      comment\n    };\n  }\n}\n\nfunction _readTextElement(options: IResxReaderOptionsInternal, element: XmlElement): string | undefined {\n  let foundText: string | undefined = undefined;\n\n  for (const childNode of element.children) {\n    switch (childNode.type) {\n      case 'cdata':\n      case 'text': {\n        if (foundText !== undefined) {\n          _logErrorWithLocation(options, 'More than one child node found containing text content', element);\n          break;\n        }\n\n        foundText = childNode.type === 'text' ? childNode.text : childNode.cdata;\n        break;\n      }\n\n      case 'comment':\n        break;\n\n      case 'element':\n        _logErrorWithLocation(options, `Unexpected element`, childNode);\n        break;\n\n      default:\n        _logErrorWithLocation(options, `Unexpected ${element.type} child`, element);\n        break;\n    }\n  }\n\n  return foundText;\n}\n\nfunction _logErrorWithLocation(\n  options: IResxReaderOptionsInternal,\n  message: string,\n  element?: XmlElement | XmlDocument\n): void {\n  if (element) {\n    options.loggingFunctions.logFileError(\n      message,\n      options.resxFilePath,\n      element.line + 1,\n      element.column + 1\n    );\n  } else {\n    options.loggingFunctions.logFileError(message, options.resxFilePath);\n  }\n}\n\nfunction _logWarningWithLocation(\n  options: IResxReaderOptionsInternal,\n  message: string,\n  element?: XmlElement | XmlDocument\n): void {\n  if (element) {\n    options.loggingFunctions.logFileWarning(\n      message,\n      options.resxFilePath,\n      element.line + 1,\n      element.column + 1\n    );\n  } else {\n    options.loggingFunctions.logFileWarning(message, options.resxFilePath);\n  }\n}\n\nfunction _logWithLocation(\n  loggingFn: (message: string) => void,\n  message: string,\n  filePath: string,\n  line?: number,\n  position?: number\n): void {\n  let location: string;\n  if (position !== undefined) {\n    location = `${filePath}(${line},${position})`;\n  } else if (line !== undefined) {\n    location = `${filePath}(${line})`;\n  } else {\n    location = filePath;\n  }\n\n  loggingFn(`${location}: ${message}`);\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+export { ILocalizationFile, ILocalizedString, IPseudolocaleOptions } from './interfaces';
+export { parseLocFile, IParseLocFileOptions } from './LocFileParser';
+export { ITypingsGeneratorOptions, LocFileTypingsGenerator as TypingsGenerator } from './LocFileTypingsGenerator';
+export { readResxFileAsLocFile, readResxAsLocFile, IResxReaderOptions } from './ResxReader';
+export { getPseudolocalizer } from './Pseudolocalization';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACzF,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EACL,wBAAwB,EACxB,uBAAuB,IAAI,gBAAgB,EAC5C,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}

package/lib/index.js

@@ -0,0 +1,15 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPseudolocalizer = exports.readResxAsLocFile = exports.readResxFileAsLocFile = exports.TypingsGenerator = exports.parseLocFile = void 0;
+var LocFileParser_1 = require("./LocFileParser");
+Object.defineProperty(exports, "parseLocFile", { enumerable: true, get: function () { return LocFileParser_1.parseLocFile; } });
+var LocFileTypingsGenerator_1 = require("./LocFileTypingsGenerator");
+Object.defineProperty(exports, "TypingsGenerator", { enumerable: true, get: function () { return LocFileTypingsGenerator_1.LocFileTypingsGenerator; } });
+var ResxReader_1 = require("./ResxReader");
+Object.defineProperty(exports, "readResxFileAsLocFile", { enumerable: true, get: function () { return ResxReader_1.readResxFileAsLocFile; } });
+Object.defineProperty(exports, "readResxAsLocFile", { enumerable: true, get: function () { return ResxReader_1.readResxAsLocFile; } });
+var Pseudolocalization_1 = require("./Pseudolocalization");
+Object.defineProperty(exports, "getPseudolocalizer", { enumerable: true, get: function () { return Pseudolocalization_1.getPseudolocalizer; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,iDAAqE;AAA5D,6GAAA,YAAY,OAAA;AACrB,qEAGmC;AADjC,2HAAA,uBAAuB,OAAoB;AAE7C,2CAA4F;AAAnF,mHAAA,qBAAqB,OAAA;AAAE,+GAAA,iBAAiB,OAAA;AACjD,2DAA0D;AAAjD,wHAAA,kBAAkB,OAAA","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nexport { ILocalizationFile, ILocalizedString, IPseudolocaleOptions } from './interfaces';\nexport { parseLocFile, IParseLocFileOptions } from './LocFileParser';\nexport {\n  ITypingsGeneratorOptions,\n  LocFileTypingsGenerator as TypingsGenerator\n} from './LocFileTypingsGenerator';\nexport { readResxFileAsLocFile, readResxAsLocFile, IResxReaderOptions } from './ResxReader';\nexport { getPseudolocalizer } from './Pseudolocalization';\n"]}

package/lib/interfaces.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Options for the pseudolocale library.
+ *
+ * @internalRemarks
+ * Eventually this should be replaced with DefinitelyTyped types.
+ *
+ * @public
+ */
+export interface IPseudolocaleOptions {
+    prepend?: string;
+    append?: string;
+    delimiter?: string;
+    startDelimiter?: string;
+    endDelimiter?: string;
+    extend?: number;
+    override?: string;
+}
+/**
+ * @public
+ */
+export interface ILocalizationFile {
+    [stringName: string]: ILocalizedString;
+}
+/**
+ * @public
+ */
+export interface ILocalizedString {
+    value: string;
+    comment?: string;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/lib/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/lib/interfaces.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interfaces.js.map

package/lib/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * Options for the pseudolocale library.\n *\n * @internalRemarks\n * Eventually this should be replaced with DefinitelyTyped types.\n *\n * @public\n */\nexport interface IPseudolocaleOptions {\n  prepend?: string;\n  append?: string;\n  delimiter?: string;\n  startDelimiter?: string;\n  endDelimiter?: string;\n  extend?: number;\n  override?: string;\n}\n\n/**\n * @public\n */\nexport interface ILocalizationFile {\n  [stringName: string]: ILocalizedString;\n}\n\n/**\n * @public\n */\nexport interface ILocalizedString {\n  value: string;\n  comment?: string;\n}\n"]}

package/lib/schemas/locJson.schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Localizable JSON file",
+
+  "properties": {
+    "$schema": {
+      "description": "Part of the JSON Schema standard, this optional keyword declares the URL of the schema that the file conforms to. Editors may download the schema and use it to perform syntax highlighting.",
+      "type": "string"
+    }
+  },
+  "patternProperties": {
+    "^[A-Za-z_][0-9A-Za-z_]*$": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": "string"
+        },
+        "comment": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": ["value"]
+    }
+  },
+  "additionalProperties": false,
+  "type": "object"
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@rushstack/localization-utilities",
+  "version": "0.1.0",
+  "description": "This plugin contains some useful functions for localization.",
+  "main": "lib/index.js",
+  "typings": "dist/localization-utilities.d.ts",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/rushstack.git",
+    "directory": "libraries/localization-utilities"
+  },
+  "dependencies": {
+    "@rushstack/node-core-library": "3.45.5",
+    "@rushstack/typings-generator": "0.6.25",
+    "decache": "~4.5.1",
+    "pseudolocale": "~1.1.0",
+    "xmldoc": "~1.1.2"
+  },
+  "devDependencies": {
+    "@rushstack/eslint-config": "2.6.0",
+    "@rushstack/heft": "0.45.5",
+    "@rushstack/heft-node-rig": "1.9.6",
+    "@types/node": "12.20.24",
+    "@types/xmldoc": "1.1.4"
+  },
+  "scripts": {
+    "build": "heft build --clean",
+    "_phase:build": "heft build --clean"
+  },
+  "readme": "# @rushstack/localization-utilities\n\nThis library provides a set of utilities for working with localization files.\n"
+}