@itwin/build-tools 4.9.0-dev.1 → 4.9.0-dev.10

package/CHANGELOG.md

@@ -1,6 +1,30 @@
 # Change Log - @itwin/build-tools
 
-This log was last generated on Wed, 31 Jul 2024 13:39:32 GMT and should not be manually modified.
+This log was last generated on Fri, 16 Aug 2024 18:19:52 GMT and should not be manually modified.
+
+## 4.8.3
+Fri, 16 Aug 2024 18:18:14 GMT
+
+_Version update only_
+
+## 4.8.2
+Thu, 15 Aug 2024 15:33:49 GMT
+
+_Version update only_
+
+## 4.8.1
+Mon, 12 Aug 2024 14:05:54 GMT
+
+_Version update only_
+
+## 4.8.0
+Thu, 08 Aug 2024 16:15:37 GMT
+
+### Updates
+
+- extract-api-summary: Improve regex so that includes all exports with improved output.
+- Update ThirdPartyNotices.md
+- Update api-extractor to 7.47.
 
 ## 4.7.8
 Wed, 31 Jul 2024 13:38:04 GMT

package/bin/betools.js

@@ -88,7 +88,11 @@ yargs.strict(true)
         },
         "apiSummaryFolder": {
           describe: "Directory for the API summary. Defaults to `<Rush repository root>/common/api/summary`."
-        }
+        },
+        "includeUnexportedApis": {
+          boolean: true,
+          describe: "If this flag is set, then APIs that are unexported, but still indirectly accessible via exported APIs, will also be included to the API report. Defaults to `false`"
+        },
       })
     },
     (argv) => { extractApiCommand(argv) })
@@ -161,7 +165,8 @@ function extractApiCommand(options) {
   const apiReportFolderOpt = options.apiReportFolder ? ["--apiReportFolder", options.apiReportFolder] : [];
   const apiReportTempFolderOpt = options.apiReportTempFolder ? ["--apiReportTempFolder", options.apiReportTempFolder] : [];
   const apiSummaryFolderOpt = options.apiSummaryFolder ? ["--apiSummaryFolder", options.apiSummaryFolder] : [];
-  exec("node", [getScriptPath("extract-api.js"), ...entryOpt, ...ignoreTagsOpt, ...apiReportFolderOpt, ...apiReportTempFolderOpt, ...apiSummaryFolderOpt]);
+  const includeUnexportedApisOpt = options.includeUnexportedApis ? ["--includeUnexportedApis"] : [];
+  exec("node", [getScriptPath("extract-api.js"), ...entryOpt, ...ignoreTagsOpt, ...apiReportFolderOpt, ...apiReportTempFolderOpt, ...apiSummaryFolderOpt, ...includeUnexportedApisOpt]);
 }
 
 function pseudolocalizeCommand(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/build-tools",
-  "version": "4.9.0-dev.1",
+  "version": "4.9.0-dev.10",
   "description": "Bentley build tools",
   "license": "MIT",
   "repository": {

package/scripts/extract-api-summary.js

@@ -34,7 +34,7 @@ if (undefined !== argv.gatherFullReport)
 
 // create output file
 const apiSignatureFileName = path.parse(argv.apiSignature).name;
-const sigFileName = (apiSignatureFileName.split('.'))[0]
+const sigFileName = apiSignatureFileName.substring(0, apiSignatureFileName.lastIndexOf('.'));
 const sigFilePath = path.join(argv.outDir, `${shouldGenerateFullReport ? "summary" : sigFileName}.exports.csv`);
 
 const outputLines = [];
@@ -43,12 +43,12 @@ if (shouldGenerateFullReport) {
     outputLines.push("");
   else {
     outputLines.push("sep=;");
-    outputLines.push("Package Name;Release Tag;API Item");
+    outputLines.push("Package Name;Release Tag;API Item Type;API Item Name");
   }
 } else {
   fs.createFileSync(sigFilePath);
   outputLines.push("sep=;");
-  outputLines.push("Release Tag;API Item");
+  outputLines.push("Release Tag;API Item Type;API Item Name");
 }
 
 // Open up the signature file
@@ -60,11 +60,12 @@ fs.readFile(argv.apiSignature, function (error, data) {
     if (index === arr.length - 1 && line === "") { return; }
 
     if (previousLines.length !== 0) {
-      const matches = line.match(/export \S*\s(.*)(\s{|;)/);
-      if (null !== matches) {
-        const split = matches[1].split(/(<|extends|implements)/);
-        for (const previousLine of previousLines)
-          outputLines.push(shouldGenerateFullReport ? `${sigFileName};${previousLine};${split[0]}` : `${previousLine};${split[0]}`);
+      const matches = line.match(/export.+?(class|interface|type|function|const|enum|namespace) (\w+)/);
+      if (matches) {
+        for (const previousLine of previousLines) {
+          const line = `${previousLine};${matches[1]};${matches[2]}`;
+          outputLines.push(shouldGenerateFullReport ? `${sigFileName};${line}` : line);
+        }
       }
 
       previousLines = [];

package/scripts/extract-api.js

@@ -18,6 +18,7 @@ if (argv.entry === undefined) {
 const isCI = (process.env.TF_BUILD);
 const entryPointFileName = argv.entry;
 const ignoreMissingTags = argv.ignoreMissingTags;
+const includeUnexportedApis = argv.includeUnexportedApis;
 
 // Resolves the root of the Rush repo
 const resolveRoot = relativePath => {
@@ -53,6 +54,7 @@ const config = {
     enabled: true,
     reportFolder: path.resolve(apiReportFolder),
     reportTempFolder: path.resolve(apiReportTempFolder),
+    includeForgottenExports: !!includeUnexportedApis,
   },
   docModel: {
     enabled: false