@itwin/build-tools 4.10.0-dev.9 → 4.10.1

package/CHANGELOG.md

@@ -1,6 +1,41 @@
 # Change Log - @itwin/build-tools
 
-This log was last generated on Wed, 25 Sep 2024 20:12:30 GMT and should not be manually modified.
+This log was last generated on Thu, 14 Nov 2024 18:11:00 GMT and should not be manually modified.
+
+## 4.10.1
+Thu, 14 Nov 2024 18:11:00 GMT
+
+### Updates
+
+- Bump `typedoc` dependency to a version that supports typescript `5.6`.
+- Deprecate  unused --includes flag
+
+## 4.10.0
+Wed, 13 Nov 2024 15:23:38 GMT
+
+### Updates
+
+- Allow specifying a relative directory for the `entry` argument in the `extract-api` command.
+
+## 4.9.5
+Tue, 22 Oct 2024 20:01:40 GMT
+
+_Version update only_
+
+## 4.9.4
+Wed, 09 Oct 2024 20:22:04 GMT
+
+_Version update only_
+
+## 4.9.3
+Thu, 03 Oct 2024 19:15:45 GMT
+
+_Version update only_
+
+## 4.9.2
+Wed, 02 Oct 2024 15:14:43 GMT
+
+_Version update only_
 
 ## 4.9.1
 Wed, 25 Sep 2024 20:10:58 GMT

package/bin/betools.js

@@ -32,7 +32,7 @@ yargs.strict(true)
           describe: "Specify a baseUrl to resolve modules"
         },
         "includes": {
-          describe: "Specify a baseUrl to resolve modules"
+          describe: "Deprecated - this flag does nothing and will be removed in @itwin/build-tools 5.x"
         },
         "excludes": {
           describe: "Specify a directory, filename, or pattern to be excluded"
@@ -140,14 +140,13 @@ function docsCommand(options) {
   const outOpt = options.out ? ["--out", options.out] : [];
   const jsonOpt = options.json ? ["--json", options.json] : [];
   const baseUrlOpt = options.baseUrl ? ["--baseUrl", options.baseUrl] : [];
-  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,
+  ...sourceOpt, ...outOpt, ...jsonOpt, ...baseUrlOpt,
   ...excludesOpt, ...excludesGlobOpt, ...testExcludeGlobOpt, ...indexFileOpt, ...onlyJsonOpt]);
 }
 

package/mocha-reporter/index.js

@@ -4,7 +4,7 @@
 * 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 @typescript-eslint/no-require-imports */
 /* eslint-disable no-console */
 const debugLeaks = process.env.DEBUG_LEAKS;
 let asyncResourceStats;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/build-tools",
-  "version": "4.10.0-dev.9",
+  "version": "4.10.1",
   "description": "Bentley build tools",
   "license": "MIT",
   "repository": {
@@ -21,7 +21,7 @@
     "url": "http://www.bentley.com"
   },
   "dependencies": {
-    "@microsoft/api-extractor": "~7.47.0",
+    "@microsoft/api-extractor": "~7.47.10",
     "chalk": "^3.0.0",
     "cpx2": "^3.0.0",
     "cross-spawn": "^7.0.1",
@@ -31,22 +31,22 @@
     "mocha-junit-reporter": "^2.0.2",
     "rimraf": "^3.0.2",
     "tree-kill": "^1.2.2",
-    "typedoc": "^0.25.8",
-    "typedoc-plugin-merge-modules": "^5.1.0",
-    "typescript": "~5.3.3",
+    "typedoc": "^0.26.11",
+    "typedoc-plugin-merge-modules": "^6.0.3",
+    "typescript": "~5.6.2",
     "wtfnode": "^0.9.1",
     "yargs": "^17.4.0"
   },
   "devDependencies": {
-    "@itwin/eslint-plugin": "^4.0.2",
+    "@itwin/eslint-plugin": "5.0.0-dev.1",
     "@types/node": "~18.16.20",
-    "eslint": "^8.56.0"
+    "eslint": "^9.13.0"
   },
   "scripts": {
     "build": "tsc 1>&2",
     "clean": "rimraf ../../modules .rush/temp/package-deps*.json",
     "docs": "",
-    "lint": "eslint -f visualstudio \"./src/**/*.ts\" 1>&2",
+    "lint": "eslint \"./src/**/*.ts\" 1>&2",
     "test": "",
     "cover": ""
   }

package/scripts/docs.js

@@ -27,7 +27,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];
-const includeOptions = (argv.includes === undefined) ? [] : ["--includes", argv.includes];
 
 const testExclude = argv.testExcludeGlob ?? "**/*test*/**/*";
 const excludeInternalFolders = "**/internal/**/*"
@@ -51,7 +50,6 @@ if (argv.onlyJson === undefined)
 const readmeOption = (argv.readme === undefined) ? "none" : argv.readme;
 
 const options = [
-  "--excludePrivate",
   "--hideGenerator",
   "--logLevel",
   "Error"
@@ -74,7 +72,6 @@ const args = [
   "--readme", readmeOption,
   ...pluginOptions,
   ...baseUrlOptions,
-  ...includeOptions
 ];
 
 console.log("Arguments to TypeDoc: " + JSON.stringify(args, null, 2));

package/scripts/extract-api.js

@@ -15,8 +15,14 @@ if (argv.entry === undefined) {
   return;
 }
 
+function getEntryPointDirName(){
+  const dirname = path.dirname(argv.entry);
+  return dirname === "." ? "./lib/cjs" : dirname;
+};
+
 const isCI = (process.env.TF_BUILD);
-const entryPointFileName = argv.entry;
+const entryPointFileName = path.basename(argv.entry);
+const entryPointDirName = getEntryPointDirName();
 const ignoreMissingTags = argv.ignoreMissingTags;
 const includeUnexportedApis = argv.includeUnexportedApis;
 
@@ -43,9 +49,11 @@ const apiReportFolder = argv.apiReportFolder ?? path.join(rushCommon(), "/api");
 const apiReportTempFolder = argv.apiReportTempFolder ?? path.join(rushCommon(), "/temp/api");
 const apiSummaryFolder = argv.apiSummaryFolder ?? path.join(rushCommon(), "/api/summary");
 
+const appDir = path.join(paths.appSrc, "..");
+const projectFolder = path.relative(entryPointDirName, appDir);
 const config = {
   $schema: "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  projectFolder: "../../",
+  projectFolder,
   compiler: {
     tsconfigFilePath: "<projectFolder>/tsconfig.json"
   },
@@ -104,12 +112,12 @@ const config = {
   }
 };
 
-if (!fs.existsSync("lib")) {
-  process.stderr.write("`lib` folder not found. Build the package(s) before running `extract-api`");
+if (!fs.existsSync(entryPointDirName)) {
+  process.stderr.write(`\`${entryPointDirName}\` folder not found. Build the package(s) before running \`extract-api\``);
   process.exit(1);
 }
 
-const configFileName = `lib/cjs/${entryPointFileName}.json`;
+const configFileName = path.format({ dir: entryPointDirName, name: entryPointFileName, ext: ".json" });
 fs.writeFileSync(configFileName, JSON.stringify(config, null, 2));
 
 const args = [