@rushstack/localization-utilities 0.5.0 → 0.7.1

package/dist/localization-utilities.d.ts

@@ -82,25 +82,6 @@ export declare interface IPseudolocaleOptions {
     override?: string;
 }
 
-/**
- * @deprecated
- *
- * This has superseded by {@link IParseResxOptions}
- *
- * @public
- */
-export declare interface IResxReaderOptions {
-    resxFilePath: string;
-    terminal: ITerminal;
-    newlineNormalization: NewlineKind | undefined;
-    warnOnMissingComment: boolean;
-    /**
-     * Optionally, provide a function that will be called for each string. If the function returns `true`
-     * the string will not be included.
-     */
-    ignoreString?: IgnoreStringFunction;
-}
-
 /**
  * @public
  */
@@ -141,24 +122,6 @@ export declare function parseResx(options: IParseResxOptions): ILocalizationFile
  */
 export declare type ParserKind = 'resx' | 'loc.json' | 'resjson';
 
-/**
- * @deprecated
- *
- * Use {@link parseResx} instead.
- *
- * @public
- */
-export declare function readResxAsLocFile(resxContents: string, options: IResxReaderOptions): ILocalizationFile;
-
-/**
- * @deprecated
- *
- * Use {@link parseResx} instead.
- *
- * @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.
  *

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.25.0"
+      "packageVersion": "7.25.1"
     }
   ]
 }

package/lib/index.d.ts

@@ -4,6 +4,5 @@ export { parseResJson } from './parsers/parseResJson';
 export { parseResx, IParseResxOptions, IParseResxOptionsBase } from './parsers/parseResx';
 export { parseLocFile, IParseLocFileOptions, ParserKind } from './LocFileParser';
 export { ITypingsGeneratorOptions, TypingsGenerator } from './TypingsGenerator';
-export { readResxFileAsLocFile, readResxAsLocFile, IResxReaderOptions } from './LegacyResxReader';
 export { getPseudolocalizer } from './Pseudolocalization';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,YAAY,EACV,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACjF,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAClG,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,YAAY,EACV,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACjF,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}

package/lib/index.js

@@ -2,7 +2,7 @@
 // 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 = exports.parseResx = exports.parseResJson = exports.parseLocJson = void 0;
+exports.getPseudolocalizer = exports.TypingsGenerator = exports.parseLocFile = exports.parseResx = exports.parseResJson = exports.parseLocJson = void 0;
 var parseLocJson_1 = require("./parsers/parseLocJson");
 Object.defineProperty(exports, "parseLocJson", { enumerable: true, get: function () { return parseLocJson_1.parseLocJson; } });
 var parseResJson_1 = require("./parsers/parseResJson");
@@ -13,9 +13,6 @@ var LocFileParser_1 = require("./LocFileParser");
 Object.defineProperty(exports, "parseLocFile", { enumerable: true, get: function () { return LocFileParser_1.parseLocFile; } });
 var TypingsGenerator_1 = require("./TypingsGenerator");
 Object.defineProperty(exports, "TypingsGenerator", { enumerable: true, get: function () { return TypingsGenerator_1.TypingsGenerator; } });
-var LegacyResxReader_1 = require("./LegacyResxReader");
-Object.defineProperty(exports, "readResxFileAsLocFile", { enumerable: true, get: function () { return LegacyResxReader_1.readResxFileAsLocFile; } });
-Object.defineProperty(exports, "readResxAsLocFile", { enumerable: true, get: function () { return LegacyResxReader_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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAS3D,uDAAsD;AAA7C,4GAAA,YAAY,OAAA;AACrB,uDAAsD;AAA7C,4GAAA,YAAY,OAAA;AACrB,iDAA0F;AAAjF,sGAAA,SAAS,OAAA;AAClB,iDAAiF;AAAxE,6GAAA,YAAY,OAAA;AACrB,uDAAgF;AAA7C,oHAAA,gBAAgB,OAAA;AACnD,uDAAkG;AAAzF,yHAAA,qBAAqB,OAAA;AAAE,qHAAA,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 type {\n  ILocalizationFile,\n  ILocalizedString,\n  IPseudolocaleOptions,\n  IParseFileOptions,\n  IgnoreStringFunction\n} from './interfaces';\nexport { parseLocJson } from './parsers/parseLocJson';\nexport { parseResJson } from './parsers/parseResJson';\nexport { parseResx, IParseResxOptions, IParseResxOptionsBase } from './parsers/parseResx';\nexport { parseLocFile, IParseLocFileOptions, ParserKind } from './LocFileParser';\nexport { ITypingsGeneratorOptions, TypingsGenerator } from './TypingsGenerator';\nexport { readResxFileAsLocFile, readResxAsLocFile, IResxReaderOptions } from './LegacyResxReader';\nexport { getPseudolocalizer } from './Pseudolocalization';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAS3D,uDAAsD;AAA7C,4GAAA,YAAY,OAAA;AACrB,uDAAsD;AAA7C,4GAAA,YAAY,OAAA;AACrB,iDAA0F;AAAjF,sGAAA,SAAS,OAAA;AAClB,iDAAiF;AAAxE,6GAAA,YAAY,OAAA;AACrB,uDAAgF;AAA7C,oHAAA,gBAAgB,OAAA;AACnD,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 type {\n  ILocalizationFile,\n  ILocalizedString,\n  IPseudolocaleOptions,\n  IParseFileOptions,\n  IgnoreStringFunction\n} from './interfaces';\nexport { parseLocJson } from './parsers/parseLocJson';\nexport { parseResJson } from './parsers/parseResJson';\nexport { parseResx, IParseResxOptions, IParseResxOptionsBase } from './parsers/parseResx';\nexport { parseLocFile, IParseLocFileOptions, ParserKind } from './LocFileParser';\nexport { ITypingsGeneratorOptions, TypingsGenerator } from './TypingsGenerator';\nexport { getPseudolocalizer } from './Pseudolocalization';\n"]}

package/lib/parsers/parseLocJson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseLocJson.d.ts","sourceRoot":"","sources":["../../src/parsers/parseLocJson.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAKrE;;GAEG;AACH,wBAAgB,YAAY,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,iBAAiB,GAAG,iBAAiB,CAoBtG"}
+{"version":3,"file":"parseLocJson.d.ts","sourceRoot":"","sources":["../../src/parsers/parseLocJson.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAKrE;;GAEG;AACH,wBAAgB,YAAY,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,iBAAiB,GAAG,iBAAiB,CAoBtG"}

package/lib/parsers/parseLocJson.js

@@ -3,10 +3,9 @@
 // See LICENSE in the project root for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseLocJson = void 0;
-const path_1 = require("path");
 const node_core_library_1 = require("@rushstack/node-core-library");
-const LOC_JSON_SCHEMA_PATH = (0, path_1.resolve)(__dirname, '../schemas/locJson.schema.json');
-const LOC_JSON_SCHEMA = node_core_library_1.JsonSchema.fromFile(LOC_JSON_SCHEMA_PATH);
+// Use `require` here to allow this package to be bundled with Webpack.
+const LOC_JSON_SCHEMA = node_core_library_1.JsonSchema.fromLoadedObject(require('../schemas/locJson.schema.json'));
 /**
  * @public
  */

package/lib/parsers/parseLocJson.js.map

@@ -1 +1 @@
-{"version":3,"file":"parseLocJson.js","sourceRoot":"","sources":["../../src/parsers/parseLocJson.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,+BAA+B;AAE/B,oEAAoE;AAIpE,MAAM,oBAAoB,GAAW,IAAA,cAAO,EAAC,SAAS,EAAE,gCAAgC,CAAC,CAAC;AAC1F,MAAM,eAAe,GAAe,8BAAU,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;AAE9E;;GAEG;AACH,SAAgB,YAAY,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAqB;IACjF,MAAM,UAAU,GAAsB,4BAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACpE,IAAI;QACF,eAAe,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;KACtD;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,EAAE,CAAC,CAAC;KACzD;IAED,IAAI,YAAY,EAAE;QAChB,MAAM,aAAa,GAAsB,EAAE,CAAC;QAC5C,KAAK,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC1D,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE;gBAChC,aAAa,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC;aACjC;SACF;QAED,OAAO,aAAa,CAAC;KACtB;SAAM;QACL,OAAO,UAAU,CAAC;KACnB;AACH,CAAC;AApBD,oCAoBC","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 { resolve } from 'path';\n\nimport { JsonFile, JsonSchema } from '@rushstack/node-core-library';\n\nimport { ILocalizationFile, IParseFileOptions } from '../interfaces';\n\nconst LOC_JSON_SCHEMA_PATH: string = resolve(__dirname, '../schemas/locJson.schema.json');\nconst LOC_JSON_SCHEMA: JsonSchema = JsonSchema.fromFile(LOC_JSON_SCHEMA_PATH);\n\n/**\n * @public\n */\nexport function parseLocJson({ content, filePath, ignoreString }: IParseFileOptions): ILocalizationFile {\n  const parsedFile: ILocalizationFile = JsonFile.parseString(content);\n  try {\n    LOC_JSON_SCHEMA.validateObject(parsedFile, filePath);\n  } catch (e) {\n    throw new Error(`The loc file is invalid. Error: ${e}`);\n  }\n\n  if (ignoreString) {\n    const newParsedFile: ILocalizationFile = {};\n    for (const [key, stringData] of Object.entries(parsedFile)) {\n      if (!ignoreString(filePath, key)) {\n        newParsedFile[key] = stringData;\n      }\n    }\n\n    return newParsedFile;\n  } else {\n    return parsedFile;\n  }\n}\n"]}
+{"version":3,"file":"parseLocJson.js","sourceRoot":"","sources":["../../src/parsers/parseLocJson.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAoE;AAIpE,uEAAuE;AACvE,MAAM,eAAe,GAAe,8BAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC,CAAC;AAE3G;;GAEG;AACH,SAAgB,YAAY,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAqB;IACjF,MAAM,UAAU,GAAsB,4BAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACpE,IAAI;QACF,eAAe,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;KACtD;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,EAAE,CAAC,CAAC;KACzD;IAED,IAAI,YAAY,EAAE;QAChB,MAAM,aAAa,GAAsB,EAAE,CAAC;QAC5C,KAAK,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC1D,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE;gBAChC,aAAa,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC;aACjC;SACF;QAED,OAAO,aAAa,CAAC;KACtB;SAAM;QACL,OAAO,UAAU,CAAC;KACnB;AACH,CAAC;AApBD,oCAoBC","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 { JsonFile, JsonSchema } from '@rushstack/node-core-library';\n\nimport { ILocalizationFile, IParseFileOptions } from '../interfaces';\n\n// Use `require` here to allow this package to be bundled with Webpack.\nconst LOC_JSON_SCHEMA: JsonSchema = JsonSchema.fromLoadedObject(require('../schemas/locJson.schema.json'));\n\n/**\n * @public\n */\nexport function parseLocJson({ content, filePath, ignoreString }: IParseFileOptions): ILocalizationFile {\n  const parsedFile: ILocalizationFile = JsonFile.parseString(content);\n  try {\n    LOC_JSON_SCHEMA.validateObject(parsedFile, filePath);\n  } catch (e) {\n    throw new Error(`The loc file is invalid. Error: ${e}`);\n  }\n\n  if (ignoreString) {\n    const newParsedFile: ILocalizationFile = {};\n    for (const [key, stringData] of Object.entries(parsedFile)) {\n      if (!ignoreString(filePath, key)) {\n        newParsedFile[key] = stringData;\n      }\n    }\n\n    return newParsedFile;\n  } else {\n    return parsedFile;\n  }\n}\n"]}

package/lib/parsers/parseResx.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseResx.d.ts","sourceRoot":"","sources":["../../src/parsers/parseResx.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAQ,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAG5E,OAAO,KAAK,EAAoB,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAI5F;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB,EAAE,qBAAqB;CAAG;AAEtF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,SAAS,CAAC;IACpB,wBAAwB,EAAE,WAAW,GAAG,SAAS,CAAC;IAClD,yBAAyB,EAAE,OAAO,GAAG,SAAS,CAAC;CAChD;AAaD;;GAEG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,iBAAiB,GAAG,iBAAiB,CAkBvE"}
+{"version":3,"file":"parseResx.d.ts","sourceRoot":"","sources":["../../src/parsers/parseResx.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAQ,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAG5E,OAAO,KAAK,EAAoB,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB,EAAE,qBAAqB;CAAG;AAEtF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,SAAS,CAAC;IACpB,wBAAwB,EAAE,WAAW,GAAG,SAAS,CAAC;IAClD,yBAAyB,EAAE,OAAO,GAAG,SAAS,CAAC;CAChD;AAaD;;GAEG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,iBAAiB,GAAG,iBAAiB,CAkBvE"}

package/lib/parsers/parseResx.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseResx = 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
  */
@@ -44,9 +43,6 @@ function _readResxAsLocFileInternal(options) {
                         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);

package/lib/parsers/parseResx.js.map

@@ -1 +1 @@
-{"version":3,"file":"parseResx.js","sourceRoot":"","sources":["../../src/parsers/parseResx.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAA4E;AAC5E,mCAAiD;AAIjD,MAAM,gBAAgB,GAAW,sBAAsB,CAAC;AA2BxD;;GAEG;AACH,SAAgB,SAAS,CAAC,OAA0B;IAClD,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,CAAC;QAChC,GAAG,OAAO;QACV,gBAAgB;KACjB,CAAC,CAAC;AACL,CAAC;AAlBD,8BAkBC;AAED,SAAS,0BAA0B,CAAC,OAAmC;IACrE,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IACjC,MAAM,WAAW,GAAgB,IAAI,oBAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAElE,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,IAAI,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAG,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA,EAAE;gCAC9D,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,wBAAwB,EAAE;gCAC7C,KAAK,GAAG,wBAAI,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;6BACjE;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,yBAAyB,KAAK,KAAK,EAAE;YACxE,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,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;KACxG;SAAM;QACL,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;KAClE;AACH,CAAC;AAED,SAAS,uBAAuB,CAC9B,OAAmC,EACnC,OAAe,EACf,OAAkC;IAElC,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;KAC1G;SAAM;QACL,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;KACpE;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 { ITerminal, Text, NewlineKind } from '@rushstack/node-core-library';\nimport { XmlDocument, XmlElement } from 'xmldoc';\n\nimport type { ILocalizedString, ILocalizationFile, IParseFileOptions } from '../interfaces';\n\nconst STRING_NAME_RESX: RegExp = /^[A-z_$][A-z0-9_$]*$/;\n\n/**\n * @public\n */\nexport interface IParseResxOptions extends IParseFileOptions, IParseResxOptionsBase {}\n\n/**\n * @public\n */\nexport interface IParseResxOptionsBase {\n  terminal: ITerminal;\n  resxNewlineNormalization: NewlineKind | undefined;\n  ignoreMissingResxComments: boolean | undefined;\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<IParseResxOptions, 'terminal'> {\n  loggingFunctions: ILoggingFunctions;\n}\n\n/**\n * @public\n */\nexport function parseResx(options: IParseResxOptions): 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    loggingFunctions\n  });\n}\n\nfunction _readResxAsLocFileInternal(options: IResxReaderOptionsInternal): ILocalizationFile {\n  const { ignoreString } = options;\n  const xmlDocument: XmlDocument = new XmlDocument(options.content);\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 && !ignoreString?.(options.filePath, stringName)) {\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.resxNewlineNormalization) {\n                value = Text.convertTo(value, options.resxNewlineNormalization);\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.ignoreMissingResxComments === false) {\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(message, options.filePath, element.line + 1, element.column + 1);\n  } else {\n    options.loggingFunctions.logFileError(message, options.filePath);\n  }\n}\n\nfunction _logWarningWithLocation(\n  options: IResxReaderOptionsInternal,\n  message: string,\n  element?: XmlElement | XmlDocument\n): void {\n  if (element) {\n    options.loggingFunctions.logFileWarning(message, options.filePath, element.line + 1, element.column + 1);\n  } else {\n    options.loggingFunctions.logFileWarning(message, options.filePath);\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"]}
+{"version":3,"file":"parseResx.js","sourceRoot":"","sources":["../../src/parsers/parseResx.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAA4E;AAC5E,mCAAiD;AA6BjD;;GAEG;AACH,SAAgB,SAAS,CAAC,OAA0B;IAClD,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,CAAC;QAChC,GAAG,OAAO;QACV,gBAAgB;KACjB,CAAC,CAAC;AACL,CAAC;AAlBD,8BAkBC;AAED,SAAS,0BAA0B,CAAC,OAAmC;IACrE,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IACjC,MAAM,WAAW,GAAgB,IAAI,oBAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAElE,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;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,IAAI,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAG,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA,EAAE;gCAC9D,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,wBAAwB,EAAE;gCAC7C,KAAK,GAAG,wBAAI,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;6BACjE;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,yBAAyB,KAAK,KAAK,EAAE;YACxE,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,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;KACxG;SAAM;QACL,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;KAClE;AACH,CAAC;AAED,SAAS,uBAAuB,CAC9B,OAAmC,EACnC,OAAe,EACf,OAAkC;IAElC,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;KAC1G;SAAM;QACL,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;KACpE;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 { ITerminal, Text, NewlineKind } from '@rushstack/node-core-library';\nimport { XmlDocument, XmlElement } from 'xmldoc';\n\nimport type { ILocalizedString, ILocalizationFile, IParseFileOptions } from '../interfaces';\n\n/**\n * @public\n */\nexport interface IParseResxOptions extends IParseFileOptions, IParseResxOptionsBase {}\n\n/**\n * @public\n */\nexport interface IParseResxOptionsBase {\n  terminal: ITerminal;\n  resxNewlineNormalization: NewlineKind | undefined;\n  ignoreMissingResxComments: boolean | undefined;\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<IParseResxOptions, 'terminal'> {\n  loggingFunctions: ILoggingFunctions;\n}\n\n/**\n * @public\n */\nexport function parseResx(options: IParseResxOptions): 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    loggingFunctions\n  });\n}\n\nfunction _readResxAsLocFileInternal(options: IResxReaderOptionsInternal): ILocalizationFile {\n  const { ignoreString } = options;\n  const xmlDocument: XmlDocument = new XmlDocument(options.content);\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 {\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 && !ignoreString?.(options.filePath, stringName)) {\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.resxNewlineNormalization) {\n                value = Text.convertTo(value, options.resxNewlineNormalization);\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.ignoreMissingResxComments === false) {\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(message, options.filePath, element.line + 1, element.column + 1);\n  } else {\n    options.loggingFunctions.logFileError(message, options.filePath);\n  }\n}\n\nfunction _logWarningWithLocation(\n  options: IResxReaderOptionsInternal,\n  message: string,\n  element?: XmlElement | XmlDocument\n): void {\n  if (element) {\n    options.loggingFunctions.logFileWarning(message, options.filePath, element.line + 1, element.column + 1);\n  } else {\n    options.loggingFunctions.logFileWarning(message, options.filePath);\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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/localization-utilities",
-  "version": "0.5.0",
+  "version": "0.7.1",
   "description": "This plugin contains some useful functions for localization.",
   "main": "lib/index.js",
   "typings": "dist/localization-utilities.d.ts",
@@ -11,15 +11,15 @@
     "directory": "libraries/localization-utilities"
   },
   "dependencies": {
-    "@rushstack/node-core-library": "3.45.5",
-    "@rushstack/typings-generator": "0.6.26",
+    "@rushstack/node-core-library": "3.45.7",
+    "@rushstack/typings-generator": "0.6.28",
     "pseudolocale": "~1.1.0",
     "xmldoc": "~1.1.2"
   },
   "devDependencies": {
-    "@rushstack/eslint-config": "2.6.0",
-    "@rushstack/heft": "0.45.6",
-    "@rushstack/heft-node-rig": "1.9.7",
+    "@rushstack/eslint-config": "2.6.1",
+    "@rushstack/heft": "0.45.8",
+    "@rushstack/heft-node-rig": "1.9.9",
     "@types/heft-jest": "1.0.1",
     "@types/node": "12.20.24",
     "@types/xmldoc": "1.1.4"

package/lib/LegacyResxReader.d.ts

@@ -1,37 +0,0 @@
-import { ITerminal, NewlineKind } from '@rushstack/node-core-library';
-import type { IgnoreStringFunction, ILocalizationFile } from './interfaces';
-/**
- * @deprecated
- *
- * This has superseded by {@link IParseResxOptions}
- *
- * @public
- */
-export interface IResxReaderOptions {
-    resxFilePath: string;
-    terminal: ITerminal;
-    newlineNormalization: NewlineKind | undefined;
-    warnOnMissingComment: boolean;
-    /**
-     * Optionally, provide a function that will be called for each string. If the function returns `true`
-     * the string will not be included.
-     */
-    ignoreString?: IgnoreStringFunction;
-}
-/**
- * @deprecated
- *
- * Use {@link parseResx} instead.
- *
- * @public
- */
-export declare function readResxFileAsLocFile(options: IResxReaderOptions): ILocalizationFile;
-/**
- * @deprecated
- *
- * Use {@link parseResx} instead.
- *
- * @public
- */
-export declare function readResxAsLocFile(resxContents: string, options: IResxReaderOptions): ILocalizationFile;
-//# sourceMappingURL=LegacyResxReader.d.ts.map

package/lib/LegacyResxReader.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"LegacyResxReader.d.ts","sourceRoot":"","sources":["../src/LegacyResxReader.ts"],"names":[],"mappings":"AAGA,OAAO,EAAc,SAAS,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAElF,OAAO,KAAK,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAG5E;;;;;;GAMG;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;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,kBAAkB,GAAG,iBAAiB,CASpF;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,iBAAiB,CAQtG"}

package/lib/LegacyResxReader.js

@@ -1,43 +0,0 @@
-"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 parseResx_1 = require("./parsers/parseResx");
-/**
- * @deprecated
- *
- * Use {@link parseResx} instead.
- *
- * @public
- */
-function readResxFileAsLocFile(options) {
-    const content = node_core_library_1.FileSystem.readFile(options.resxFilePath);
-    return (0, parseResx_1.parseResx)({
-        ...options,
-        content,
-        filePath: options.resxFilePath,
-        resxNewlineNormalization: options.newlineNormalization,
-        ignoreMissingResxComments: !options.warnOnMissingComment
-    });
-}
-exports.readResxFileAsLocFile = readResxFileAsLocFile;
-/**
- * @deprecated
- *
- * Use {@link parseResx} instead.
- *
- * @public
- */
-function readResxAsLocFile(resxContents, options) {
-    return (0, parseResx_1.parseResx)({
-        ...options,
-        content: resxContents,
-        filePath: options.resxFilePath,
-        resxNewlineNormalization: options.newlineNormalization,
-        ignoreMissingResxComments: !options.warnOnMissingComment
-    });
-}
-exports.readResxAsLocFile = readResxAsLocFile;
-//# sourceMappingURL=LegacyResxReader.js.map

package/lib/LegacyResxReader.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LegacyResxReader.js","sourceRoot":"","sources":["../src/LegacyResxReader.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAkF;AAGlF,mDAAgD;AAqBhD;;;;;;GAMG;AACH,SAAgB,qBAAqB,CAAC,OAA2B;IAC/D,MAAM,OAAO,GAAW,8BAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAClE,OAAO,IAAA,qBAAS,EAAC;QACf,GAAG,OAAO;QACV,OAAO;QACP,QAAQ,EAAE,OAAO,CAAC,YAAY;QAC9B,wBAAwB,EAAE,OAAO,CAAC,oBAAoB;QACtD,yBAAyB,EAAE,CAAC,OAAO,CAAC,oBAAoB;KACzD,CAAC,CAAC;AACL,CAAC;AATD,sDASC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,YAAoB,EAAE,OAA2B;IACjF,OAAO,IAAA,qBAAS,EAAC;QACf,GAAG,OAAO;QACV,OAAO,EAAE,YAAY;QACrB,QAAQ,EAAE,OAAO,CAAC,YAAY;QAC9B,wBAAwB,EAAE,OAAO,CAAC,oBAAoB;QACtD,yBAAyB,EAAE,CAAC,OAAO,CAAC,oBAAoB;KACzD,CAAC,CAAC;AACL,CAAC;AARD,8CAQC","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, NewlineKind } from '@rushstack/node-core-library';\n\nimport type { IgnoreStringFunction, ILocalizationFile } from './interfaces';\nimport { parseResx } from './parsers/parseResx';\n\n/**\n * @deprecated\n *\n * This has superseded by {@link IParseResxOptions}\n *\n * @public\n */\nexport interface IResxReaderOptions {\n  resxFilePath: string;\n  terminal: ITerminal;\n  newlineNormalization: NewlineKind | undefined;\n  warnOnMissingComment: boolean;\n  /**\n   * Optionally, provide a function that will be called for each string. If the function returns `true`\n   * the string will not be included.\n   */\n  ignoreString?: IgnoreStringFunction;\n}\n\n/**\n * @deprecated\n *\n * Use {@link parseResx} instead.\n *\n * @public\n */\nexport function readResxFileAsLocFile(options: IResxReaderOptions): ILocalizationFile {\n  const content: string = FileSystem.readFile(options.resxFilePath);\n  return parseResx({\n    ...options,\n    content,\n    filePath: options.resxFilePath,\n    resxNewlineNormalization: options.newlineNormalization,\n    ignoreMissingResxComments: !options.warnOnMissingComment\n  });\n}\n\n/**\n * @deprecated\n *\n * Use {@link parseResx} instead.\n *\n * @public\n */\nexport function readResxAsLocFile(resxContents: string, options: IResxReaderOptions): ILocalizationFile {\n  return parseResx({\n    ...options,\n    content: resxContents,\n    filePath: options.resxFilePath,\n    resxNewlineNormalization: options.newlineNormalization,\n    ignoreMissingResxComments: !options.warnOnMissingComment\n  });\n}\n"]}