@itwin/build-tools 3.5.0-dev.8 → 3.5.1

package/CHANGELOG.md

@@ -1,6 +1,77 @@
 # Change Log - @itwin/build-tools
 
-This log was last generated on Thu, 01 Sep 2022 14:37:22 GMT and should not be manually modified.
+This log was last generated on Thu, 15 Dec 2022 16:38:28 GMT and should not be manually modified.
+
+## 3.5.1
+Thu, 15 Dec 2022 16:38:28 GMT
+
+_Version update only_
+
+## 3.5.0
+Wed, 07 Dec 2022 19:12:36 GMT
+
+_Version update only_
+
+## 3.4.7
+Wed, 30 Nov 2022 14:28:19 GMT
+
+_Version update only_
+
+## 3.4.6
+Tue, 22 Nov 2022 14:24:19 GMT
+
+_Version update only_
+
+## 3.4.5
+Thu, 17 Nov 2022 21:32:50 GMT
+
+_Version update only_
+
+## 3.4.4
+Thu, 10 Nov 2022 19:32:17 GMT
+
+_Version update only_
+
+## 3.4.3
+Fri, 28 Oct 2022 13:34:57 GMT
+
+### Updates
+
+- Replace use of recursive-readdir package with local implementation
+
+## 3.4.2
+Mon, 24 Oct 2022 13:23:45 GMT
+
+_Version update only_
+
+## 3.4.1
+Mon, 17 Oct 2022 20:06:51 GMT
+
+_Version update only_
+
+## 3.4.0
+Thu, 13 Oct 2022 20:24:47 GMT
+
+### Updates
+
+- Use Rush env variable to find root monorepo path
+- Updated Node types declaration to support latest v16
+- Update mocha-junit-reporter to v2.0.2
+
+## 3.3.5
+Tue, 27 Sep 2022 11:50:59 GMT
+
+_Version update only_
+
+## 3.3.4
+Thu, 08 Sep 2022 19:00:04 GMT
+
+_Version update only_
+
+## 3.3.3
+Tue, 06 Sep 2022 20:54:19 GMT
+
+_Version update only_
 
 ## 3.3.2
 Thu, 01 Sep 2022 14:37:22 GMT

package/ThirdPartyNotices.md

@@ -13,3 +13,27 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## [recursive-readdir](https://github.com/jergason/recursive-readdir)
+
+The MIT License (MIT)
+
+Copyright (c) \<year> \<copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

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.5.0-dev.8",
+  "version": "3.5.1",
   "description": "Bentley build tools",
   "license": "MIT",
   "repository": {
@@ -28,7 +28,6 @@
     "glob": "^7.1.2",
     "mocha": "^10.0.0",
     "mocha-junit-reporter": "^2.0.2",
-    "recursive-readdir": "^2.2.2",
     "rimraf": "^3.0.2",
     "tree-kill": "^1.2.0",
     "typedoc": "^0.22.11",
@@ -38,8 +37,8 @@
     "yargs": "^17.4.0"
   },
   "devDependencies": {
-    "@itwin/eslint-plugin": "3.5.0-dev.8",
-    "@types/node": "16.11.59",
+    "@itwin/eslint-plugin": "3.5.1",
+    "@types/node": "18.11.5",
     "eslint": "^7.11.0"
   },
   "eslintConfig": {

package/scripts/extract.js

@@ -8,7 +8,7 @@ const argv = require("yargs").argv;
 const path = require("path");
 const paths = require("./config/paths");
 const fs = require("fs-extra");
-const readDirectory = require("recursive-readdir");
+const { readDirectory } = require("./utils/recursiveReaddir");
 
 const __PUBLISH_EXTRACT_START__ = "__PUBLISH_EXTRACT_START__";
 const __PUBLISH_EXTRACT_END__ = "__PUBLISH_EXTRACT_END__";

package/scripts/utils/recursiveReaddir.js

@@ -0,0 +1,96 @@
+const fs = require("fs");
+const p = require("path");
+
+function matchesFile(ignorePath) {
+  return function (path, stats) {
+    return stats.isFile() && ignorePath === path;
+  };
+}
+
+function toMatcherFunction(ignoreEntry) {
+  if (typeof ignoreEntry == "function") {
+    return ignoreEntry;
+  } else {
+    return matchesFile(ignoreEntry);
+  }
+}
+
+function readdir(path, ignores, callback) {
+  if (typeof ignores == "function") {
+    callback = ignores;
+    ignores = [];
+  }
+
+  if (!callback) {
+    return new Promise(function (resolve, reject) {
+      readdir(path, ignores || [], function (err, data) {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(data);
+        }
+      });
+    });
+  }
+
+  ignores = ignores.map(toMatcherFunction);
+
+  let list = [];
+
+  fs.readdir(path, function (err, files) {
+    if (err) {
+      return callback(err);
+    }
+
+    let pending = files.length;
+    if (!pending) {
+      // we are done
+      return callback(null, list);
+    }
+
+    files.forEach(function (file) {
+      const filePath = p.join(path, file);
+      fs.stat(filePath, function (_err, stats) {
+        if (_err) {
+          return callback(_err);
+        }
+
+        if (
+          ignores.some(function (matcher) {
+            return matcher(filePath, stats);
+          })
+        ) {
+          pending -= 1;
+          if (!pending) {
+            return callback(null, list);
+          }
+          return null;
+        }
+
+        if (stats.isDirectory()) {
+          readdir(filePath, ignores, function (__err, res) {
+            if (__err) {
+              return callback(__err);
+            }
+
+            list = list.concat(res);
+            pending -= 1;
+            if (!pending) {
+              return callback(null, list);
+            }
+          });
+        } else {
+          list.push(filePath);
+          pending -= 1;
+          if (!pending) {
+            return callback(null, list);
+          }
+        }
+      });
+    });
+  });
+}
+
+module.exports = {
+  readDirectory: readdir
+};