Add support to generate full API summary report behind a flag

.gitignore

@@ -42,3 +42,5 @@ package-deps.json
 .DS_Store
 
 .env
+
+common/api/summary/summary.exports.csv

common/api/summary/README.md

@@ -1,4 +1,6 @@
-# Using Excel to Sort Exports Summary Report
+# Managing Summary Reports
+
+## Using Excel to Sort Exports of Individual Packages
 
 1. Open the appropriate `.csv` report file in Excel
 2. Double-click on the line between the **A** and **B** columns to auto-resize column **A**
@@ -9,3 +11,9 @@
 7. Press *Add Level*
 8. In *Then by* option button, select *API Item*
 9. Press *OK*
+
+## Creating the Full Summary API Report
+
+1. Delete any existing `common/api/summary/summary.exports.csv`
+    > The script will not overwrite any existing file
+2. Set the `GENERATE_FULL_API_REPORT` environment variable to create a `summary.exports.csv` file

common/changes/@bentley/build-tools/create-full-summary_2021-03-30-01-01.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/build-tools",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/build-tools",
+  "email": "31107829+calebmshafer@users.noreply.github.com"
+}

tools/build/scripts/extract-api-summary.js

@@ -28,18 +28,30 @@ if (undefined === argv.outDir) {
 
 fs.ensureDir(path.normalize(argv.outDir));
 
+let shouldGenerateFullReport = false;
+if (undefined !== argv.gatherFullReport)
+  shouldGenerateFullReport = true;
+
 // create output file
 const trimmedApiSignature = (argv.apiSignature.split('.'))[0];
 const sigFileName = path.basename(path.normalize(trimmedApiSignature));
-const sigFilePath = path.join(argv.outDir, sigFileName + ".exports.csv");
-fs.createFileSync(sigFilePath);
+const sigFilePath = path.join(argv.outDir, `${shouldGenerateFullReport ? "summary" : sigFileName}.exports.csv`);
 
 const outputLines = [];
-outputLines.push("sep=;");
-outputLines.push("Release Tag;API Item");
+if (shouldGenerateFullReport) {
+  if (fs.existsSync(sigFilePath))
+    outputLines.push("");
+  else {
+    outputLines.push("sep=;");
+    outputLines.push("Package Name;Release Tag;API Item");
+  }
+} else if (!shouldGenerateFullReport) {
+  fs.createFileSync(sigFilePath);
+  outputLines.push("sep=;");
+  outputLines.push("Release Tag;API Item");
+}
 
 // Open up the signature file
-
 fs.readFile(argv.apiSignature, function (error, data) {
   if (error) { throw error; }
 
@@ -52,7 +64,7 @@ fs.readFile(argv.apiSignature, function (error, data) {
       if (null !== matches) {
         const split = matches[1].split(/(<|extends|implements)/);
         for (const previousLine of previousLines)
-          outputLines.push(`${previousLine};${split[0]}`);
+          outputLines.push(shouldGenerateFullReport ? `${sigFileName};${previousLine};${split[0]}` : `${previousLine};${split[0]}`);
       }
 
       previousLines = [];
@@ -75,5 +87,5 @@ fs.readFile(argv.apiSignature, function (error, data) {
     }
   });
 
-  fs.writeFileSync(sigFilePath, outputLines.join("\n"));
+  shouldGenerateFullReport ? fs.appendFileSync(sigFilePath, outputLines.join("\n")) : fs.writeFileSync(sigFilePath, outputLines.join("\n"));
 });

tools/build/scripts/extract-api.js

@@ -125,5 +125,10 @@ spawn(require.resolve(".bin/api-extractor"), args).then((code) => {
   spawn("node", extractSummaryArgs).then((code) => {
     process.exit(code);
   });
+
+  if (process.env.GENERATE_FULL_API_REPORT)
+    spawn("node", [...extractSummaryArgs, "--gatherFullReport"]).then((code) => {
+      process.exit(code);
+    });
 });
 handleInterrupts();