pxt-core 8.1.2 → 8.1.3

package/built/pxt.js

@@ -125963,6 +125963,101 @@ ${output}</xml>`;
                     }
                     return undefined;
                 }
+                /**
+                 * We split up comments according to the following rules:
+                 *      1. If the comment is not top-level:
+                 *          a. Combine it with all comments for the following statement
+                 *          b. If there is no following statement in the current block, group it with the previous statement
+                 *          c. If there are no statements inside the block, group it with the parent block
+                 *          d. If trailing the same line as the statement, group it with the comments for that statement
+                 *      2. If the comment is top-level:
+                 *          b. If the comment is followed by an empty line, it becomes a workspace comment
+                 *          c. If the comment is followed by a multi-line comment, it becomes a workspace comment
+                 *          a. If the comment is a single-line comment, combine it with the next single-line comment
+                 *          d. If the comment is not followed with an empty line, group it with the next statement or event
+                 *          e. All other comments are workspace comments
+                 *
+                 * The below function gathers any comments associated to the Node, and attaches them
+                 * to the StatementNode.
+                 */
+                function getNodeComments(commented, stmt) {
+                    let comments = [];
+                    let current;
+                    for (let i = 0; i < commentMap.length; i++) {
+                        current = commentMap[i];
+                        if (!current.owner && current.start >= commented.pos && current.end <= commented.end) {
+                            current.owner = commented;
+                            current.ownerStatement = stmt;
+                            comments.push(current);
+                        }
+                        if (current.start > commented.end)
+                            break;
+                    }
+                    if (current && current.isTrailingComment) {
+                        const endLine = ts.getLineAndCharacterOfPosition(file, commented.end);
+                        const commentLine = ts.getLineAndCharacterOfPosition(file, current.start);
+                        if (endLine.line === commentLine.line) {
+                            // If the comment is trailing and on the same line as the statement, it probably belongs
+                            // to this statement. Remove it from any statement it's already assigned to and any workspace
+                            // comments
+                            if (current.ownerStatement) {
+                                current.ownerStatement.comment.splice(current.ownerStatement.comment.indexOf(current), 1);
+                                for (const wsComment of workspaceComments) {
+                                    wsComment.comment.splice(wsComment.comment.indexOf(current), 1);
+                                }
+                            }
+                            current.owner = commented;
+                            current.ownerStatement = stmt;
+                            comments.push(current);
+                        }
+                    }
+                    if (comments.length) {
+                        const wsCommentRefs = [];
+                        if (isTopLevelComment(commented)) {
+                            let currentWorkspaceComment = [];
+                            const localWorkspaceComments = [];
+                            comments.forEach((comment, index) => {
+                                let beforeStatement = comment.owner && comment.start < comment.owner.getStart();
+                                if (comment.kind === CommentKind.MultiLine && beforeStatement) {
+                                    if (currentWorkspaceComment.length) {
+                                        localWorkspaceComments.push(currentWorkspaceComment);
+                                        currentWorkspaceComment = [];
+                                    }
+                                    if (index != comments.length - 1) {
+                                        localWorkspaceComments.push([comment]);
+                                        return;
+                                    }
+                                }
+                                currentWorkspaceComment.push(comment);
+                                if (comment.followedByEmptyLine && beforeStatement) {
+                                    localWorkspaceComments.push(currentWorkspaceComment);
+                                    currentWorkspaceComment = [];
+                                }
+                            });
+                            comments = currentWorkspaceComment;
+                            localWorkspaceComments.forEach(comment => {
+                                const refId = getCommentRef();
+                                wsCommentRefs.push(refId);
+                                workspaceComments.push({ comment, refId });
+                            });
+                        }
+                        // Attach comments to StatementNode
+                        if (stmt) {
+                            if (wsCommentRefs.length) {
+                                if (stmt.data)
+                                    stmt.data += ";" + wsCommentRefs.join(";");
+                                else
+                                    stmt.data = wsCommentRefs.join(";");
+                            }
+                            if (comments && comments.length) {
+                                if (stmt.comment)
+                                    stmt.comment = stmt.comment.concat(comments);
+                                else
+                                    stmt.comment = comments;
+                            }
+                        }
+                    }
+                }
                 function getStatementBlock(n, next, parent, asExpression = false, topLevel = false) {
                     const node = n;
                     let stmt;
@@ -126065,7 +126160,7 @@ ${output}</xml>`;
                         }
                     }
                     if (!skipComments) {
-                        getComments(parent || node);
+                        getNodeComments(parent || node, stmt);
                     }
                     return stmt;
                     function getNext() {
@@ -126074,97 +126169,6 @@ ${output}</xml>`;
                         }
                         return undefined;
                     }
-                    /**
-                     * We split up comments according to the following rules:
-                     *      1. If the comment is not top-level:
-                     *          a. Combine it with all comments for the following statement
-                     *          b. If there is no following statement in the current block, group it with the previous statement
-                     *          c. If there are no statements inside the block, group it with the parent block
-                     *          d. If trailing the same line as the statement, group it with the comments for that statement
-                     *      2. If the comment is top-level:
-                     *          b. If the comment is followed by an empty line, it becomes a workspace comment
-                     *          c. If the comment is followed by a multi-line comment, it becomes a workspace comment
-                     *          a. If the comment is a single-line comment, combine it with the next single-line comment
-                     *          d. If the comment is not followed with an empty line, group it with the next statement or event
-                     *          e. All other comments are workspace comments
-                     */
-                    function getComments(commented) {
-                        let comments = [];
-                        let current;
-                        for (let i = 0; i < commentMap.length; i++) {
-                            current = commentMap[i];
-                            if (!current.owner && current.start >= commented.pos && current.end <= commented.end) {
-                                current.owner = commented;
-                                current.ownerStatement = stmt;
-                                comments.push(current);
-                            }
-                            if (current.start > commented.end)
-                                break;
-                        }
-                        if (current && current.isTrailingComment) {
-                            const endLine = ts.getLineAndCharacterOfPosition(file, commented.end);
-                            const commentLine = ts.getLineAndCharacterOfPosition(file, current.start);
-                            if (endLine.line === commentLine.line) {
-                                // If the comment is trailing and on the same line as the statement, it probably belongs
-                                // to this statement. Remove it from any statement it's already assigned to and any workspace
-                                // comments
-                                if (current.ownerStatement) {
-                                    current.ownerStatement.comment.splice(current.ownerStatement.comment.indexOf(current), 1);
-                                    for (const wsComment of workspaceComments) {
-                                        wsComment.comment.splice(wsComment.comment.indexOf(current), 1);
-                                    }
-                                }
-                                current.owner = commented;
-                                current.ownerStatement = stmt;
-                                comments.push(current);
-                            }
-                        }
-                        if (comments.length) {
-                            const wsCommentRefs = [];
-                            if (isTopLevelComment(commented)) {
-                                let currentWorkspaceComment = [];
-                                const localWorkspaceComments = [];
-                                comments.forEach((comment, index) => {
-                                    let beforeStatement = comment.owner && comment.start < comment.owner.getStart();
-                                    if (comment.kind === CommentKind.MultiLine && beforeStatement) {
-                                        if (currentWorkspaceComment.length) {
-                                            localWorkspaceComments.push(currentWorkspaceComment);
-                                            currentWorkspaceComment = [];
-                                        }
-                                        if (index != comments.length - 1) {
-                                            localWorkspaceComments.push([comment]);
-                                            return;
-                                        }
-                                    }
-                                    currentWorkspaceComment.push(comment);
-                                    if (comment.followedByEmptyLine && beforeStatement) {
-                                        localWorkspaceComments.push(currentWorkspaceComment);
-                                        currentWorkspaceComment = [];
-                                    }
-                                });
-                                comments = currentWorkspaceComment;
-                                localWorkspaceComments.forEach(comment => {
-                                    const refId = getCommentRef();
-                                    wsCommentRefs.push(refId);
-                                    workspaceComments.push({ comment, refId });
-                                });
-                            }
-                            if (stmt) {
-                                if (wsCommentRefs.length) {
-                                    if (stmt.data)
-                                        stmt.data += ";" + wsCommentRefs.join(";");
-                                    else
-                                        stmt.data = wsCommentRefs.join(";");
-                                }
-                                if (comments && comments.length) {
-                                    if (stmt.comment)
-                                        stmt.comment = stmt.comment.concat(comments);
-                                    else
-                                        stmt.comment = comments;
-                                }
-                            }
-                        }
-                    }
                 }
                 function getTypeScriptStatementBlock(node, prefix, err) {
                     if (options.errorOnGreyBlocks)
@@ -126934,12 +126938,13 @@ ${output}</xml>`;
                     eventStatements.map(n => getStatementBlock(n, undefined, undefined, false, topLevel)).forEach(emitStatementNode);
                     if (blockStatements.length) {
                         // wrap statement in "on start" if top level
-                        const stmtNode = blockStatements.shift();
-                        const stmt = getStatementBlock(stmtNode, blockStatements, parent, false, topLevel);
+                        const blockNode = blockStatements.shift();
+                        const stmt = getStatementBlock(blockNode, blockStatements, parent, false, topLevel);
                         if (emitOnStart) {
                             // Preserve any variable edeclarations that were never used
-                            let current = stmt;
-                            let currentNode = stmtNode;
+                            // stmt and blockNode will not yet align if there was an auto-declared variable.
+                            let currentStmtNode = stmt;
+                            let currentBlockNode = blockNode;
                             autoDeclarations.forEach(([name, node]) => {
                                 if (varUsages[name] === ReferenceType.InBlocksOnly) {
                                     return;
@@ -126953,17 +126958,21 @@ ${output}</xml>`;
                                     v = getTypeScriptStatementBlock(node, "let ");
                                 }
                                 else {
-                                    v = getVariableSetOrChangeBlock(stmtNode, node.name, node.initializer, false, true);
+                                    v = getVariableSetOrChangeBlock(blockNode, node.name, node.initializer, false, true);
                                 }
-                                v.next = current;
-                                current = v;
-                                currentNode = node;
+                                // Auto-declared variables were not previously inserted into the stmt linked-list.
+                                // Insert auto-declared 'v' as the currentStmtNode.
+                                v.next = currentStmtNode;
+                                currentStmtNode = v;
+                                currentBlockNode = node;
+                                // Attach to currentStmtNode any associated comments
+                                getNodeComments(currentBlockNode.parent, currentStmtNode);
                             });
-                            if (current) {
-                                const r = mkStmt(ts.pxtc.ON_START_TYPE, currentNode);
+                            if (currentStmtNode) {
+                                const r = mkStmt(ts.pxtc.ON_START_TYPE, currentBlockNode);
                                 r.handlers = [{
                                         name: "HANDLER",
-                                        statement: current
+                                        statement: currentStmtNode
                                     }];
                                 return r;
                             }
@@ -153180,6 +153189,7 @@ var pxsim;
             }
         }
         createFrame(url) {
+            var _a;
             const wrapper = document.createElement("div");
             wrapper.className = `simframe ui embed`;
             const frame = document.createElement('iframe');
@@ -153194,7 +153204,7 @@ var pxsim;
             frame.frameBorder = "0";
             frame.dataset['runid'] = this.runId;
             frame.dataset['origin'] = new URL(furl).origin || "*";
-            if (this._runOptions.autofocus)
+            if ((_a = this._runOptions) === null || _a === void 0 ? void 0 : _a.autofocus)
                 frame.setAttribute("autofocus", "true");
             wrapper.appendChild(frame);
             const i = document.createElement("i");
@@ -157722,11 +157732,11 @@ function onlyExts(files, exts) {
 }
 function pxtFileList(pref) {
     return nodeutil.allFiles(pref + "webapp/public")
-        .concat(onlyExts(nodeutil.allFiles(pref + "built/web", 1), [".js", ".css"]))
-        .concat(nodeutil.allFiles(pref + "built/web/fonts", 1))
-        .concat(nodeutil.allFiles(pref + "built/web/vs", 4))
-        .concat(nodeutil.allFiles(pref + "built/web/skillmap", 4))
-        .concat(nodeutil.allFiles(pref + "built/web/authcode", 4));
+        .concat(onlyExts(nodeutil.allFiles(pref + "built/web", { maxDepth: 1 }), [".js", ".css"]))
+        .concat(nodeutil.allFiles(pref + "built/web/fonts", { maxDepth: 1 }))
+        .concat(nodeutil.allFiles(pref + "built/web/vs", { maxDepth: 4 }))
+        .concat(nodeutil.allFiles(pref + "built/web/skillmap", { maxDepth: 4 }))
+        .concat(nodeutil.allFiles(pref + "built/web/authcode", { maxDepth: 4 }));
 }
 function semverCmp(a, b) {
     let parse = (s) => {
@@ -158038,7 +158048,7 @@ function targetFileList() {
     let lst = onlyExts(nodeutil.allFiles("built"), [".js", ".css", ".json", ".webmanifest"])
         .concat(nodeutil.allFiles(path.join(simDir(), "public")));
     if (simDir() != "sim")
-        lst = lst.concat(nodeutil.allFiles(path.join("sim", "public"), 5, true));
+        lst = lst.concat(nodeutil.allFiles(path.join("sim", "public"), { maxDepth: 5, allowMissing: true }));
     pxt.debug(`target files (on disk): ${lst.join('\r\n    ')}`);
     return lst;
 }
@@ -158553,7 +158563,7 @@ function forEachBundledPkgAsync(f, includeProjects = false) {
     let prev = process.cwd();
     let folders = pxt.appTarget.bundleddirs;
     if (includeProjects) {
-        let projects = nodeutil.allFiles("libs", 1, /*allowMissing*/ false, /*includeDirs*/ true).filter(f => /prj$/.test(f));
+        let projects = nodeutil.allFiles("libs", { maxDepth: 1, includeDirs: true }).filter(f => /prj$/.test(f));
         folders = folders.concat(projects);
     }
     return U.promiseMapAllSeries(folders, (dirname) => {
@@ -158718,7 +158728,7 @@ function buildEditorExtensionAsync(dirname, optionName) {
         else
             p = buildFolderAsync(dirname, true, dirname);
         return p.then(() => {
-            const prepends = nodeutil.allFiles(path.join(dirname, "prepend"), 1, true)
+            const prepends = nodeutil.allFiles(path.join(dirname, "prepend"), { maxDepth: 1, allowMissing: true })
                 .filter(f => /\.js$/.test(f));
             if (prepends && prepends.length) {
                 const editorjs = path.join("built", dirname + ".js");
@@ -159319,7 +159329,7 @@ function updateDefaultProjects(cfg) {
         pxt.BLOCKS_PROJECT_NAME,
         pxt.JAVASCRIPT_PROJECT_NAME
     ];
-    nodeutil.allFiles("libs", 1, /*allowMissing*/ false, /*includeDirs*/ true)
+    nodeutil.allFiles("libs", { maxDepth: 1, includeDirs: true })
         .filter((f) => {
         return defaultProjects.indexOf(path.basename(f)) !== -1;
     })
@@ -159780,7 +159790,7 @@ function renderDocs(builtPackaged, localDir) {
     docFolders.push(...nodeutil.getBundledPackagesDocs());
     docFolders.push("docs");
     for (const docFolder of docFolders) {
-        for (const f of nodeutil.allFiles(docFolder, 8)) {
+        for (const f of nodeutil.allFiles(docFolder, { maxDepth: 8 })) {
             pxt.log(`rendering ${f}`);
             const pathUnderDocs = f.slice(docFolder.length + 1);
             let outputFile = path.join(dst, "docs", pathUnderDocs);
@@ -161904,7 +161914,7 @@ function buildJResSpritesDirectoryAsync(dir) {
         return [(v >> 16) & 0xff, (v >> 8) & 0xff, (v >> 0) & 0xff];
     });
     let ts = `namespace ${metaInfo.star.namespace} {\n`;
-    for (let fn of nodeutil.allFiles(dir, 1)) {
+    for (let fn of nodeutil.allFiles(dir, { maxDepth: 1 })) {
         fn = fn.replace(/\\/g, "/");
         let m = /(.*\/)(.*)\.png$/i.exec(fn);
         if (!m)
@@ -162479,6 +162489,12 @@ function internalCheckDocsAsync(compileSnippets, re, fix, pycheck) {
     const docsRoot = nodeutil.targetDir;
     const docsTemplate = server.expandDocFileTemplate("docs.html");
     pxt.log(`checking docs`);
+    const ignoredFoldersKey = ".checkdocs-ignore";
+    const ignoredFolders = nodeutil.allFiles("docs", { includeHiddenFiles: true })
+        .filter(el => el.endsWith(ignoredFoldersKey))
+        .map(el => path.dirname(path.join(el.substring(4))) + path.sep);
+    if (ignoredFolders.length)
+        pxt.log(`Ignoring folders [${ignoredFolders.join(", ")}]`);
     const noTOCs = [];
     const todo = [];
     let urls = {};
@@ -162487,12 +162503,12 @@ function internalCheckDocsAsync(compileSnippets, re, fix, pycheck) {
     // only check each snippet once.
     const existingSnippets = {};
     let snippets = [];
-    const maxFileSize = checkFileSize(nodeutil.allFiles("docs", 10, true, true, ".ignorelargefiles"));
+    const maxFileSize = checkFileSize(nodeutil.allFiles("docs", { maxDepth: 10, allowMissing: true, includeDirs: true, ignoredFileMarker: ".ignorelargefiles" }));
     if (!pxt.appTarget.ignoreDocsErrors
         && maxFileSize > (pxt.appTarget.cloud.maxFileSize || (5000000)))
         U.userError(`files too big in docs folder`);
     // scan and fix image links
-    nodeutil.allFiles("docs")
+    nodeutil.allFiles("docs", { ignoredFileMarker: ignoredFoldersKey })
         .filter(f => /\.md/.test(f))
         .forEach(f => {
         let md = fs.readFileSync(f, { encoding: "utf8" });
@@ -162547,6 +162563,9 @@ function internalCheckDocsAsync(compileSnippets, re, fix, pycheck) {
             urls[url] = isResource
                 ? nodeutil.fileExistsSync(path.join(docsRoot, "docs", url))
                 : nodeutil.resolveMd(docsRoot, url);
+            const pathedUrl = path.join(url);
+            if (ignoredFolders.some(el => pathedUrl.startsWith(el)))
+                return;
             if (!isResource && urls[url])
                 todo.push(url);
         }
@@ -162564,7 +162583,8 @@ function internalCheckDocsAsync(compileSnippets, re, fix, pycheck) {
             entry.subitems.forEach(checkTOCEntry);
     }
     // check over TOCs
-    nodeutil.allFiles("docs", 5).filter(f => /SUMMARY\.md$/.test(f))
+    nodeutil.allFiles("docs", { maxDepth: 5, ignoredFileMarker: ignoredFoldersKey })
+        .filter(f => /SUMMARY\.md$/.test(f))
         .forEach(summaryFile => {
         const summaryPath = path.join(path.dirname(summaryFile), 'SUMMARY').replace(/^docs[\/\\]/, '');
         pxt.log(`looking for ${summaryPath}`);
@@ -162602,7 +162622,8 @@ function internalCheckDocsAsync(compileSnippets, re, fix, pycheck) {
     if (targetDirs) {
         targetDirs.forEach(dir => {
             pxt.log(`looking for markdown files in ${dir}`);
-            nodeutil.allFiles(path.join("docs", dir), 3).filter(f => mdRegex.test(f))
+            nodeutil.allFiles(path.join("docs", dir), { maxDepth: 3, ignoredFileMarker: ".checkdocs-ignore" })
+                .filter(f => mdRegex.test(f))
                 .forEach(md => {
                 pushUrl(md.slice(5).replace(mdRegex, ""), true);
             });
@@ -162679,6 +162700,9 @@ function internalCheckDocsAsync(compileSnippets, re, fix, pycheck) {
                                 card.otherActions.forEach(a => { if (a.url)
                                     urls.push(a.url); });
                             for (let url of urls) {
+                                const pathedUrl = path.join(url);
+                                if (ignoredFolders.some(el => pathedUrl.startsWith(el)))
+                                    return;
                                 const tutorialMd = nodeutil.resolveMd(docsRoot, url);
                                 if (!tutorialMd) {
                                     pxt.log(`unable to resolve ${url}`);
@@ -162728,6 +162752,9 @@ function internalCheckDocsAsync(compileSnippets, re, fix, pycheck) {
                                 card.otherActions.forEach(a => { if (a.url)
                                     urls.push(a.url); });
                             for (let url of urls) {
+                                const pathedUrl = path.join(url);
+                                if (ignoredFolders.some(el => pathedUrl.startsWith(el)))
+                                    return;
                                 const exMd = nodeutil.resolveMd(docsRoot, url);
                                 if (!exMd) {
                                     pxt.log(`unable to resolve ${url}`);
@@ -162777,7 +162804,7 @@ function internalCheckDocsAsync(compileSnippets, re, fix, pycheck) {
 async function upgradeCardsAsync() {
     const docsRoot = nodeutil.targetDir;
     // markdowns with cards
-    const mds = nodeutil.allFiles(docsRoot, 10, false, false)
+    const mds = nodeutil.allFiles(docsRoot, { maxDepth: 10 })
         .filter(fn => /\.md$/.test(fn))
         .map(fn => ({ filename: fn, content: nodeutil.readText(fn) }))
         .filter(f => /```codecard/.test(f.content));
@@ -162805,7 +162832,7 @@ function internalCacheUsedBlocksAsync() {
     if (targetDirs) {
         targetDirs.forEach(dir => {
             pxt.log(`looking for tutorial markdown in ${dir}`);
-            nodeutil.allFiles(path.join("docs", dir), 3).filter(f => mdRegex.test(f))
+            nodeutil.allFiles(path.join("docs", dir), { maxDepth: 3 }).filter(f => mdRegex.test(f))
                 .forEach(md => {
                 mdPaths.push(md.slice(5).replace(mdRegex, ""));
             });
@@ -162984,7 +163011,7 @@ function webstringsJson() {
 }
 function extractLocStringsAsync(output, dirs) {
     let prereqs = [];
-    dirs.forEach(dir => prereqs = prereqs.concat(nodeutil.allFiles(dir, 20)));
+    dirs.forEach(dir => prereqs = prereqs.concat(nodeutil.allFiles(dir, { maxDepth: 20 })));
     let errCnt = 0;
     let translationStrings = {};
     function processLf(filename) {