@itwin/build-tools 4.0.0-dev.96 → 4.0.0-dev.98

package/bin/betools.js

@@ -71,7 +71,7 @@ yargs.strict(true)
       })
     },
     (argv) => { extractCommand(argv) })
-  .command("extract-api", "Extracts the API of the Typescript library starting from an entry file with a default presets.  Powered by @microsoft/api-extractor (https://api-extractor.com)",
+  .command("extract-api", "Extracts the API of the Typescript library starting from an entry file with a default presets. Powered by @microsoft/api-extractor (https://api-extractor.com)",
     function (yargs) {
       return yargs.options({
         "entry": {
@@ -79,6 +79,15 @@ yargs.strict(true)
         },
         "ignoreMissingTags": {
           describe: "Turns off the 'ae-missing-release-tag' option which returns an error when a missing release tag is detected"
+        },
+        "apiReportFolder": {
+          describe: "Directory for the API report. Defaults to `<Rush repository root>/common/api`."
+        },
+        "apiReportTempFolder": {
+          describe: "Directory for the API report. Defaults to `<Rush repository root>/temp/api`."
+        },
+        "apiSummaryFolder": {
+          describe: "Directory for the API summary. Defaults to `<Rush repository root>/common/api/summary`."
         }
       })
     },
@@ -149,7 +158,10 @@ function extractCommand(options) {
 function extractApiCommand(options) {
   const entryOpt = options.entry ? ["--entry", options.entry] : [];
   const ignoreTagsOpt = options.ignoreMissingTags ? ["--ignoreMissingTags"] : [];
-  exec(["node", getScriptPath("extract-api.js"), ...entryOpt, ...ignoreTagsOpt]);
+  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]);
 }
 
 function pseudolocalizeCommand(options) {

package/package.json

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

package/scripts/extract-api.js

@@ -31,7 +31,16 @@ const resolveRoot = relativePath => {
   }
   process.stderr.write("Root of the Rush repository not found.  Missing a rush.json file?");
 };
-const rushCommon = resolveRoot("common");
+const rushCommon = () => {
+  let resolved;
+  if (!resolved)
+    resolved = resolveRoot("common");
+  return resolved;
+};
+
+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 config = {
   $schema: "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
@@ -42,8 +51,8 @@ const config = {
   mainEntryPointFilePath: `${entryPointFileName}.d.ts`,
   apiReport: {
     enabled: true,
-    reportFolder: path.resolve(path.join(rushCommon, "/api")),
-    reportTempFolder: path.resolve(path.join(rushCommon, "/temp/api")),
+    reportFolder: path.resolve(apiReportFolder),
+    reportTempFolder: path.resolve(apiReportTempFolder),
   },
   docModel: {
     enabled: false
@@ -94,7 +103,7 @@ const config = {
 };
 
 if (!fs.existsSync("lib")) {
-  process.stderr.write("lib folder not found. Run `rush build` before extract-api");
+  process.stderr.write("`lib` folder not found. Build the package(s) before running `extract-api`");
   process.exit(1);
 }
 
@@ -118,8 +127,8 @@ spawn(require.resolve(".bin/api-extractor"), args).then((code) => {
 
   const extractSummaryArgs = [
     path.resolve(__dirname, "extract-api-summary.js"),
-    "--apiSignature", path.resolve(path.join(rushCommon, `/api/${entryPointFileName}.api.md`)),
-    "--outDir", path.resolve(path.join(rushCommon, "/api/summary")),
+    "--apiSignature", path.resolve(path.join(apiReportFolder, `${entryPointFileName}.api.md`)),
+    "--outDir", path.resolve(apiSummaryFolder),
   ];
 
   spawn("node", extractSummaryArgs).then((code) => {