pxt-core 11.3.6 → 11.3.7

package/built/cli.d.ts

@@ -44,6 +44,11 @@ export declare function staticpkgAsync(parsed: commandParser.ParsedCommand): Pro
 export declare function cleanAsync(parsed?: commandParser.ParsedCommand): Promise<void>;
 export declare function cleanGenAsync(parsed: commandParser.ParsedCommand): Promise<void>;
 export declare function npmInstallNativeAsync(): Promise<void>;
+/**
+ * Checks for syntax errors in a translated block strings file by comparing against a baseline.
+ * Optionally prints the results to console or sends to a file, if an output file is specified.
+ */
+export declare function validateTranslatedBlocks(parsed?: commandParser.ParsedCommand): Promise<void>;
 export declare function buildJResSpritesAsync(parsed: commandParser.ParsedCommand): Promise<void>;
 export declare function buildJResAsync(parsed: commandParser.ParsedCommand): Promise<void>;
 export declare function buildAsync(parsed: commandParser.ParsedCommand): Promise<void>;

package/built/cli.js

@@ -1,7 +1,7 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-for-in-array */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mainCli = exports.getCodeSnippets = exports.getSnippets = exports.hex2uf2Async = exports.hexdumpAsync = exports.extractAsync = exports.testAsync = exports.runAsync = exports.deployAsync = exports.consoleAsync = exports.gendocsAsync = exports.buildShareSimJsAsync = exports.buildAsync = exports.buildJResAsync = exports.buildJResSpritesAsync = exports.npmInstallNativeAsync = exports.cleanGenAsync = exports.cleanAsync = exports.staticpkgAsync = exports.formatAsync = exports.downloadDiscourseTagAsync = exports.validateAndFixPkgConfig = exports.downloadPlaylistsAsync = exports.exportCppAsync = exports.timeAsync = exports.augmnetDocsAsync = exports.serviceAsync = exports.initAsync = exports.addAsync = exports.installAsync = exports.serveAsync = exports.internalBuildTargetAsync = exports.buildTargetAsync = exports.ghpPushAsync = exports.uploadTargetRefsAsync = exports.uploadTargetReleaseAsync = exports.yesNoAsync = exports.queryAsync = exports.apiAsync = exports.pokeRepoAsync = exports.globalConfig = void 0;
+exports.mainCli = exports.getCodeSnippets = exports.getSnippets = exports.hex2uf2Async = exports.hexdumpAsync = exports.extractAsync = exports.testAsync = exports.runAsync = exports.deployAsync = exports.consoleAsync = exports.gendocsAsync = exports.buildShareSimJsAsync = exports.buildAsync = exports.buildJResAsync = exports.buildJResSpritesAsync = exports.validateTranslatedBlocks = exports.npmInstallNativeAsync = exports.cleanGenAsync = exports.cleanAsync = exports.staticpkgAsync = exports.formatAsync = exports.downloadDiscourseTagAsync = exports.validateAndFixPkgConfig = exports.downloadPlaylistsAsync = exports.exportCppAsync = exports.timeAsync = exports.augmnetDocsAsync = exports.serviceAsync = exports.initAsync = exports.addAsync = exports.installAsync = exports.serveAsync = exports.internalBuildTargetAsync = exports.buildTargetAsync = exports.ghpPushAsync = exports.uploadTargetRefsAsync = exports.uploadTargetReleaseAsync = exports.yesNoAsync = exports.queryAsync = exports.apiAsync = exports.pokeRepoAsync = exports.globalConfig = void 0;
 /// <reference path="../built/pxtlib.d.ts"/>
 /// <reference path="../built/pxtcompiler.d.ts"/>
 /// <reference path="../built/pxtpy.d.ts"/>
@@ -4509,6 +4509,143 @@ function npmInstallNativeAsync() {
     return nextAsync();
 }
 exports.npmInstallNativeAsync = npmInstallNativeAsync;
+/**
+ * Checks for syntax errors in a single block string by comparing against a baseline string for the same block.
+ */
+function validateBlockString(original, toValidate) {
+    var _a, _b, _c;
+    function getResponse(result, message) {
+        return {
+            result,
+            message,
+            original,
+            validate: toValidate
+        };
+    }
+    // Check for empty strings. Both empty is fine. One empty and not the other, fail.
+    if (!original && !toValidate) {
+        return getResponse(true, "Empty strings");
+    }
+    else if (!original || !toValidate) {
+        return getResponse(false, "Mis-match empty and non-empty strings.");
+    }
+    // Split block strings by the optional parameter separator "||" and parse each section separately.
+    const originalParts = original.split("||");
+    const toValidateParts = toValidate.split("||");
+    if (originalParts.length !== toValidateParts.length) {
+        return getResponse(false, "Block string has non-matching number of segments.");
+    }
+    for (let i = 0; i < originalParts.length; i++) {
+        const originalParsed = pxtc.parseBlockDefinition(originalParts[i]);
+        const toValidateParsed = pxtc.parseBlockDefinition(toValidateParts[i]);
+        // Check if parameter count changed
+        if (((_a = originalParsed.parameters) === null || _a === void 0 ? void 0 : _a.length) != ((_b = toValidateParsed.parameters) === null || _b === void 0 ? void 0 : _b.length)) {
+            return getResponse(false, "Block string has non-matching number of parameters.");
+        }
+        // Check if anything has been translated when it should not have been.
+        for (let p = 0; p < ((_c = toValidateParsed.parameters) === null || _c === void 0 ? void 0 : _c.length); p++) {
+            // For ref ($) params, order does not matter. For non-ref (%) params, it does.
+            const toValidateParam = toValidateParsed.parameters[p];
+            let matchParam;
+            if (toValidateParam.ref) {
+                matchParam = originalParsed.parameters.find(op => op.ref && op.name === toValidateParam.name);
+                if (!matchParam) {
+                    return getResponse(false, "Block string has non-matching parameters.");
+                }
+            }
+            else {
+                matchParam = originalParsed.parameters[p];
+                if (matchParam.ref || toValidateParam.name !== matchParam.name) {
+                    return getResponse(false, "Block string has non-matching ordered parameters.");
+                }
+            }
+            if (toValidateParam.shadowBlockId !== matchParam.shadowBlockId) {
+                return getResponse(false, "Block string has non-matching shadow block IDs.");
+            }
+        }
+    }
+    // Passed all checks
+    return getResponse(true);
+}
+/**
+ * Checks for syntax errors in a translated block strings file by comparing against a baseline.
+ * Optionally prints the results to console or sends to a file, if an output file is specified.
+ */
+function validateTranslatedBlocks(parsed) {
+    const originalFilePath = parsed.args[0];
+    const translatedFilePath = parsed.args[1];
+    const outputFilePath = parsed.args[2]; // Optional
+    if (!originalFilePath || !translatedFilePath) {
+        U.userError("Missing required arguments: originalFilePath, translatedFilePath");
+    }
+    if (!fs.existsSync(originalFilePath)) {
+        U.userError(`File ${originalFilePath} not found`);
+    }
+    if (!fs.existsSync(translatedFilePath)) {
+        U.userError(`File ${translatedFilePath} not found`);
+    }
+    /**
+     * Takes a key string from a translations file and returns the type of content it refers to (a block, a category, etc...)
+     * Matches pxtc.gendocs key construction
+     */
+    function getKeyType(key) {
+        if (key.startsWith("{id:category}"))
+            return "category";
+        if (key.startsWith("{id:subcategory}"))
+            return "subcategory";
+        if (key.startsWith("{id:group}"))
+            return "group";
+        if (key.endsWith("|block"))
+            return "block";
+        return "unknown";
+    }
+    const originalMap = JSON.parse(fs.readFileSync(originalFilePath, 'utf8'));
+    const translationMap = JSON.parse(fs.readFileSync(translatedFilePath, 'utf8'));
+    const translationKeys = Object.keys(translationMap);
+    const results = {};
+    for (const translationKey of translationKeys) {
+        if (!(translationKey in originalMap)) {
+            results[translationKey] = { result: false, message: `Original string not found for key: ${translationKey}` };
+            continue;
+        }
+        const keyType = getKeyType(translationKey);
+        const translationString = translationMap[translationKey];
+        const originalString = originalMap[translationKey];
+        switch (keyType) {
+            case "block": {
+                const validation = validateBlockString(originalString, translationString);
+                results[translationKey] = validation;
+                break;
+            }
+            case "category":
+            case "subcategory":
+            case "group":
+            case "unknown":
+            default: {
+                results[translationKey] = {
+                    result: true,
+                    message: `No validation performed for key type: ${keyType}`,
+                    original: originalString,
+                    validate: translationString
+                };
+            }
+        }
+    }
+    if (outputFilePath) {
+        // Create directories for output file, if needed.
+        const outputDir = path.dirname(outputFilePath);
+        if (!fs.existsSync(outputDir)) {
+            fs.mkdirSync(outputDir, { recursive: true });
+        }
+        fs.writeFileSync(outputFilePath, JSON.stringify(results, null, 2));
+        pxt.log(`Results written to ${outputFilePath}`);
+    }
+    else {
+        pxt.log(JSON.stringify(results, null, 2));
+    }
+    return Promise.resolve();
+}
+exports.validateTranslatedBlocks = validateTranslatedBlocks;
 function buildJResSpritesAsync(parsed) {
     ensurePkgDir();
     return loadPkgAsync()
@@ -6632,6 +6769,13 @@ ${pxt.crowdin.KEY_VARIABLE} - crowdin key
         help: "Validate and attempt to fix common pxt.json issues",
     }, validateAndFixPkgConfig);
     advancedCommand("buildshims", "Regenerate shims.d.ts, enums.d.ts", buildShimsAsync);
+    p.defineCommand({
+        name: "validatetranslatedblocks",
+        aliases: ["vtb"],
+        help: "Validate a file of translated block strings against a baseline",
+        advanced: true,
+        argString: "<original-file> <translated-file> <output-file>"
+    }, validateTranslatedBlocks);
     function simpleCmd(name, help, callback, argString, onlineHelp) {
         p.defineCommand({ name, help, onlineHelp, argString }, callback);
     }

package/built/pxt.d.ts

@@ -44,6 +44,11 @@ export declare function staticpkgAsync(parsed: commandParser.ParsedCommand): Pro
 export declare function cleanAsync(parsed?: commandParser.ParsedCommand): Promise<void>;
 export declare function cleanGenAsync(parsed: commandParser.ParsedCommand): Promise<void>;
 export declare function npmInstallNativeAsync(): Promise<void>;
+/**
+ * Checks for syntax errors in a translated block strings file by comparing against a baseline.
+ * Optionally prints the results to console or sends to a file, if an output file is specified.
+ */
+export declare function validateTranslatedBlocks(parsed?: commandParser.ParsedCommand): Promise<void>;
 export declare function buildJResSpritesAsync(parsed: commandParser.ParsedCommand): Promise<void>;
 export declare function buildJResAsync(parsed: commandParser.ParsedCommand): Promise<void>;
 export declare function buildAsync(parsed: commandParser.ParsedCommand): Promise<void>;

package/built/pxt.js

@@ -113979,7 +113979,7 @@ var pxt;
             files[this.id + "/" + pxt.CONFIG_NAME] = this.readFile(pxt.CONFIG_NAME);
         }
         /**
-         * Returns localized strings qName -> translation
+         * Returns localized strings qName (+ some additional identification data) -> translation
          */
         packageLocalizationStringsAsync(lang) {
             const targetId = pxt.appTarget.id;
@@ -161051,7 +161051,7 @@ var pxsim;
 "use strict";
 /* eslint-disable @typescript-eslint/no-for-in-array */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mainCli = exports.getCodeSnippets = exports.getSnippets = exports.hex2uf2Async = exports.hexdumpAsync = exports.extractAsync = exports.testAsync = exports.runAsync = exports.deployAsync = exports.consoleAsync = exports.gendocsAsync = exports.buildShareSimJsAsync = exports.buildAsync = exports.buildJResAsync = exports.buildJResSpritesAsync = exports.npmInstallNativeAsync = exports.cleanGenAsync = exports.cleanAsync = exports.staticpkgAsync = exports.formatAsync = exports.downloadDiscourseTagAsync = exports.validateAndFixPkgConfig = exports.downloadPlaylistsAsync = exports.exportCppAsync = exports.timeAsync = exports.augmnetDocsAsync = exports.serviceAsync = exports.initAsync = exports.addAsync = exports.installAsync = exports.serveAsync = exports.internalBuildTargetAsync = exports.buildTargetAsync = exports.ghpPushAsync = exports.uploadTargetRefsAsync = exports.uploadTargetReleaseAsync = exports.yesNoAsync = exports.queryAsync = exports.apiAsync = exports.pokeRepoAsync = exports.globalConfig = void 0;
+exports.mainCli = exports.getCodeSnippets = exports.getSnippets = exports.hex2uf2Async = exports.hexdumpAsync = exports.extractAsync = exports.testAsync = exports.runAsync = exports.deployAsync = exports.consoleAsync = exports.gendocsAsync = exports.buildShareSimJsAsync = exports.buildAsync = exports.buildJResAsync = exports.buildJResSpritesAsync = exports.validateTranslatedBlocks = exports.npmInstallNativeAsync = exports.cleanGenAsync = exports.cleanAsync = exports.staticpkgAsync = exports.formatAsync = exports.downloadDiscourseTagAsync = exports.validateAndFixPkgConfig = exports.downloadPlaylistsAsync = exports.exportCppAsync = exports.timeAsync = exports.augmnetDocsAsync = exports.serviceAsync = exports.initAsync = exports.addAsync = exports.installAsync = exports.serveAsync = exports.internalBuildTargetAsync = exports.buildTargetAsync = exports.ghpPushAsync = exports.uploadTargetRefsAsync = exports.uploadTargetReleaseAsync = exports.yesNoAsync = exports.queryAsync = exports.apiAsync = exports.pokeRepoAsync = exports.globalConfig = void 0;
 /// <reference path="../built/pxtlib.d.ts"/>
 /// <reference path="../built/pxtcompiler.d.ts"/>
 /// <reference path="../built/pxtpy.d.ts"/>
@@ -165559,6 +165559,143 @@ function npmInstallNativeAsync() {
     return nextAsync();
 }
 exports.npmInstallNativeAsync = npmInstallNativeAsync;
+/**
+ * Checks for syntax errors in a single block string by comparing against a baseline string for the same block.
+ */
+function validateBlockString(original, toValidate) {
+    var _a, _b, _c;
+    function getResponse(result, message) {
+        return {
+            result,
+            message,
+            original,
+            validate: toValidate
+        };
+    }
+    // Check for empty strings. Both empty is fine. One empty and not the other, fail.
+    if (!original && !toValidate) {
+        return getResponse(true, "Empty strings");
+    }
+    else if (!original || !toValidate) {
+        return getResponse(false, "Mis-match empty and non-empty strings.");
+    }
+    // Split block strings by the optional parameter separator "||" and parse each section separately.
+    const originalParts = original.split("||");
+    const toValidateParts = toValidate.split("||");
+    if (originalParts.length !== toValidateParts.length) {
+        return getResponse(false, "Block string has non-matching number of segments.");
+    }
+    for (let i = 0; i < originalParts.length; i++) {
+        const originalParsed = pxtc.parseBlockDefinition(originalParts[i]);
+        const toValidateParsed = pxtc.parseBlockDefinition(toValidateParts[i]);
+        // Check if parameter count changed
+        if (((_a = originalParsed.parameters) === null || _a === void 0 ? void 0 : _a.length) != ((_b = toValidateParsed.parameters) === null || _b === void 0 ? void 0 : _b.length)) {
+            return getResponse(false, "Block string has non-matching number of parameters.");
+        }
+        // Check if anything has been translated when it should not have been.
+        for (let p = 0; p < ((_c = toValidateParsed.parameters) === null || _c === void 0 ? void 0 : _c.length); p++) {
+            // For ref ($) params, order does not matter. For non-ref (%) params, it does.
+            const toValidateParam = toValidateParsed.parameters[p];
+            let matchParam;
+            if (toValidateParam.ref) {
+                matchParam = originalParsed.parameters.find(op => op.ref && op.name === toValidateParam.name);
+                if (!matchParam) {
+                    return getResponse(false, "Block string has non-matching parameters.");
+                }
+            }
+            else {
+                matchParam = originalParsed.parameters[p];
+                if (matchParam.ref || toValidateParam.name !== matchParam.name) {
+                    return getResponse(false, "Block string has non-matching ordered parameters.");
+                }
+            }
+            if (toValidateParam.shadowBlockId !== matchParam.shadowBlockId) {
+                return getResponse(false, "Block string has non-matching shadow block IDs.");
+            }
+        }
+    }
+    // Passed all checks
+    return getResponse(true);
+}
+/**
+ * Checks for syntax errors in a translated block strings file by comparing against a baseline.
+ * Optionally prints the results to console or sends to a file, if an output file is specified.
+ */
+function validateTranslatedBlocks(parsed) {
+    const originalFilePath = parsed.args[0];
+    const translatedFilePath = parsed.args[1];
+    const outputFilePath = parsed.args[2]; // Optional
+    if (!originalFilePath || !translatedFilePath) {
+        U.userError("Missing required arguments: originalFilePath, translatedFilePath");
+    }
+    if (!fs.existsSync(originalFilePath)) {
+        U.userError(`File ${originalFilePath} not found`);
+    }
+    if (!fs.existsSync(translatedFilePath)) {
+        U.userError(`File ${translatedFilePath} not found`);
+    }
+    /**
+     * Takes a key string from a translations file and returns the type of content it refers to (a block, a category, etc...)
+     * Matches pxtc.gendocs key construction
+     */
+    function getKeyType(key) {
+        if (key.startsWith("{id:category}"))
+            return "category";
+        if (key.startsWith("{id:subcategory}"))
+            return "subcategory";
+        if (key.startsWith("{id:group}"))
+            return "group";
+        if (key.endsWith("|block"))
+            return "block";
+        return "unknown";
+    }
+    const originalMap = JSON.parse(fs.readFileSync(originalFilePath, 'utf8'));
+    const translationMap = JSON.parse(fs.readFileSync(translatedFilePath, 'utf8'));
+    const translationKeys = Object.keys(translationMap);
+    const results = {};
+    for (const translationKey of translationKeys) {
+        if (!(translationKey in originalMap)) {
+            results[translationKey] = { result: false, message: `Original string not found for key: ${translationKey}` };
+            continue;
+        }
+        const keyType = getKeyType(translationKey);
+        const translationString = translationMap[translationKey];
+        const originalString = originalMap[translationKey];
+        switch (keyType) {
+            case "block": {
+                const validation = validateBlockString(originalString, translationString);
+                results[translationKey] = validation;
+                break;
+            }
+            case "category":
+            case "subcategory":
+            case "group":
+            case "unknown":
+            default: {
+                results[translationKey] = {
+                    result: true,
+                    message: `No validation performed for key type: ${keyType}`,
+                    original: originalString,
+                    validate: translationString
+                };
+            }
+        }
+    }
+    if (outputFilePath) {
+        // Create directories for output file, if needed.
+        const outputDir = path.dirname(outputFilePath);
+        if (!fs.existsSync(outputDir)) {
+            fs.mkdirSync(outputDir, { recursive: true });
+        }
+        fs.writeFileSync(outputFilePath, JSON.stringify(results, null, 2));
+        pxt.log(`Results written to ${outputFilePath}`);
+    }
+    else {
+        pxt.log(JSON.stringify(results, null, 2));
+    }
+    return Promise.resolve();
+}
+exports.validateTranslatedBlocks = validateTranslatedBlocks;
 function buildJResSpritesAsync(parsed) {
     ensurePkgDir();
     return loadPkgAsync()
@@ -167682,6 +167819,13 @@ ${pxt.crowdin.KEY_VARIABLE} - crowdin key
         help: "Validate and attempt to fix common pxt.json issues",
     }, validateAndFixPkgConfig);
     advancedCommand("buildshims", "Regenerate shims.d.ts, enums.d.ts", buildShimsAsync);
+    p.defineCommand({
+        name: "validatetranslatedblocks",
+        aliases: ["vtb"],
+        help: "Validate a file of translated block strings against a baseline",
+        advanced: true,
+        argString: "<original-file> <translated-file> <output-file>"
+    }, validateTranslatedBlocks);
     function simpleCmd(name, help, callback, argString, onlineHelp) {
         p.defineCommand({ name, help, onlineHelp, argString }, callback);
     }

package/built/pxtlib.d.ts

@@ -1973,7 +1973,7 @@ declare namespace pxt {
         getFiles(): string[];
         addSnapshot(files: Map<string>, exts?: string[]): void;
         /**
-         * Returns localized strings qName -> translation
+         * Returns localized strings qName (+ some additional identification data) -> translation
          */
         packageLocalizationStringsAsync(lang: string): Promise<Map<string>>;
         bundledStringsForFile(lang: string, filename: string): Map<string>;

package/built/pxtlib.js

@@ -16293,7 +16293,7 @@ var pxt;
             files[this.id + "/" + pxt.CONFIG_NAME] = this.readFile(pxt.CONFIG_NAME);
         }
         /**
-         * Returns localized strings qName -> translation
+         * Returns localized strings qName (+ some additional identification data) -> translation
          */
         packageLocalizationStringsAsync(lang) {
             const targetId = pxt.appTarget.id;