@itwin/build-tools 4.0.0-dev.8 → 4.0.0-dev.81

package/CHANGELOG.md

@@ -1,6 +1,50 @@
 # Change Log - @itwin/build-tools
 
-This log was last generated on Thu, 26 Jan 2023 22:53:27 GMT and should not be manually modified.
+This log was last generated on Wed, 12 Apr 2023 13:12:42 GMT and should not be manually modified.
+
+## 3.7.2
+Wed, 12 Apr 2023 13:12:42 GMT
+
+_Version update only_
+
+## 3.7.1
+Mon, 03 Apr 2023 15:15:36 GMT
+
+_Version update only_
+
+## 3.7.0
+Wed, 29 Mar 2023 15:02:27 GMT
+
+_Version update only_
+
+## 3.6.3
+Mon, 27 Mar 2023 16:26:47 GMT
+
+_Version update only_
+
+## 3.6.2
+Fri, 17 Mar 2023 17:52:32 GMT
+
+_Version update only_
+
+## 3.6.1
+Fri, 24 Feb 2023 22:00:48 GMT
+
+_Version update only_
+
+## 3.6.0
+Wed, 08 Feb 2023 14:58:39 GMT
+
+### Updates
+
+- Fix script paths for situation when repository path has spaces
+- add copy-assets script to betools command
+- Added ability to override default exclude pattern for tests when generating docs
+
+## 3.5.6
+Fri, 24 Feb 2023 16:02:47 GMT
+
+_Version update only_
 
 ## 3.5.5
 Thu, 26 Jan 2023 22:53:27 GMT

package/mocha-reporter/index.js

@@ -1,97 +1,96 @@
-"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";
+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: require.main?.paths ?? 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,11 +1,12 @@
 {
   "name": "@itwin/build-tools",
-  "version": "4.0.0-dev.8",
+  "version": "4.0.0-dev.81",
   "description": "Bentley build tools",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/iTwin/itwinjs-core/tree/master/tools/build"
+    "url": "https://github.com/iTwin/itwinjs-core.git",
+    "directory": "tools/build"
   },
   "bin": {
     "betools": "bin/betools.js"
@@ -20,7 +21,7 @@
     "url": "http://www.bentley.com"
   },
   "dependencies": {
-    "@microsoft/api-extractor": "7.23.2",
+    "@microsoft/api-extractor": "7.34.4",
     "chalk": "^3.0.0",
     "cpx2": "^3.0.0",
     "cross-spawn": "^7.0.1",
@@ -32,14 +33,14 @@
     "tree-kill": "^1.2.0",
     "typedoc": "^0.22.11",
     "typedoc-plugin-merge-modules": "^3.0.2",
-    "typescript": "~4.4.0",
+    "typescript": "~5.0.2",
     "wtfnode": "^0.9.1",
     "yargs": "^17.4.0"
   },
   "devDependencies": {
-    "@itwin/eslint-plugin": "4.0.0-dev.8",
-    "@types/node": "18.11.5",
-    "eslint": "^7.11.0"
+    "@itwin/eslint-plugin": "^4.0.0-dev.33",
+    "@types/node": "^18.11.5",
+    "eslint": "^8.36.0"
   },
   "eslintConfig": {
     "plugins": [
@@ -52,7 +53,6 @@
   },
   "scripts": {
     "build": "tsc 1>&2",
-    "build:ci": "npm run -s build",
     "clean": "rimraf ../../modules .rush/temp/package-deps*.json",
     "docs": "",
     "lint": "eslint -f visualstudio --config package.json --no-eslintrc \"./src/**/*.ts\" 1>&2",

package/scripts/docs.js

@@ -12,7 +12,7 @@ const cpx = require("cpx2");
 const fs = require("fs");
 const { spawn, handleInterrupts } = require("./utils/simpleSpawn");
 const { validateTags } = require("./utils/validateTags");
-const { addSourceDir } = require("./utils/addSourceDir");
+const { addPackageMetadata } = require("./utils/addPackageMetadata");
 const argv = require("yargs").argv;
 
 // Makes the script crash on unhandled rejections instead of silently
@@ -85,13 +85,14 @@ spawn(require.resolve(".bin/typedoc"), args).then((code) => {
     cpx.copySync(path.join(source, argv.tsIndexFile), outputDir);
     fs.renameSync(path.join(outputDir, argv.tsIndexFile), path.join(outputDir, 'index.ts'));
   }
+
   // Copy CHANGELOG.json to json output folder
   if (fs.existsSync(path.join(process.cwd(), 'CHANGELOG.json'))) {
     cpx.copySync(path.join(process.cwd(), 'CHANGELOG.json'), outputDir);
   }
 
-  // Append the directory of the package to the output
-  addSourceDir(json, process.cwd());
+  // Append the directory of the package, version and repository URL to the output
+  addPackageMetadata(json, process.cwd());
 
   if (code === 0) {
     let tagErrors = validateTags(json);

package/scripts/utils/addPackageMetadata.js

@@ -0,0 +1,50 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+
+const FS = require("fs-extra");
+const path = require("path");
+
+// We cannot guarantee the folder structure of a project
+// so find the project root using rush env variable if available.
+const rootPackageJson = process.env.RUSHSTACK_FILE_ERROR_BASE_FOLDER
+  ? path.join(process.env.RUSHSTACK_FILE_ERROR_BASE_FOLDER, "package.json")
+  : "../../../../package.json";
+
+// Check if path to root package.json is valid.
+const rootPackageJsonPath = require.resolve(rootPackageJson);
+
+//Find the package.json of the project and retrieve the version and repository URL
+const packageJsonPath = path.join(process.cwd(), "package.json");
+const packageJson = JSON.parse(FS.readFileSync(packageJsonPath));
+const version = packageJson.version;
+const repositoryUrl = packageJson.repository?.url;
+const repositoryDirectory = packageJson.repository?.directory;
+
+if (!version || !repositoryUrl || !repositoryDirectory) {
+  throw new Error("version or repository info not found in package.json");
+}
+
+// Appends the directory of the package root to the Typedoc JSON output
+function addPackageMetadata(file, directory) {
+  if (FS.existsSync(file) && FS.statSync(file).isFile()) {
+    const contents = FS.readFileSync(file, "utf-8");
+    const pathToRootFolder = path.dirname(rootPackageJsonPath);
+    const packageRoot = directory.substring(pathToRootFolder.length + 1);
+    const jsonContents = JSON.parse(contents);
+
+    jsonContents["packageRoot"] = packageRoot.endsWith("src")
+      ? packageRoot
+      : `${packageRoot}\\${"src"}`;
+    jsonContents["version"] = version;
+    jsonContents["repositoryUrl"] = repositoryUrl;
+    jsonContents["repositoryDirectory"] = repositoryDirectory;
+
+    FS.writeFileSync(file, Buffer.from(JSON.stringify(jsonContents, null, 2)));
+  }
+}
+
+module.exports = {
+  addPackageMetadata,
+};

package/tsconfig-base.json

@@ -23,6 +23,6 @@
     "strict": true,
     "strictNullChecks": true,
     "stripInternal": false,
-    "target": "ES2019"
+    "target": "ES2021"
   }
-}
+}

package/scripts/utils/addSourceDir.js

@@ -1,39 +0,0 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-const FS = require("fs-extra");
-const path = require("path");
-
-// We cannot guarantee the folder structure of a project
-// so find the project root using rush env variable if available.
-if (process.env.RUSHSTACK_FILE_ERROR_BASE_FOLDER) {
-  rootPackageJsonPath = path.resolve(
-    process.env.RUSHSTACK_FILE_ERROR_BASE_FOLDER,
-    "package.json"
-  );
-} else {
-  rootPackageJsonPath = path.resolve("../../../../package.json");
-}
-
-const rootPackageJson = require(rootPackageJsonPath);
-
-// Appends the directory of the package root to the Typedoc JSON output
-function addSourceDir(file, directory) {
-  if (FS.existsSync(file) && FS.statSync(file).isFile()) {
-    const contents = FS.readFileSync(file, "utf-8");
-    const packageRoot = directory.substring(
-      directory.indexOf(rootPackageJson.name) + rootPackageJson.name.length + 1
-    );
-    const jsonContents = JSON.parse(contents);
-    jsonContents["packageRoot"] = packageRoot.endsWith("src")
-      ? packageRoot
-      : `${packageRoot}\\${"src"}`;
-    FS.writeFileSync(file, Buffer.from(JSON.stringify(jsonContents, null, 2)));
-  }
-}
-
-module.exports = {
-  addSourceDir,
-};