pxt-core 8.1.2 → 8.1.3

package/built/buildengine.js

@@ -216,7 +216,7 @@ function buildHexAsync(buildEngine, mainPkg, extInfo, forceBuild) {
     let allFiles = U.clone(extInfo.generatedFiles);
     U.jsonCopyFrom(allFiles, extInfo.extensionFiles);
     let writeFiles = () => {
-        for (let f of nodeutil.allFiles(buildEngine.buildPath + "/" + buildEngine.appPath, 8, true)) {
+        for (let f of nodeutil.allFiles(buildEngine.buildPath + "/" + buildEngine.appPath, { maxDepth: 8, allowMissing: true })) {
             let bn = f.slice(buildEngine.buildPath.length);
             bn = bn.replace(/\\/g, "/").replace(/^\//, "/");
             if (U.startsWith(bn, "/" + buildEngine.appPath + "/") && !allFiles[bn]) {
@@ -471,7 +471,7 @@ function buildDalConst(buildEngine, mainPkg, rebuild = false, create = false) {
                         if (U.endsWith(dn, ".h"))
                             files.push(dn);
                         else {
-                            let here = nodeutil.allFiles(dn, 20).filter(fn => U.endsWith(fn, ".h"));
+                            let here = nodeutil.allFiles(dn, { maxDepth: 20 }).filter(fn => U.endsWith(fn, ".h"));
                             U.pushRange(files, here);
                         }
                     }
@@ -487,7 +487,7 @@ function buildDalConst(buildEngine, mainPkg, rebuild = false, create = false) {
                 incPath = buildEngine.buildPath;
             if (!fs.existsSync(incPath))
                 U.userError("cannot find " + incPath);
-            files = nodeutil.allFiles(incPath, 20)
+            files = nodeutil.allFiles(incPath, { maxDepth: 20 })
                 .filter(fn => U.endsWith(fn, ".h"))
                 .filter(fn => fn.indexOf("/mbed-classic/") < 0)
                 .filter(fn => fn.indexOf("/mbed-os/") < 0);

package/built/cli.js

@@ -302,11 +302,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) => {
@@ -618,7 +618,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;
 }
@@ -1133,7 +1133,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) => {
@@ -1298,7 +1298,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");
@@ -1899,7 +1899,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;
     })
@@ -2360,7 +2360,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);
@@ -4484,7 +4484,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)
@@ -5059,6 +5059,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 = {};
@@ -5067,12 +5073,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" });
@@ -5127,6 +5133,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);
         }
@@ -5144,7 +5153,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}`);
@@ -5182,7 +5192,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);
             });
@@ -5259,6 +5270,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}`);
@@ -5308,6 +5322,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}`);
@@ -5357,7 +5374,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));
@@ -5385,7 +5402,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, ""));
             });
@@ -5564,7 +5581,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) {

package/built/nodeutil.d.ts

@@ -43,7 +43,14 @@ export declare function pathToPtr(path: string): string;
 export declare function mkdirP(thePath: string): void;
 export declare function cpR(src: string, dst: string, maxDepth?: number): void;
 export declare function cp(srcFile: string, destDirectory: string, destName?: string): void;
-export declare function allFiles(top: string, maxDepth?: number, allowMissing?: boolean, includeDirs?: boolean, ignoredFileMarker?: string): string[];
+interface AllFilesOpts {
+    maxDepth?: number;
+    allowMissing?: boolean;
+    includeDirs?: boolean;
+    ignoredFileMarker?: string;
+    includeHiddenFiles?: boolean;
+}
+export declare function allFiles(top: string, opts?: AllFilesOpts): string[];
 export declare function existsDirSync(name: string): boolean;
 export declare function writeFileSync(p: string, data: any, options?: {
     encoding?: string | null;
@@ -58,3 +65,4 @@ export declare function getBundledPackagesDocs(): string[];
 export declare function lazyDependencies(): pxt.Map<string>;
 export declare function lazyRequire(name: string, install?: boolean): any;
 export declare function stringify(content: any): string;
+export {};

package/built/nodeutil.js

@@ -313,7 +313,7 @@ function mkdirP(thePath) {
 exports.mkdirP = mkdirP;
 function cpR(src, dst, maxDepth = 8) {
     src = path.resolve(src);
-    let files = allFiles(src, maxDepth);
+    let files = allFiles(src, { maxDepth });
     let dirs = {};
     for (let f of files) {
         let bn = f.slice(src.length);
@@ -335,12 +335,13 @@ function cp(srcFile, destDirectory, destName) {
     fs.writeFileSync(dest, buf);
 }
 exports.cp = cp;
-function allFiles(top, maxDepth = 8, allowMissing = false, includeDirs = false, ignoredFileMarker = undefined) {
+function allFiles(top, opts = {}) {
+    const { maxDepth, allowMissing, includeDirs, ignoredFileMarker, includeHiddenFiles } = Object.assign({ maxDepth: 8 }, opts);
     let res = [];
     if (allowMissing && !existsDirSync(top))
         return res;
     for (const p of fs.readdirSync(top)) {
-        if (p[0] == ".")
+        if (p[0] == "." && !includeHiddenFiles)
             continue;
         const inner = path.join(top, p);
         const st = fs.statSync(inner);
@@ -349,7 +350,7 @@ function allFiles(top, maxDepth = 8, allowMissing = false, includeDirs = false,
             if (ignoredFileMarker && fs.existsSync(path.join(inner, ignoredFileMarker)))
                 continue;
             if (maxDepth > 1)
-                Util.pushRange(res, allFiles(inner, maxDepth - 1));
+                Util.pushRange(res, allFiles(inner, Object.assign(Object.assign({}, opts), { maxDepth: maxDepth - 1 })));
             if (includeDirs)
                 res.push(inner);
         }