@itwin/build-tools 3.0.0-extension.1 → 3.1.0-dev.6

package/CHANGELOG.md

@@ -1,6 +1,81 @@
 # Change Log - @itwin/build-tools
 
-This log was last generated on Tue, 21 Sep 2021 21:06:40 GMT and should not be manually modified.
+This log was last generated on Wed, 12 Jan 2022 14:52:38 GMT and should not be manually modified.
+
+## 2.19.28
+Wed, 12 Jan 2022 14:52:38 GMT
+
+_Version update only_
+
+## 2.19.27
+Wed, 05 Jan 2022 20:07:20 GMT
+
+_Version update only_
+
+## 2.19.26
+Wed, 08 Dec 2021 20:54:52 GMT
+
+_Version update only_
+
+## 2.19.25
+Fri, 03 Dec 2021 20:05:49 GMT
+
+_Version update only_
+
+## 2.19.24
+Mon, 29 Nov 2021 18:44:31 GMT
+
+_Version update only_
+
+## 2.19.23
+Mon, 22 Nov 2021 20:41:39 GMT
+
+_Version update only_
+
+## 2.19.22
+Wed, 17 Nov 2021 01:23:26 GMT
+
+_Version update only_
+
+## 2.19.21
+Wed, 10 Nov 2021 10:58:24 GMT
+
+_Version update only_
+
+## 2.19.20
+Fri, 29 Oct 2021 16:14:22 GMT
+
+_Version update only_
+
+## 2.19.19
+Mon, 25 Oct 2021 16:16:25 GMT
+
+_Version update only_
+
+## 2.19.18
+Thu, 21 Oct 2021 20:59:44 GMT
+
+_Version update only_
+
+## 2.19.17
+Thu, 14 Oct 2021 21:19:43 GMT
+
+_Version update only_
+
+## 2.19.16
+Mon, 11 Oct 2021 17:37:46 GMT
+
+_Version update only_
+
+## 2.19.15
+Fri, 08 Oct 2021 16:44:23 GMT
+
+_Version update only_
+
+## 2.19.14
+Fri, 01 Oct 2021 13:07:03 GMT
+
+_Version update only_
 
 ## 2.19.13
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2021 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2022 Bentley Systems, Incorporated. All rights reserved.
 
 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:
 

package/bin/betools.js

@@ -107,7 +107,7 @@ function docsCommand(options) {
   const baseUrlOpt = options.baseUrl ? ["--baseUrl", options.baseUrl] : [];
   const includesOpt = options.includes ? ["--includes", options.includes] : [];
   const excludesOpt = options.excludes ? ["--excludes", options.excludes] : [];
-  const excludesGlobOpt = options.excludes ? ["--excludeGlob", options.excludeGlob] : [];
+  const excludesGlobOpt = options.excludeGlob ? ["--excludeGlob", options.excludeGlob] : [];
   const indexFileOpt = options.tsIndexFile ? ["--tsIndexFile", options.tsIndexFile] : [];
   const onlyJsonOpt = options.onlyJson ? ["--onlyJson"] : [];
   exec(["node", path.resolve(__dirname, "../scripts/docs.js"),

package/mocha-reporter/index.js

@@ -13,7 +13,7 @@ if (debugLeaks)
     require("wtfnode");
 const path = require("path");
 const fs = require("fs-extra");
-const { logBuildWarning, logBuildError, failBuild } = require("../scripts/rush/utils");
+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");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/build-tools",
-  "version": "3.0.0-extension.1",
+  "version": "3.1.0-dev.6",
   "description": "Bentley build tools",
   "license": "MIT",
   "repository": {
@@ -22,7 +22,7 @@
   "dependencies": {
     "@microsoft/api-extractor": "7.7.3",
     "chalk": "^3.0.0",
-    "cpx": "^1.5.0",
+    "cpx2": "^3.0.0",
     "cross-spawn": "^7.0.1",
     "fs-extra": "^8.1.0",
     "glob": "^7.1.2",
@@ -31,16 +31,14 @@
     "recursive-readdir": "^2.2.2",
     "rimraf": "^3.0.2",
     "tree-kill": "^1.2.0",
-    "tsconfig-paths": "^3.3.2",
-    "typedoc": "^0.16.8",
-    "typedoc-plugin-external-module-name": "3.0.0",
-    "typedoc-plugin-internal-external": "2.1.1",
+    "typedoc": "^0.22.11",
+    "typedoc-plugin-merge-modules": "^3.0.2",
     "typescript": "~4.4.0",
     "wtfnode": "^0.9.1",
     "yargs": "^16.0.0"
   },
   "devDependencies": {
-    "@itwin/eslint-plugin": "3.0.0-extension.1",
+    "@itwin/eslint-plugin": "3.1.0-dev.6",
     "@types/node": "14.14.31",
     "eslint": "^7.11.0"
   },
@@ -61,5 +59,6 @@
     "lint": "eslint -f visualstudio --config package.json --no-eslintrc \"./src/**/*.ts\" 1>&2",
     "test": "",
     "cover": ""
-  }
+  },
+  "readme": "# @itwin/build-tools\r\n\r\nCopyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.\r\n\r\n## Description\r\n\r\nThe **@itwin/build-tools** is a package for developers to consolidate the steps for building TypeScript-based packages. The tools contained in this package are written in either Typescript or Javascript within the src/ directory, and compiled for use into the lib/ directory. As a developer package, this package has only dependencies, no devDependencies.\r\n\r\n### tsconfig-base\r\n\r\nLocation: tsconfig-base.json\\\r\nRequires build: no\r\n\r\nThis file contains common tsconfig settings across all iTwin.js packages. Packages should extend this file in their own tsconfig.json file, and then overwrite and set new properties as needed. Note that this file is different from the tsconfig.json file for this package, as that contains different settings for bentleyjs-tools only.\r\n\r\n### NPM Scripts\r\n\r\nLocation: scripts/\\\r\nRequires build: no\r\n\r\nThe following node scripts are delivered in this package's scripts folder in order to ease development of iTwin.js packages with npm scripts. These scripts may require that additional packages be installed as dependencies of your package.\r\n\r\nThe default behaviors of the scripts (without parameters) assume that the directory structure of your package mirrors the following:\r\n\r\n- root\r\n  - source\r\n    - test\r\n      - assets\r\n  - lib\r\n  - package.json\r\n  - tsconfig.json\r\n\r\nThe following is a list of some of the most commonly used scripts within this package:\r\n\r\n#### docs.js\r\n\r\nThis script runs a TypeDoc command, with specific parameters, to generate html TypeScript documentation as well as a json representation of the documentation to be consumed for other purposes. It includes the following parameters:\r\n\r\n- source - specify the TypeScript source directory\r\n- out - specify the directory of the html output\r\n- json - specify the directory and filename of the json output\r\n- baseUrl - specify a baseUrl to resolve modules\r\n- onlyJson - including this option will skip the html output and only output the json file\r\n- includes - directory of files to include in documentation (ex: for sample code)\r\n- excludes - name of directory, files, or file extensions to exclude.\r\n  - A list can be provided using a `,` as a separator\r\n  - Each of the provided to exclude is added to a glob pattern which checks all directories within the source.\r\n    - i.e `--excludes=test,docs/*.md` will translate to `**/{test,docs/*.md}/**/*`\r\n\r\n#### extract.js\r\n\r\nThis is a script designed to extract sample code from test.ts files in a specific directory. The sample code should be surrounded by comments containing \"\\_\\_PUBLISH_EXTRACT_START\\_\\_\" and \"\\_\\_PUBLISH_EXTRACT_END\\_\\_\" directives.\r\n\r\n- extractDir - the path at which the sample code files are located\r\n- outDir - the path at which to output the selected code\r\n\r\n#### pseudolocalize.js\r\n\r\nThis script handles translating an English localization JSON file into a pseudoLocalization file.\r\n"
 }

package/scripts/docs.js

@@ -8,7 +8,7 @@ process.env.NODE_ENV = "prod";
 
 const paths = require("./config/paths");
 const path = require("path");
-const cpx = require("cpx");
+const cpx = require("cpx2");
 const fs = require("fs");
 const { spawn, handleInterrupts } = require("./utils/simpleSpawn");
 const { validateTags } = require("./utils/validateTags");
@@ -26,7 +26,6 @@ const out = (argv.out === undefined) ? paths.appDocs : argv.out;
 const json = (argv.json === undefined) ? paths.appJsonDocs : argv.json;
 
 const baseUrlOptions = (argv.baseUrl === undefined) ? [] : ["--baseUrl", argv.baseUrl];
-console.log("Input: " + argv)
 const includeOptions = (argv.includes === undefined) ? [] : ["--includes", argv.includes];
 
 let excludeList = "**/node_modules/**/*,**/*test*/**/*";
@@ -35,6 +34,10 @@ if (argv.excludes !== undefined)
 if (argv.excludeGlob !== undefined)
   excludeList += "," + argv.excludeGlob;
 
+excludeList = excludeList.replace(/,/g, ',--exclude,')
+const excludeArray = excludeList.split(",");
+excludeArray.unshift("--exclude");
+
 let outputOptions = [
   "--json", json
 ];
@@ -46,11 +49,14 @@ const readmeOption = (argv.readme === undefined) ? "none" : argv.readme;
 
 const options = [
   "--excludePrivate",
-  "--experimentalDecorators",
-  "--excludeExternals",
-  "--excludeNotExported",
-  "--ignoreCompilerErrors",
   "--hideGenerator",
+  "--logLevel",
+  "Error"
+];
+
+const pluginOptions = [
+  "--plugin", "typedoc-plugin-merge-modules",
+  "--mergeModulesMergeMode", "module",
 ];
 
 if (argv.name) options.push("--name", argv.name);
@@ -58,16 +64,12 @@ if (argv.name) options.push("--name", argv.name);
 if (argv.theme) options.push("--theme", argv.theme);
 
 const args = [
-  path.resolve(process.cwd(), source),
+  "--entryPointStrategy", "expand", path.resolve(process.cwd(), source),
   ...options,
-  "--exclude", [excludeList],
+  ...excludeArray,
   ...outputOptions,
-  "--mode", "modules",
   "--readme", readmeOption,
-  "--module", "commonjs",
-  "--plugin", "typedoc-plugin-external-module-name,typedoc-plugin-internal-external",
-  "--external-aliases", "alpha,internal",
-  "--internal-aliases", "UNUSED",
+  ...pluginOptions,
   ...baseUrlOptions,
   ...includeOptions
 ];

package/scripts/utils/validateTags.js

@@ -16,6 +16,8 @@ const validTags = [
   "default",
   "example",
   "pattern",
+  "returns",
+  "internal",
 
   // Following flags are added to support API-extractor (https://api-extractor.com/pages/tsdoc/syntax/#release-tags)
   "alpha",

package/scripts/rush/audit.js

@@ -1,100 +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");
-const path = require("path");
-const { spawn } = require("child_process");
-const { logBuildError, logBuildWarning, failBuild, throwAfterTimeout } = require("./utils");
-
-const rushCommonDir = path.join(__dirname, "../../../../common/");
-
-(async () => {
-  const commonTempDir = path.join(rushCommonDir, "config/rush");
-
-  // Npm audit will occasionally take minutes to respond - we believe this is just the npm registry being terrible and slow.
-  // We don't want this to slow down our builds though - we'd rather fail fast and try again later.  So we'll just timeout after 30 seconds.
-  let jsonOut = {};
-  try {
-    console.time("Audit time");
-    jsonOut = await Promise.race([runPnpmAuditAsync(commonTempDir), throwAfterTimeout(180000, "Timed out contacting npm registry.")]);
-    console.timeEnd("Audit time");
-    console.log();
-  } catch (error) {
-    // We want to stop failing the build on transient failures and instead fail only on high/critical vulnerabilities.
-    logBuildWarning(error);
-    process.exit();
-  }
-
-  if (jsonOut.error) {
-    console.error(jsonOut.error.summary);
-    logBuildWarning("Rush audit failed. This may be caused by a problem with the npm audit server.");
-  }
-
-  // A list of temporary advisories excluded from the High and Critical list.
-  // Warning this should only be used as a temporary measure to avoid build failures
-  // for development dependencies only.
-  // All security issues should be addressed asap.
-  const excludedAdvisories = [
-    "GHSA-8p5q-j9m2-g8wr", // https://github.com/advisories/GHSA-8p5q-j9m2-g8wr.
-    "GHSA-ww39-953v-wcq6", // https://github.com/advisories/GHSA-ww39-953v-wcq6.
-    "GHSA-8v27-2fg9-7h62", // https://github.com/advisories/GHSA-8v27-2fg9-7h62.
-    "GHSA-33f9-j839-rf8h", // https://github.com/advisories/GHSA-33f9-j839-rf8h.
-    "GHSA-c36v-fmgq-m8hx", // https://github.com/advisories/GHSA-c36v-fmgq-m8hx.
-    "GHSA-4jqc-8m5r-9rpr", // https://github.com/advisories/GHSA-4jqc-8m5r-9rpr.
-    "GHSA-whgm-jr23-g3j9", // https://github.com/advisories/GHSA-whgm-jr23-g3j9.
-  ];
-
-  let shouldFailBuild = false;
-  for (const action of jsonOut.actions) {
-    for (const issue of action.resolves) {
-      const advisory = jsonOut.advisories[issue.id];
-
-      // TODO: This path no longer resolves to a specific package in the repo.  Need to figure out the best way to handle it
-      const mpath = issue.path; // .replace("@rush-temp", "@bentley");
-
-      const severity = advisory.severity.toUpperCase();
-      const message = `${severity} Security Vulnerability: ${advisory.title} in ${advisory.module_name} (from ${mpath}).  See ${advisory.url} for more info.`;
-
-      // For now, we'll only treat CRITICAL and HIGH vulnerabilities as errors in CI builds.
-      if (!excludedAdvisories.includes(advisory.github_advisory_id) && (severity === "HIGH" || severity === "CRITICAL")) {
-        logBuildError(message);
-        shouldFailBuild = true;
-      } else if (excludedAdvisories.includes(advisory.github_advisory_id) || severity === "MODERATE") // Only warn on MODERATE severity items
-        logBuildWarning(message);
-    }
-  }
-
-  // For some reason yarn audit can return the json without the vulnerabilities
-  if (undefined === jsonOut.metadata.vulnerabilities || shouldFailBuild)
-    failBuild();
-
-  process.exit();
-})();
-
-function runPnpmAuditAsync(cwd) {
-  return new Promise((resolve, reject) => {
-    // pnpm audit requires a package.json file so we temporarily create one and
-    // then delete it later
-    fs.writeFileSync(path.join(rushCommonDir, "config/rush/package.json"), JSON.stringify("{}", null, 2));
-
-    console.log("Running audit");
-    const pnpmPath = path.join(rushCommonDir, "temp/pnpm-local/node_modules/.bin/pnpm");
-    const child = spawn(pnpmPath, ["audit", "--json"], { cwd, shell: true });
-
-    let stdout = "";
-    child.stdout.on('data', (data) => {
-      stdout += data;
-    });
-
-    child.on('error', (data) => {
-      fs.unlinkSync(path.join(rushCommonDir, "config/rush/package.json"));
-      reject(data)
-    });
-    child.on('close', () => {
-      fs.unlinkSync(path.join(rushCommonDir, "config/rush/package.json"));
-      resolve(JSON.parse(stdout.trim()));
-    });
-  });
-}