@itwin/build-tools 3.6.0-dev.36 → 3.6.0-dev.38

package/bin/betools.js

@@ -40,6 +40,9 @@ yargs.strict(true)
         "excludeGlob": {
           describe: "Specify a directory, filename, or pattern to be excluded"
         },
+        "testExcludeGlob": {
+          describe: "Specify a directory, filename, or pattern to exclude tests. Default value: '**/*test*/**/*'"
+        },
         "tsIndexFile": {
           describe: "The barrel file containing the module documentation. This file is copied to the output folder for parsing."
         },
@@ -92,6 +95,21 @@ yargs.strict(true)
       })
     },
     (argv) => { pseudolocalizeCommand(argv) })
+  .command("copy-assets", "copy assets from @itwin or @bentley dependencies into a destination directory",
+    function (yargs) {
+      return yargs.options({
+        "packageJsonDir": {
+          describe: "The path at which the package.json listing deps that need their assets copied can be found. defaults to '.'"
+        },
+        "nodeModulesDir": {
+          describe: "The path to the node_modules directory where the deps that need their assets copied can be found. defaults to '.'"
+        },
+        "destinationDir": {
+          describe: "the location to copy the assets to. defaults to './lib/assets'"
+        },
+      })
+    },
+    (argv) => { copyAssetsCommand(argv) })
   .help()
   .argv;
 
@@ -112,11 +130,12 @@ function docsCommand(options) {
   const includesOpt = options.includes ? ["--includes", options.includes] : [];
   const excludesOpt = options.excludes ? ["--excludes", options.excludes] : [];
   const excludesGlobOpt = options.excludeGlob ? ["--excludeGlob", options.excludeGlob] : [];
+  const testExcludeGlobOpt = options.testExcludeGlob ? ["--testExcludeGlob", options.testExcludeGlob] : [];
   const indexFileOpt = options.tsIndexFile ? ["--tsIndexFile", options.tsIndexFile] : [];
   const onlyJsonOpt = options.onlyJson ? ["--onlyJson"] : [];
   exec(["node", getScriptPath("docs.js"),
     ...sourceOpt, ...outOpt, ...jsonOpt, ...baseUrlOpt, ...includesOpt,
-    ...excludesOpt, ...excludesGlobOpt, ...indexFileOpt, ...onlyJsonOpt]);
+    ...excludesOpt, ...excludesGlobOpt, ...testExcludeGlobOpt, ...indexFileOpt, ...onlyJsonOpt]);
 }
 
 function extractCommand(options) {
@@ -139,6 +158,13 @@ function pseudolocalizeCommand(options) {
   exec(["node", getScriptPath("pseudolocalize"), ...englishDir, ...outOpt]);
 }
 
+function copyAssetsCommand(options) {
+  const packageJsonDir = options.packageJsonDir ? ["--packageJsonDir", options.packageJsonDir] : [];
+  const nodeModulesDir = options.nodeModulesDir ? ["--nodeModulesDir", options.nodeModulesDir] : [];
+  const destinationDir = options.destinationDir ? ["--destinationDir", options.destinationDir] : [];
+  exec(["node", path.resolve(__dirname, "../scripts/copy-assets.js"), ...packageJsonDir, ...nodeModulesDir, ...destinationDir]);
+}
+
 function exec(cmd) {
   console.log("Running command:");
   console.log(cmd.join(" "));

package/mocha-reporter/index.js

@@ -1,97 +1,97 @@
-"use strict";
-var _a, _b;
-Object.defineProperty(exports, "__esModule", { value: true });
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/* eslint-disable @typescript-eslint/naming-convention */
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable no-console */
-const debugLeaks = process.env.DEBUG_LEAKS;
-if (debugLeaks)
-    require("wtfnode");
-const path = require("path");
-const fs = require("fs-extra");
-const { logBuildWarning, logBuildError, failBuild } = require("../scripts/utils/utils");
-const Base = require("mocha/lib/reporters/base");
-const Spec = require("mocha/lib/reporters/spec");
-const MochaJUnitReporter = require("mocha-junit-reporter");
-function withStdErr(callback) {
-    const originalConsoleLog = Base.consoleLog;
-    Base.consoleLog = console.error;
-    callback();
-    Base.consoleLog = originalConsoleLog;
-}
-const isCI = process.env.CI || process.env.TF_BUILD;
-// Force rush test to fail CI builds if describe.only or it.only is used.
-// These should only be used for debugging and must not be committed, otherwise we may be accidentally skipping lots of tests.
-if (isCI) {
-    if (typeof (mocha) !== "undefined")
-        mocha.forbidOnly();
-    else
-        require.cache[require.resolve("mocha/lib/mocharc.json", { paths: (_b = (_a = require.main) === null || _a === void 0 ? void 0 : _a.paths) !== null && _b !== void 0 ? _b : module.paths })].exports.forbidOnly = true;
-}
-// This is necessary to enable colored output when running in rush test:
-Object.defineProperty(Base, "color", {
-    get: () => process.env.FORCE_COLOR !== "false" && process.env.FORCE_COLOR !== "0",
-    set: () => { },
-});
-class BentleyMochaReporter extends Spec {
-    constructor(_runner, _options) {
-        super(...arguments);
-        this._junitReporter = new MochaJUnitReporter(...arguments);
-    }
-    epilogue(...args) {
-        // Force test errors to be printed to stderr instead of stdout.
-        // This will allow rush to correctly summarize test failure when running rush test.
-        if (this.stats.failures) {
-            withStdErr(() => super.epilogue(...args));
-        }
-        else {
-            super.epilogue(...args);
-            if (0 === this.stats.passes) {
-                logBuildError("There were 0 passing tests.  That doesn't seem right."
-                    + "\nIf there are really no passing tests and no failures, then what was even the point?"
-                    + "\nIt seems likely that tests were skipped by it.only, it.skip, or grep filters, so I'm going to fail now.");
-                failBuild();
-            }
-        }
-        // Detect hangs caused by tests that leave timers/other handles open - not possible in electron frontends.
-        if (!("electron" in process.versions)) {
-            // NB: By calling unref() on this timer, we stop it from keeping the process alive, so it will only fire if _something else_ is still keeping
-            // the process alive after 5 seconds.  This also has the benefit of preventing the timer from showing up in wtfnode's dump of open handles.
-            setTimeout(() => {
-                logBuildError(`Handle leak detected. Node was still running 5 seconds after tests completed.`);
-                if (debugLeaks) {
-                    const wtf = require("wtfnode");
-                    wtf.setLogger("info", console.error);
-                    wtf.dump();
-                }
-                else {
-                    console.error("Try running with the DEBUG_LEAKS env var set to see open handles.");
-                }
-                // Not sure why, but process.exit(1) wasn't working here...
-                process.kill(process.pid);
-            }, 5000).unref();
-        }
-        if (!this.stats.pending)
-            return;
-        // Also log warnings in CI builds when tests have been skipped.
-        const currentPkgJson = path.join(process.cwd(), "package.json");
-        if (fs.existsSync(currentPkgJson)) {
-            const currentPackage = require(currentPkgJson).name;
-            if (this.stats.pending === 1)
-                logBuildWarning(`1 test skipped in ${currentPackage}`);
-            else
-                logBuildWarning(`${this.stats.pending} tests skipped in ${currentPackage}`);
-        }
-        else {
-            if (this.stats.pending === 1)
-                logBuildWarning(`1 test skipped`);
-            else
-                logBuildWarning(`${this.stats.pending} tests skipped`);
-        }
-    }
-}
-module.exports = BentleyMochaReporter;
+"use strict";
+var _a, _b;
+Object.defineProperty(exports, "__esModule", { value: true });
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable @typescript-eslint/naming-convention */
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable no-console */
+const debugLeaks = process.env.DEBUG_LEAKS;
+if (debugLeaks)
+    require("wtfnode");
+const path = require("path");
+const fs = require("fs-extra");
+const { logBuildWarning, logBuildError, failBuild } = require("../scripts/utils/utils");
+const Base = require("mocha/lib/reporters/base");
+const Spec = require("mocha/lib/reporters/spec");
+const MochaJUnitReporter = require("mocha-junit-reporter");
+function withStdErr(callback) {
+    const originalConsoleLog = Base.consoleLog;
+    Base.consoleLog = console.error;
+    callback();
+    Base.consoleLog = originalConsoleLog;
+}
+const isCI = process.env.CI || process.env.TF_BUILD;
+// Force rush test to fail CI builds if describe.only or it.only is used.
+// These should only be used for debugging and must not be committed, otherwise we may be accidentally skipping lots of tests.
+if (isCI) {
+    if (typeof (mocha) !== "undefined")
+        mocha.forbidOnly();
+    else
+        require.cache[require.resolve("mocha/lib/mocharc.json", { paths: (_b = (_a = require.main) === null || _a === void 0 ? void 0 : _a.paths) !== null && _b !== void 0 ? _b : module.paths })].exports.forbidOnly = true;
+}
+// This is necessary to enable colored output when running in rush test:
+Object.defineProperty(Base, "color", {
+    get: () => process.env.FORCE_COLOR !== "false" && process.env.FORCE_COLOR !== "0",
+    set: () => { },
+});
+class BentleyMochaReporter extends Spec {
+    constructor(_runner, _options) {
+        super(...arguments);
+        this._junitReporter = new MochaJUnitReporter(...arguments);
+    }
+    epilogue(...args) {
+        // Force test errors to be printed to stderr instead of stdout.
+        // This will allow rush to correctly summarize test failure when running rush test.
+        if (this.stats.failures) {
+            withStdErr(() => super.epilogue(...args));
+        }
+        else {
+            super.epilogue(...args);
+            if (0 === this.stats.passes) {
+                logBuildError("There were 0 passing tests.  That doesn't seem right."
+                    + "\nIf there are really no passing tests and no failures, then what was even the point?"
+                    + "\nIt seems likely that tests were skipped by it.only, it.skip, or grep filters, so I'm going to fail now.");
+                failBuild();
+            }
+        }
+        // Detect hangs caused by tests that leave timers/other handles open - not possible in electron frontends.
+        if (!("electron" in process.versions)) {
+            // NB: By calling unref() on this timer, we stop it from keeping the process alive, so it will only fire if _something else_ is still keeping
+            // the process alive after 5 seconds.  This also has the benefit of preventing the timer from showing up in wtfnode's dump of open handles.
+            setTimeout(() => {
+                logBuildError(`Handle leak detected. Node was still running 5 seconds after tests completed.`);
+                if (debugLeaks) {
+                    const wtf = require("wtfnode");
+                    wtf.setLogger("info", console.error);
+                    wtf.dump();
+                }
+                else {
+                    console.error("Try running with the DEBUG_LEAKS env var set to see open handles.");
+                }
+                // Not sure why, but process.exit(1) wasn't working here...
+                process.kill(process.pid);
+            }, 5000).unref();
+        }
+        if (!this.stats.pending)
+            return;
+        // Also log warnings in CI builds when tests have been skipped.
+        const currentPkgJson = path.join(process.cwd(), "package.json");
+        if (fs.existsSync(currentPkgJson)) {
+            const currentPackage = require(currentPkgJson).name;
+            if (this.stats.pending === 1)
+                logBuildWarning(`1 test skipped in ${currentPackage}`);
+            else
+                logBuildWarning(`${this.stats.pending} tests skipped in ${currentPackage}`);
+        }
+        else {
+            if (this.stats.pending === 1)
+                logBuildWarning(`1 test skipped`);
+            else
+                logBuildWarning(`${this.stats.pending} tests skipped`);
+        }
+    }
+}
+module.exports = BentleyMochaReporter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/build-tools",
-  "version": "3.6.0-dev.36",
+  "version": "3.6.0-dev.38",
   "description": "Bentley build tools",
   "license": "MIT",
   "repository": {
@@ -37,7 +37,7 @@
     "yargs": "^17.4.0"
   },
   "devDependencies": {
-    "@itwin/eslint-plugin": "3.6.0-dev.36",
+    "@itwin/eslint-plugin": "3.6.0-dev.38",
     "@types/node": "18.11.5",
     "eslint": "^7.11.0"
   },

package/scripts/copy-assets.js

@@ -0,0 +1,61 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+
+"use strict"
+
+const argv = require("yargs").argv;
+const fs = require("fs-extra");
+const path = require("path");
+
+// example usage
+// betools copy-assets --nodeModulesDir=../../../../
+
+const packageJsonDir = argv.packageJsonDir ?? ".";
+const nodeModulesDir = argv.nodeModulesDir ?? ".";
+const destinationDir = argv.destinationDir ?? "./lib/assets";
+
+// find all dependencies that should have their assets copied from
+// currently this logic will find only packages with the @itwin or @bentley scope
+const getBentleyPackageDeps = () => {
+  const packageJsonPath = `${packageJsonDir}/package.json`;
+  const packageJsonRaw = fs.readFileSync(packageJsonPath);
+  const packageJson = JSON.parse(packageJsonRaw);
+  const deps = new Set();
+
+  for (const packageName in packageJson.dependencies) {
+    if (packageName.includes("@itwin") || packageName.includes("@bentley")) {
+      deps.add(packageName);
+    }
+  }
+
+  return Array.from(deps);
+}
+
+const copySync = (fromPath, toPath) => {
+  if (fs.existsSync(fromPath)) {
+    try {
+      fs.copySync(fromPath, toPath);
+      console.log(`successfully copied from ${fromPath} to ${toPath}`)
+    } catch (ex) {
+      console.error(`failed to copy from ${fromPath} to ${toPath}`, ex);
+    }
+  }
+}
+
+// finds all applicable dependences with assets and copies them into the destination folder
+const copyBentleyPackageDepAssets = () => {
+  if (!fs.existsSync(destinationDir)) {
+    fs.mkdirSync(destinationDir, { recursive: true });
+  }
+
+  // check for assets found in lib as well as lib/cjs
+  for (const target of getBentleyPackageDeps()) {
+    copySync(path.join(nodeModulesDir, "node_modules", target, "lib/assets"), destinationDir);
+    copySync(path.join(nodeModulesDir, "node_modules", target, "lib/cjs/assets"), destinationDir);
+  }
+}
+
+copyBentleyPackageDepAssets();
+console.log("finished copying assets");

package/scripts/docs.js

@@ -29,7 +29,8 @@ const json = (argv.json === undefined) ? paths.appJsonDocs : argv.json;
 const baseUrlOptions = (argv.baseUrl === undefined) ? [] : ["--baseUrl", argv.baseUrl];
 const includeOptions = (argv.includes === undefined) ? [] : ["--includes", argv.includes];
 
-let excludeList = "**/node_modules/**/*,**/*test*/**/*";
+const testExclude = argv.testExcludeGlob ?? "**/*test*/**/*";
+let excludeList = `**/node_modules/**/*,${testExclude}`;
 if (argv.excludes !== undefined)
   excludeList += ",**/" + argv.excludes + "/**/*";
 if (argv.excludeGlob !== undefined)