@rushstack/webpack5-localization-plugin 0.1.0

package/lib/AssetProcessor.js

@@ -0,0 +1,243 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processNonLocalizedAsset = exports.processLocalizedAsset = exports.PLACEHOLDER_REGEX = void 0;
+const Constants = __importStar(require("./utilities/Constants"));
+exports.PLACEHOLDER_REGEX = new RegExp(`${Constants.STRING_PLACEHOLDER_PREFIX}_(\\\\*)_([A-C])_([0-9a-f]+)`, 'g');
+function processLocalizedAsset(options) {
+    const { compilation, asset, chunk, filenameTemplate, locales } = options;
+    const { sources, WebpackError } = compilation.compiler.webpack;
+    const rawSource = new sources.CachedSource(asset.source);
+    const assetSource = rawSource.source().toString();
+    const parsedAsset = _parseStringToReconstructionSequence(options.plugin, assetSource);
+    const { issues } = parsedAsset;
+    const localizedFiles = {};
+    chunk.localizedFiles = localizedFiles;
+    const { info: originInfo, name: originName } = asset;
+    if (!originInfo.related) {
+        originInfo.related = {};
+    }
+    for (const locale of locales) {
+        const { issues: localeIssues, result: localeResult } = _reconstructLocalized(new sources.ReplaceSource(rawSource, locale), parsedAsset.reconstructionSeries, locale, options.fillMissingTranslationStrings ? options.defaultLocale : undefined);
+        for (const issue of localeIssues) {
+            issues.push(issue);
+        }
+        const data = {
+            chunk,
+            contentHashType: 'javascript',
+            // The locale property will get processed by the extension to the getAssetPath hook
+            locale
+        };
+        const fileName = compilation.getAssetPath(filenameTemplate, data);
+        originInfo.related[locale] = fileName;
+        const info = {
+            ...originInfo,
+            locale
+        };
+        const wrapped = new sources.CachedSource(localeResult);
+        localizedFiles[locale] = fileName;
+        if (originName === fileName) {
+            // This helper throws if the asset doesn't already exist
+            compilation.updateAsset(fileName, wrapped, info);
+        }
+        else {
+            // This helper throws if the asset already exists
+            compilation.emitAsset(fileName, wrapped, info);
+        }
+    }
+    if (issues.length > 0) {
+        compilation.errors.push(new WebpackError(`localization:\n${issues.map((issue) => `  ${issue}`).join('\n')}`));
+    }
+    return localizedFiles;
+}
+exports.processLocalizedAsset = processLocalizedAsset;
+function processNonLocalizedAsset(options) {
+    const { asset, fileName, compilation } = options;
+    const { sources, WebpackError } = compilation.compiler.webpack;
+    const rawSource = new sources.CachedSource(asset.source);
+    const assetSource = rawSource.source().toString();
+    const parsedAsset = _parseStringToReconstructionSequence(options.plugin, assetSource);
+    const { info: originInfo } = asset;
+    const { issues } = parsedAsset;
+    const locale = options.noStringsLocaleName;
+    const { issues: localeIssues, result } = _reconstructNonLocalized(new sources.ReplaceSource(rawSource, locale), parsedAsset.reconstructionSeries, locale);
+    for (const issue of localeIssues) {
+        issues.push(issue);
+    }
+    const info = {
+        ...originInfo,
+        locale
+    };
+    const wrapped = new sources.CachedSource(result);
+    compilation.updateAsset(fileName, wrapped, info);
+    if (issues.length > 0) {
+        options.compilation.errors.push(new WebpackError(`localization:\n${issues.map((issue) => `  ${issue}`).join('\n')}`));
+    }
+}
+exports.processNonLocalizedAsset = processNonLocalizedAsset;
+const ESCAPE_MAP = new Map([
+    ['\r', 'r'],
+    ['\n', 'n'],
+    ['\t', 't'],
+    ['"', 'u0022'],
+    ["'", 'u0027']
+]);
+const BACKSLASH_REGEX = /\\/g;
+const ESCAPE_REGEX = /[\r\n\t"']/g;
+function _reconstructLocalized(result, reconstructionSeries, locale, fallbackLocale) {
+    const issues = [];
+    for (const element of reconstructionSeries) {
+        switch (element.kind) {
+            case 'localized': {
+                const { data } = element;
+                let newValue = data.valuesByLocale.get(locale);
+                if (newValue === undefined) {
+                    if (fallbackLocale) {
+                        newValue = data.valuesByLocale.get(fallbackLocale);
+                    }
+                    else {
+                        issues.push(`The string "${data.stringName}" in "${data.locFilePath}" is missing in ` +
+                            `the locale ${locale}`);
+                        newValue = '-- MISSING STRING --';
+                    }
+                }
+                const escapedBackslash = element.escapedBackslash || '\\';
+                // Replace backslashes with the properly escaped backslash
+                BACKSLASH_REGEX.lastIndex = -1;
+                newValue = newValue.replace(BACKSLASH_REGEX, escapedBackslash);
+                // @todo: look into using JSON.parse(...) to get the escaping characters
+                const escapingCharacterSequence = escapedBackslash.slice(escapedBackslash.length / 2);
+                // Ensure the the quotemark, apostrophe, tab, and newline characters are properly escaped
+                ESCAPE_REGEX.lastIndex = -1;
+                newValue = newValue.replace(ESCAPE_REGEX, (match) => `${escapingCharacterSequence}${ESCAPE_MAP.get(match)}`);
+                result.replace(element.start, element.end - 1, newValue);
+                break;
+            }
+            case 'dynamic': {
+                const newValue = element.valueFn(locale);
+                result.replace(element.start, element.end - 1, newValue);
+                break;
+            }
+        }
+    }
+    return {
+        issues,
+        result
+    };
+}
+function _reconstructNonLocalized(result, reconstructionSeries, noStringsLocaleName) {
+    const issues = [];
+    for (const element of reconstructionSeries) {
+        switch (element.kind) {
+            case 'localized': {
+                issues.push(`The string "${element.data.stringName}" in "${element.data.locFilePath}" appeared in an asset ` +
+                    'that is not expected to contain localized resources.');
+                const newValue = '-- NOT EXPECTED TO BE LOCALIZED --';
+                result.replace(element.start, element.end - 1, newValue);
+                break;
+            }
+            case 'dynamic': {
+                const newValue = element.valueFn(noStringsLocaleName);
+                result.replace(element.start, element.end - 1, newValue);
+                break;
+            }
+        }
+    }
+    return {
+        issues,
+        result
+    };
+}
+function _rawLocaleToken(locale) {
+    return locale;
+}
+function _jsonLocaleToken(locale) {
+    return JSON.stringify(locale);
+}
+function _parseStringToReconstructionSequence(plugin, source) {
+    const issues = [];
+    const reconstructionSeries = [];
+    let regexResult;
+    exports.PLACEHOLDER_REGEX.lastIndex = -1;
+    while ((regexResult = exports.PLACEHOLDER_REGEX.exec(source))) {
+        const [placeholder, escapedBackslash, elementLabel, placeholderSerialNumber] = regexResult;
+        const start = regexResult.index;
+        const end = start + placeholder.length;
+        let localizedReconstructionElement;
+        switch (elementLabel) {
+            case Constants.STRING_PLACEHOLDER_LABEL: {
+                const stringData = plugin.getDataForSerialNumber(placeholderSerialNumber);
+                if (!stringData) {
+                    issues.push(`Missing placeholder ${placeholder}`);
+                    continue;
+                }
+                else {
+                    const localizedElement = {
+                        kind: 'localized',
+                        start,
+                        end,
+                        escapedBackslash,
+                        data: stringData
+                    };
+                    localizedReconstructionElement = localizedElement;
+                }
+                break;
+            }
+            case Constants.LOCALE_NAME_PLACEHOLDER_LABEL: {
+                const dynamicElement = {
+                    kind: 'dynamic',
+                    start,
+                    end,
+                    escapedBackslash,
+                    valueFn: _rawLocaleToken
+                };
+                localizedReconstructionElement = dynamicElement;
+                break;
+            }
+            case Constants.JSONP_PLACEHOLDER_LABEL: {
+                const dynamicElement = {
+                    kind: 'dynamic',
+                    start,
+                    end,
+                    escapedBackslash,
+                    valueFn: _jsonLocaleToken
+                };
+                localizedReconstructionElement = dynamicElement;
+                break;
+            }
+            default: {
+                throw new Error(`Unexpected label ${elementLabel}`);
+            }
+        }
+        reconstructionSeries.push(localizedReconstructionElement);
+    }
+    return {
+        issues,
+        reconstructionSeries
+    };
+}
+//# sourceMappingURL=AssetProcessor.js.map

package/lib/AssetProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetProcessor.js","sourceRoot":"","sources":["../src/AssetProcessor.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAI3D,iEAAmD;AA6DtC,QAAA,iBAAiB,GAAW,IAAI,MAAM,CACjD,GAAG,SAAS,CAAC,yBAAyB,8BAA8B,EACpE,GAAG,CACJ,CAAC;AAEF,SAAgB,qBAAqB,CAAC,OAAsC;IAC1E,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAEzE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC;IAE/D,MAAM,SAAS,GAAyB,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/E,MAAM,WAAW,GAAW,SAAS,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC;IAE1D,MAAM,WAAW,GAAiB,oCAAoC,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAEpG,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;IAE/B,MAAM,cAAc,GAA2B,EAAE,CAAC;IACjD,KAAgC,CAAC,cAAc,GAAG,cAAc,CAAC;IAElE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;IACrD,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;QACvB,UAAU,CAAC,OAAO,GAAG,EAAE,CAAC;KACzB;IAED,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC5B,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,qBAAqB,CAC1E,IAAI,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,EAC5C,WAAW,CAAC,oBAAoB,EAChC,MAAM,EACN,OAAO,CAAC,6BAA6B,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAC1E,CAAC;QAEF,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE;YAChC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACpB;QAED,MAAM,IAAI,GAAsB;YAC9B,KAAK;YACL,eAAe,EAAE,YAAY;YAC7B,mFAAmF;YACnF,MAAM;SACP,CAAC;QAEF,MAAM,QAAQ,GAAW,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;QAE1E,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;QAEtC,MAAM,IAAI,GAAc;YACtB,GAAG,UAAU;YACb,MAAM;SACP,CAAC;QAEF,MAAM,OAAO,GAAyB,IAAI,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAC7E,cAAc,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;QAElC,IAAI,UAAU,KAAK,QAAQ,EAAE;YAC3B,wDAAwD;YACxD,WAAW,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;SAClD;aAAM;YACL,iDAAiD;YACjD,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;SAChD;KACF;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,WAAW,CAAC,MAAM,CAAC,IAAI,CACrB,IAAI,YAAY,CAAC,kBAAkB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CACrF,CAAC;KACH;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAnED,sDAmEC;AAED,SAAgB,wBAAwB,CAAC,OAAyC;IAChF,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEjD,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC;IAE/D,MAAM,SAAS,GAAyB,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/E,MAAM,WAAW,GAAW,SAAS,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC;IAE1D,MAAM,WAAW,GAAiB,oCAAoC,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAEpG,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;IACnC,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC;IAE/B,MAAM,MAAM,GAAW,OAAO,CAAC,mBAAmB,CAAC;IACnD,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,wBAAwB,CAC/D,IAAI,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,EAC5C,WAAW,CAAC,oBAAoB,EAChC,MAAM,CACP,CAAC;IAEF,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE;QAChC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACpB;IAED,MAAM,IAAI,GAAc;QACtB,GAAG,UAAU;QACb,MAAM;KACP,CAAC;IAEF,MAAM,OAAO,GAAyB,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACvE,WAAW,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAEjD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAC7B,IAAI,YAAY,CAAC,kBAAkB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CACrF,CAAC;KACH;AACH,CAAC;AArCD,4DAqCC;AAED,MAAM,UAAU,GAAwB,IAAI,GAAG,CAAC;IAC9C,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,GAAG,EAAE,OAAO,CAAC;IACd,CAAC,GAAG,EAAE,OAAO,CAAC;CACf,CAAC,CAAC;AAEH,MAAM,eAAe,GAAW,KAAK,CAAC;AACtC,MAAM,YAAY,GAAW,aAAa,CAAC;AAE3C,SAAS,qBAAqB,CAC5B,MAA6B,EAC7B,oBAA8C,EAC9C,MAAc,EACd,cAAkC;IAElC,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,KAAK,MAAM,OAAO,IAAI,oBAAoB,EAAE;QAC1C,QAAQ,OAAO,CAAC,IAAI,EAAE;YACpB,KAAK,WAAW,CAAC,CAAC;gBAChB,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;gBACzB,IAAI,QAAQ,GAAuB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACnE,IAAI,QAAQ,KAAK,SAAS,EAAE;oBAC1B,IAAI,cAAc,EAAE;wBAClB,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,cAAc,CAAE,CAAC;qBACrD;yBAAM;wBACL,MAAM,CAAC,IAAI,CACT,eAAe,IAAI,CAAC,UAAU,SAAS,IAAI,CAAC,WAAW,kBAAkB;4BACvE,cAAc,MAAM,EAAE,CACzB,CAAC;wBAEF,QAAQ,GAAG,sBAAsB,CAAC;qBACnC;iBACF;gBAED,MAAM,gBAAgB,GAAW,OAAO,CAAC,gBAAgB,IAAI,IAAI,CAAC;gBAElE,0DAA0D;gBAC1D,eAAe,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;gBAC/B,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;gBAE/D,wEAAwE;gBACxE,MAAM,yBAAyB,GAAW,gBAAgB,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAE9F,yFAAyF;gBACzF,YAAY,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;gBAC5B,QAAQ,GAAG,QAAQ,CAAC,OAAO,CACzB,YAAY,EACZ,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,yBAAyB,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAClE,CAAC;gBAEF,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACzD,MAAM;aACP;YAED,KAAK,SAAS,CAAC,CAAC;gBACd,MAAM,QAAQ,GAAW,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACjD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACzD,MAAM;aACP;SACF;KACF;IAED,OAAO;QACL,MAAM;QACN,MAAM;KACP,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAC/B,MAA6B,EAC7B,oBAA8C,EAC9C,mBAA2B;IAE3B,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,KAAK,MAAM,OAAO,IAAI,oBAAoB,EAAE;QAC1C,QAAQ,OAAO,CAAC,IAAI,EAAE;YACpB,KAAK,WAAW,CAAC,CAAC;gBAChB,MAAM,CAAC,IAAI,CACT,eAAe,OAAO,CAAC,IAAI,CAAC,UAAU,SAAS,OAAO,CAAC,IAAI,CAAC,WAAW,yBAAyB;oBAC9F,sDAAsD,CACzD,CAAC;gBAEF,MAAM,QAAQ,GAAW,oCAAoC,CAAC;gBAC9D,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACzD,MAAM;aACP;YAED,KAAK,SAAS,CAAC,CAAC;gBACd,MAAM,QAAQ,GAAW,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;gBAC9D,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACzD,MAAM;aACP;SACF;KACF;IAED,OAAO;QACL,MAAM;QACN,MAAM;KACP,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,MAAc;IACrC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAc;IACtC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAED,SAAS,oCAAoC,CAAC,MAA0B,EAAE,MAAc;IACtF,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,oBAAoB,GAA6B,EAAE,CAAC;IAE1D,IAAI,WAAmC,CAAC;IACxC,yBAAiB,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;IACjC,OAAO,CAAC,WAAW,GAAG,yBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE;QACrD,MAAM,CAAC,WAAW,EAAE,gBAAgB,EAAE,YAAY,EAAE,uBAAuB,CAAC,GAAG,WAAW,CAAC;QAC3F,MAAM,KAAK,GAAW,WAAW,CAAC,KAAK,CAAC;QACxC,MAAM,GAAG,GAAW,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC;QAE/C,IAAI,8BAAsD,CAAC;QAC3D,QAAQ,YAAY,EAAE;YACpB,KAAK,SAAS,CAAC,wBAAwB,CAAC,CAAC;gBACvC,MAAM,UAAU,GACd,MAAM,CAAC,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;gBACzD,IAAI,CAAC,UAAU,EAAE;oBACf,MAAM,CAAC,IAAI,CAAC,uBAAuB,WAAW,EAAE,CAAC,CAAC;oBAClD,SAAS;iBACV;qBAAM;oBACL,MAAM,gBAAgB,GAAoC;wBACxD,IAAI,EAAE,WAAW;wBACjB,KAAK;wBACL,GAAG;wBACH,gBAAgB;wBAChB,IAAI,EAAE,UAAU;qBACjB,CAAC;oBACF,8BAA8B,GAAG,gBAAgB,CAAC;iBACnD;gBACD,MAAM;aACP;YAED,KAAK,SAAS,CAAC,6BAA6B,CAAC,CAAC;gBAC5C,MAAM,cAAc,GAAkC;oBACpD,IAAI,EAAE,SAAS;oBACf,KAAK;oBACL,GAAG;oBACH,gBAAgB;oBAChB,OAAO,EAAE,eAAe;iBACzB,CAAC;gBACF,8BAA8B,GAAG,cAAc,CAAC;gBAChD,MAAM;aACP;YAED,KAAK,SAAS,CAAC,uBAAuB,CAAC,CAAC;gBACtC,MAAM,cAAc,GAAkC;oBACpD,IAAI,EAAE,SAAS;oBACf,KAAK;oBACL,GAAG;oBACH,gBAAgB;oBAChB,OAAO,EAAE,gBAAgB;iBAC1B,CAAC;gBACF,8BAA8B,GAAG,cAAc,CAAC;gBAChD,MAAM;aACP;YAED,OAAO,CAAC,CAAC;gBACP,MAAM,IAAI,KAAK,CAAC,oBAAoB,YAAY,EAAE,CAAC,CAAC;aACrD;SACF;QAED,oBAAoB,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;KAC3D;IAED,OAAO;QACL,MAAM;QACN,oBAAoB;KACrB,CAAC;AACJ,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 type { Asset, AssetInfo, Chunk, Compilation, sources } from 'webpack';\n\nimport * as Constants from './utilities/Constants';\nimport type { LocalizationPlugin, IStringPlaceholder } from './LocalizationPlugin';\nimport type { ILocalizedWebpackChunk, IAssetPathOptions } from './webpackInterfaces';\n\ninterface ILocalizedReconstructionElement {\n  kind: 'localized';\n  start: number;\n  end: number;\n  escapedBackslash: string;\n  data: IStringPlaceholder;\n}\n\ninterface IDynamicReconstructionElement {\n  kind: 'dynamic';\n  start: number;\n  end: number;\n  escapedBackslash: string;\n  valueFn: (locale: string) => string;\n}\n\ntype IReconstructionElement = ILocalizedReconstructionElement | IDynamicReconstructionElement;\n\ninterface IParseResult {\n  issues: string[];\n  reconstructionSeries: IReconstructionElement[];\n}\n\ninterface ILocalizedReconstructionResult {\n  result: sources.ReplaceSource;\n  issues: string[];\n}\n\ninterface INonLocalizedReconstructionResult {\n  result: sources.ReplaceSource;\n  issues: string[];\n}\n\nexport interface IProcessAssetOptionsBase {\n  plugin: LocalizationPlugin;\n  compilation: Compilation;\n  chunk: Chunk;\n  asset: Asset;\n}\n\nexport interface IProcessNonLocalizedAssetOptions extends IProcessAssetOptionsBase {\n  fileName: string;\n  noStringsLocaleName: string;\n}\n\nexport interface IProcessLocalizedAssetOptions extends IProcessAssetOptionsBase {\n  locales: Set<string>;\n  fillMissingTranslationStrings: boolean;\n  defaultLocale: string;\n  filenameTemplate: Parameters<typeof Compilation.prototype.getAssetPath>[0];\n}\n\nexport interface IProcessAssetResult {\n  filename: string;\n  asset: sources.Source;\n}\n\nexport const PLACEHOLDER_REGEX: RegExp = new RegExp(\n  `${Constants.STRING_PLACEHOLDER_PREFIX}_(\\\\\\\\*)_([A-C])_([0-9a-f]+)`,\n  'g'\n);\n\nexport function processLocalizedAsset(options: IProcessLocalizedAssetOptions): Record<string, string> {\n  const { compilation, asset, chunk, filenameTemplate, locales } = options;\n\n  const { sources, WebpackError } = compilation.compiler.webpack;\n\n  const rawSource: sources.CachedSource = new sources.CachedSource(asset.source);\n  const assetSource: string = rawSource.source().toString();\n\n  const parsedAsset: IParseResult = _parseStringToReconstructionSequence(options.plugin, assetSource);\n\n  const { issues } = parsedAsset;\n\n  const localizedFiles: Record<string, string> = {};\n  (chunk as ILocalizedWebpackChunk).localizedFiles = localizedFiles;\n\n  const { info: originInfo, name: originName } = asset;\n  if (!originInfo.related) {\n    originInfo.related = {};\n  }\n\n  for (const locale of locales) {\n    const { issues: localeIssues, result: localeResult } = _reconstructLocalized(\n      new sources.ReplaceSource(rawSource, locale),\n      parsedAsset.reconstructionSeries,\n      locale,\n      options.fillMissingTranslationStrings ? options.defaultLocale : undefined\n    );\n\n    for (const issue of localeIssues) {\n      issues.push(issue);\n    }\n\n    const data: IAssetPathOptions = {\n      chunk,\n      contentHashType: 'javascript',\n      // The locale property will get processed by the extension to the getAssetPath hook\n      locale\n    };\n\n    const fileName: string = compilation.getAssetPath(filenameTemplate, data);\n\n    originInfo.related[locale] = fileName;\n\n    const info: AssetInfo = {\n      ...originInfo,\n      locale\n    };\n\n    const wrapped: sources.CachedSource = new sources.CachedSource(localeResult);\n    localizedFiles[locale] = fileName;\n\n    if (originName === fileName) {\n      // This helper throws if the asset doesn't already exist\n      compilation.updateAsset(fileName, wrapped, info);\n    } else {\n      // This helper throws if the asset already exists\n      compilation.emitAsset(fileName, wrapped, info);\n    }\n  }\n\n  if (issues.length > 0) {\n    compilation.errors.push(\n      new WebpackError(`localization:\\n${issues.map((issue) => `  ${issue}`).join('\\n')}`)\n    );\n  }\n\n  return localizedFiles;\n}\n\nexport function processNonLocalizedAsset(options: IProcessNonLocalizedAssetOptions): void {\n  const { asset, fileName, compilation } = options;\n\n  const { sources, WebpackError } = compilation.compiler.webpack;\n\n  const rawSource: sources.CachedSource = new sources.CachedSource(asset.source);\n  const assetSource: string = rawSource.source().toString();\n\n  const parsedAsset: IParseResult = _parseStringToReconstructionSequence(options.plugin, assetSource);\n\n  const { info: originInfo } = asset;\n  const { issues } = parsedAsset;\n\n  const locale: string = options.noStringsLocaleName;\n  const { issues: localeIssues, result } = _reconstructNonLocalized(\n    new sources.ReplaceSource(rawSource, locale),\n    parsedAsset.reconstructionSeries,\n    locale\n  );\n\n  for (const issue of localeIssues) {\n    issues.push(issue);\n  }\n\n  const info: AssetInfo = {\n    ...originInfo,\n    locale\n  };\n\n  const wrapped: sources.CachedSource = new sources.CachedSource(result);\n  compilation.updateAsset(fileName, wrapped, info);\n\n  if (issues.length > 0) {\n    options.compilation.errors.push(\n      new WebpackError(`localization:\\n${issues.map((issue) => `  ${issue}`).join('\\n')}`)\n    );\n  }\n}\n\nconst ESCAPE_MAP: Map<string, string> = new Map([\n  ['\\r', 'r'],\n  ['\\n', 'n'],\n  ['\\t', 't'],\n  ['\"', 'u0022'],\n  [\"'\", 'u0027']\n]);\n\nconst BACKSLASH_REGEX: RegExp = /\\\\/g;\nconst ESCAPE_REGEX: RegExp = /[\\r\\n\\t\"']/g;\n\nfunction _reconstructLocalized(\n  result: sources.ReplaceSource,\n  reconstructionSeries: IReconstructionElement[],\n  locale: string,\n  fallbackLocale: string | undefined\n): ILocalizedReconstructionResult {\n  const issues: string[] = [];\n\n  for (const element of reconstructionSeries) {\n    switch (element.kind) {\n      case 'localized': {\n        const { data } = element;\n        let newValue: string | undefined = data.valuesByLocale.get(locale);\n        if (newValue === undefined) {\n          if (fallbackLocale) {\n            newValue = data.valuesByLocale.get(fallbackLocale)!;\n          } else {\n            issues.push(\n              `The string \"${data.stringName}\" in \"${data.locFilePath}\" is missing in ` +\n                `the locale ${locale}`\n            );\n\n            newValue = '-- MISSING STRING --';\n          }\n        }\n\n        const escapedBackslash: string = element.escapedBackslash || '\\\\';\n\n        // Replace backslashes with the properly escaped backslash\n        BACKSLASH_REGEX.lastIndex = -1;\n        newValue = newValue.replace(BACKSLASH_REGEX, escapedBackslash);\n\n        // @todo: look into using JSON.parse(...) to get the escaping characters\n        const escapingCharacterSequence: string = escapedBackslash.slice(escapedBackslash.length / 2);\n\n        // Ensure the the quotemark, apostrophe, tab, and newline characters are properly escaped\n        ESCAPE_REGEX.lastIndex = -1;\n        newValue = newValue.replace(\n          ESCAPE_REGEX,\n          (match) => `${escapingCharacterSequence}${ESCAPE_MAP.get(match)}`\n        );\n\n        result.replace(element.start, element.end - 1, newValue);\n        break;\n      }\n\n      case 'dynamic': {\n        const newValue: string = element.valueFn(locale);\n        result.replace(element.start, element.end - 1, newValue);\n        break;\n      }\n    }\n  }\n\n  return {\n    issues,\n    result\n  };\n}\n\nfunction _reconstructNonLocalized(\n  result: sources.ReplaceSource,\n  reconstructionSeries: IReconstructionElement[],\n  noStringsLocaleName: string\n): INonLocalizedReconstructionResult {\n  const issues: string[] = [];\n\n  for (const element of reconstructionSeries) {\n    switch (element.kind) {\n      case 'localized': {\n        issues.push(\n          `The string \"${element.data.stringName}\" in \"${element.data.locFilePath}\" appeared in an asset ` +\n            'that is not expected to contain localized resources.'\n        );\n\n        const newValue: string = '-- NOT EXPECTED TO BE LOCALIZED --';\n        result.replace(element.start, element.end - 1, newValue);\n        break;\n      }\n\n      case 'dynamic': {\n        const newValue: string = element.valueFn(noStringsLocaleName);\n        result.replace(element.start, element.end - 1, newValue);\n        break;\n      }\n    }\n  }\n\n  return {\n    issues,\n    result\n  };\n}\n\nfunction _rawLocaleToken(locale: string): string {\n  return locale;\n}\n\nfunction _jsonLocaleToken(locale: string): string {\n  return JSON.stringify(locale);\n}\n\nfunction _parseStringToReconstructionSequence(plugin: LocalizationPlugin, source: string): IParseResult {\n  const issues: string[] = [];\n  const reconstructionSeries: IReconstructionElement[] = [];\n\n  let regexResult: RegExpExecArray | null;\n  PLACEHOLDER_REGEX.lastIndex = -1;\n  while ((regexResult = PLACEHOLDER_REGEX.exec(source))) {\n    const [placeholder, escapedBackslash, elementLabel, placeholderSerialNumber] = regexResult;\n    const start: number = regexResult.index;\n    const end: number = start + placeholder.length;\n\n    let localizedReconstructionElement: IReconstructionElement;\n    switch (elementLabel) {\n      case Constants.STRING_PLACEHOLDER_LABEL: {\n        const stringData: IStringPlaceholder | undefined =\n          plugin.getDataForSerialNumber(placeholderSerialNumber);\n        if (!stringData) {\n          issues.push(`Missing placeholder ${placeholder}`);\n          continue;\n        } else {\n          const localizedElement: ILocalizedReconstructionElement = {\n            kind: 'localized',\n            start,\n            end,\n            escapedBackslash,\n            data: stringData\n          };\n          localizedReconstructionElement = localizedElement;\n        }\n        break;\n      }\n\n      case Constants.LOCALE_NAME_PLACEHOLDER_LABEL: {\n        const dynamicElement: IDynamicReconstructionElement = {\n          kind: 'dynamic',\n          start,\n          end,\n          escapedBackslash,\n          valueFn: _rawLocaleToken\n        };\n        localizedReconstructionElement = dynamicElement;\n        break;\n      }\n\n      case Constants.JSONP_PLACEHOLDER_LABEL: {\n        const dynamicElement: IDynamicReconstructionElement = {\n          kind: 'dynamic',\n          start,\n          end,\n          escapedBackslash,\n          valueFn: _jsonLocaleToken\n        };\n        localizedReconstructionElement = dynamicElement;\n        break;\n      }\n\n      default: {\n        throw new Error(`Unexpected label ${elementLabel}`);\n      }\n    }\n\n    reconstructionSeries.push(localizedReconstructionElement);\n  }\n\n  return {\n    issues,\n    reconstructionSeries\n  };\n}\n"]}

package/lib/LocalizationPlugin.d.ts

@@ -0,0 +1,79 @@
+import type { Compiler, LoaderContext, WebpackPluginInstance } from 'webpack';
+import { ILocalizationFile } from '@rushstack/localization-utilities';
+import type { ILocalizationPluginOptions } from './interfaces';
+/**
+ * @public
+ */
+export interface IStringPlaceholder {
+    /**
+     * The literal string that will be injected for later replacement.
+     */
+    value: string;
+    /**
+     * The identifier for this particular placeholder, for lookup.
+     */
+    suffix: string;
+    /**
+     * The values of this string in each output locale.
+     */
+    valuesByLocale: Map<string, string>;
+    /**
+     * The key used to identify the source file containing the string.
+     */
+    locFilePath: string;
+    /**
+     * The identifier of the string within its original source file.
+     */
+    stringName: string;
+}
+/**
+ * Gets the instance of the LocalizationPlugin bound to the specified webpack compiler.
+ * Used by loaders.
+ */
+export declare function getPluginInstance(compiler: Compiler | undefined): LocalizationPlugin;
+/**
+ * This plugin facilitates localization in webpack.
+ *
+ * @public
+ */
+export declare class LocalizationPlugin implements WebpackPluginInstance {
+    private readonly _stringKeys;
+    private readonly _options;
+    private readonly _resolvedTranslatedStringsFromOptions;
+    private _stringPlaceholderCounter;
+    private readonly _stringPlaceholderMap;
+    private _passthroughLocaleName;
+    private _defaultLocale;
+    private _noStringsLocaleName;
+    private _fillMissingTranslationStrings;
+    private readonly _pseudolocalizers;
+    /**
+     * The outermost map's keys are the locale names.
+     * The middle map's keys are the resolved, file names.
+     * The innermost map's keys are the string identifiers and its values are the string values.
+     */
+    private _resolvedLocalizedStrings;
+    constructor(options: ILocalizationPluginOptions);
+    /**
+     * Apply this plugin to the specified webpack compiler.
+     */
+    apply(compiler: Compiler): void;
+    /**
+     * @public
+     *
+     * @returns An object mapping the string keys to placeholders
+     */
+    addDefaultLocFileAsync(context: LoaderContext<{}>, localizedFileKey: string, localizedResourceData: ILocalizationFile): Promise<Record<string, string>>;
+    /**
+     * @public
+     */
+    getPlaceholder(localizedFileKey: string, stringName: string): IStringPlaceholder | undefined;
+    /**
+     * @internal
+     */
+    getDataForSerialNumber(serialNumber: string): IStringPlaceholder | undefined;
+    private _addLocFileAndGetPlaceholders;
+    private _addTranslations;
+    private _initializeAndValidateOptions;
+}
+//# sourceMappingURL=LocalizationPlugin.d.ts.map

package/lib/LocalizationPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalizationPlugin.d.ts","sourceRoot":"","sources":["../src/LocalizationPlugin.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAKV,QAAQ,EACR,aAAa,EAIb,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAsB,iBAAiB,EAAgB,MAAM,mCAAmC,CAAC;AAGxG,OAAO,KAAK,EACV,0BAA0B,EAK3B,MAAM,cAAc,CAAC;AAKtB;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAMD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,kBAAkB,CAMpF;AAED;;;;GAIG;AACH,qBAAa,kBAAmB,YAAW,qBAAqB;IAC9D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA8C;IAE1E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IACtD,OAAO,CAAC,QAAQ,CAAC,qCAAqC,CAGxC;IACd,OAAO,CAAC,yBAAyB,CAAa;IAC9C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA8C;IACpF,OAAO,CAAC,sBAAsB,CAAU;IACxC,OAAO,CAAC,cAAc,CAAU;IAChC,OAAO,CAAC,oBAAoB,CAAU;IACtC,OAAO,CAAC,8BAA8B,CAAW;IACjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmD;IAErF;;;;OAIG;IACH,OAAO,CAAC,yBAAyB,CAA4D;gBAE1E,OAAO,EAAE,0BAA0B;IAItD;;OAEG;IACI,KAAK,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IA8QtC;;;;OAIG;IACU,sBAAsB,CACjC,OAAO,EAAE,aAAa,CAAC,EAAE,CAAC,EAC1B,gBAAgB,EAAE,MAAM,EACxB,qBAAqB,EAAE,iBAAiB,GACvC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAsElC;;OAEG;IACI,cAAc,CAAC,gBAAgB,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;IAKnG;;OAEG;IACI,sBAAsB,CAAC,YAAY,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;IAInF,OAAO,CAAC,6BAA6B;IA0CrC,OAAO,CAAC,gBAAgB;IAcxB,OAAO,CAAC,6BAA6B;CA4KtC"}