@itwin/build-tools 3.0.0-dev.84 → 3.0.0-dev.85

package/scripts/docs.js

@@ -1,100 +1,100 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-"use strict";
-
-process.env.NODE_ENV = "prod";
-
-const paths = require("./config/paths");
-const path = require("path");
-const cpx = require("cpx");
-const fs = require("fs");
-const { spawn, handleInterrupts } = require("./utils/simpleSpawn");
-const { validateTags } = require("./utils/validateTags");
-const argv = require("yargs").argv;
-
-// Makes the script crash on unhandled rejections instead of silently
-// ignoring them. In the future, promise rejections that are not handled will
-// terminate the Node.js process with a non-zero exit code.
-process.on("unhandledRejection", err => {
-  throw err;
-});
-
-const source = (argv.source === undefined) ? paths.appSrc : argv.source;
-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*/**/*";
-if (argv.excludes !== undefined)
-  excludeList += ",**/" + argv.excludes + "/**/*";
-if (argv.excludeGlob !== undefined)
-  excludeList += "," + argv.excludeGlob;
-
-let outputOptions = [
-  "--json", json
-];
-
-if (argv.onlyJson === undefined)
-  outputOptions = outputOptions.concat(["--out", out]);
-
-const readmeOption = (argv.readme === undefined) ? "none" : argv.readme;
-
-const options = [
-  "--excludePrivate",
-  "--experimentalDecorators",
-  "--excludeExternals",
-  "--excludeNotExported",
-  "--ignoreCompilerErrors",
-  "--hideGenerator",
-];
-
-if (argv.name) options.push("--name", argv.name);
-
-if (argv.theme) options.push("--theme", argv.theme);
-
-const args = [
-  path.resolve(process.cwd(), source),
-  ...options,
-  "--exclude", [excludeList],
-  ...outputOptions,
-  "--mode", "modules",
-  "--readme", readmeOption,
-  "--module", "commonjs",
-  "--plugin", "typedoc-plugin-external-module-name,typedoc-plugin-internal-external",
-  "--external-aliases", "alpha,internal",
-  "--internal-aliases", "UNUSED",
-  ...baseUrlOptions,
-  ...includeOptions
-];
-
-console.log("Arguments to TypeDoc: " + JSON.stringify(args, null, 2));
-
-spawn(require.resolve(".bin/typedoc"), args).then((code) => {
-  // Copy index.ts file to json output folder and rename to index.ts if a file is specified. Needed to add descriptions within the barrel file.
-  const outputDir = path.parse(json).dir;
-  if (argv.tsIndexFile) {
-    cpx.copySync(path.join(source, argv.tsIndexFile), outputDir);
-    fs.renameSync(path.join(outputDir, argv.tsIndexFile), path.join(outputDir, 'index.ts'));
-  }
-  // Copy CHANGELOG.json to json output folder
-  if (fs.existsSync(path.join(process.cwd(), 'CHANGELOG.json'))) {
-    cpx.copySync(path.join(process.cwd(), 'CHANGELOG.json'), outputDir);
-  }
-
-  if (code === 0) {
-    let tagErrors = validateTags(json);
-    if (tagErrors.toString()) {
-      console.error(`JSON contains invalid tags: ${JSON.stringify(tagErrors)}`);
-      fs.unlink(json);
-      console.log(`JSON removed from ${json}`)
-      code = 5;
-    }
-  }
-  process.exit(code)
-});
-handleInterrupts();
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+"use strict";
+
+process.env.NODE_ENV = "prod";
+
+const paths = require("./config/paths");
+const path = require("path");
+const cpx = require("cpx");
+const fs = require("fs");
+const { spawn, handleInterrupts } = require("./utils/simpleSpawn");
+const { validateTags } = require("./utils/validateTags");
+const argv = require("yargs").argv;
+
+// Makes the script crash on unhandled rejections instead of silently
+// ignoring them. In the future, promise rejections that are not handled will
+// terminate the Node.js process with a non-zero exit code.
+process.on("unhandledRejection", err => {
+  throw err;
+});
+
+const source = (argv.source === undefined) ? paths.appSrc : argv.source;
+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*/**/*";
+if (argv.excludes !== undefined)
+  excludeList += ",**/" + argv.excludes + "/**/*";
+if (argv.excludeGlob !== undefined)
+  excludeList += "," + argv.excludeGlob;
+
+let outputOptions = [
+  "--json", json
+];
+
+if (argv.onlyJson === undefined)
+  outputOptions = outputOptions.concat(["--out", out]);
+
+const readmeOption = (argv.readme === undefined) ? "none" : argv.readme;
+
+const options = [
+  "--excludePrivate",
+  "--experimentalDecorators",
+  "--excludeExternals",
+  "--excludeNotExported",
+  "--ignoreCompilerErrors",
+  "--hideGenerator",
+];
+
+if (argv.name) options.push("--name", argv.name);
+
+if (argv.theme) options.push("--theme", argv.theme);
+
+const args = [
+  path.resolve(process.cwd(), source),
+  ...options,
+  "--exclude", [excludeList],
+  ...outputOptions,
+  "--mode", "modules",
+  "--readme", readmeOption,
+  "--module", "commonjs",
+  "--plugin", "typedoc-plugin-external-module-name,typedoc-plugin-internal-external",
+  "--external-aliases", "alpha,internal",
+  "--internal-aliases", "UNUSED",
+  ...baseUrlOptions,
+  ...includeOptions
+];
+
+console.log("Arguments to TypeDoc: " + JSON.stringify(args, null, 2));
+
+spawn(require.resolve(".bin/typedoc"), args).then((code) => {
+  // Copy index.ts file to json output folder and rename to index.ts if a file is specified. Needed to add descriptions within the barrel file.
+  const outputDir = path.parse(json).dir;
+  if (argv.tsIndexFile) {
+    cpx.copySync(path.join(source, argv.tsIndexFile), outputDir);
+    fs.renameSync(path.join(outputDir, argv.tsIndexFile), path.join(outputDir, 'index.ts'));
+  }
+  // Copy CHANGELOG.json to json output folder
+  if (fs.existsSync(path.join(process.cwd(), 'CHANGELOG.json'))) {
+    cpx.copySync(path.join(process.cwd(), 'CHANGELOG.json'), outputDir);
+  }
+
+  if (code === 0) {
+    let tagErrors = validateTags(json);
+    if (tagErrors.toString()) {
+      console.error(`JSON contains invalid tags: ${JSON.stringify(tagErrors)}`);
+      fs.unlink(json);
+      console.log(`JSON removed from ${json}`)
+      code = 5;
+    }
+  }
+  process.exit(code)
+});
+handleInterrupts();

package/scripts/extract-api.js

@@ -1,134 +1,134 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-"use strict";
-
-const { spawn, handleInterrupts } = require("./utils/simpleSpawn");
-const argv = require("yargs").argv;
-const fs = require("fs-extra");
-const path = require("path");
-const paths = require("./config/paths");
-
-if (argv.entry === undefined) {
-  console.log("No argument found");
-  return;
-}
-
-const isCI = (process.env.TF_BUILD);
-const entryPointFileName = argv.entry;
-const ignoreMissingTags = argv.ignoreMissingTags;
-
-// Resolves the root of the Rush repo
-const resolveRoot = relativePath => {
-  // recurse until you find the "rush.json"
-  const parts = paths.appSrc.split(path.sep).reverse();
-  while (parts.length > 0) {
-    const resolved = path.join(parts.slice().reverse().join(path.sep), "rush.json");
-    if (fs.existsSync(resolved))
-      return path.join(parts.slice().reverse().join(path.sep), relativePath);
-    parts.shift();
-  }
-  process.stderr.write("Root of the Rush repository not found.  Missing a rush.json file?");
-};
-const rushCommon = resolveRoot("common");
-
-const config = {
-  $schema: "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  projectFolder: "../../",
-  compiler: {
-    tsconfigFilePath: "<projectFolder>/tsconfig.json"
-  },
-  mainEntryPointFilePath: `${entryPointFileName}.d.ts`,
-  apiReport: {
-    enabled: true,
-    reportFolder: path.resolve(path.join(rushCommon, "/api")),
-    reportTempFolder: path.resolve(path.join(rushCommon, "/temp/api")),
-  },
-  docModel: {
-    enabled: false
-  },
-  dtsRollup: {
-    enabled: false
-  },
-  tsdocMetadata: {
-    enabled: false
-  },
-  messages: {
-    tsdocMessageReporting: {
-      default: {
-        logLevel: "none"
-      }
-    },
-    extractorMessageReporting: {
-      default: {
-        logLevel: "error",
-        addToApiReportFile: false
-      },
-      "ae-incompatible-release-tags": {
-        logLevel: "error",
-        addToApiReportFile: false
-      },
-      "ae-missing-release-tag": {
-        logLevel: ignoreMissingTags ? "none" : "error",
-        addToApiReportFile: false
-      },
-      "ae-internal-missing-underscore": {
-        logLevel: "none",
-        addToApiReportFile: false
-      },
-      "ae-forgotten-export": {
-        logLevel: "none",
-        addToApiReportFile: false
-      },
-      "ae-unresolved-inheritdoc-reference": {
-        logLevel: "error",
-        addToApiReportFile: true
-      },
-      "ae-unresolved-inheritdoc-base": {
-        logLevel: "error",
-        addToApiReportFile: true
-      }
-    }
-  }
-};
-
-if (!fs.existsSync("lib")) {
-  process.stderr.write("lib folder not found. Run `rush build` before extract-api");
-  process.exit(1);
-}
-
-const configFileName = `lib/cjs/${entryPointFileName}.json`;
-fs.writeFileSync(configFileName, JSON.stringify(config, null, 2));
-
-const args = [
-  "run",
-  "-c", configFileName
-];
-if (!isCI)
-  args.push("-l");
-
-spawn(require.resolve(".bin/api-extractor"), args).then((code) => {
-  if (fs.existsSync(configFileName))
-    fs.unlinkSync(configFileName);
-
-  // Only generate the extraction of the summary locally.
-  if (isCI)
-    process.exit(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")),
-  ];
-
-  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();
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+"use strict";
+
+const { spawn, handleInterrupts } = require("./utils/simpleSpawn");
+const argv = require("yargs").argv;
+const fs = require("fs-extra");
+const path = require("path");
+const paths = require("./config/paths");
+
+if (argv.entry === undefined) {
+  console.log("No argument found");
+  return;
+}
+
+const isCI = (process.env.TF_BUILD);
+const entryPointFileName = argv.entry;
+const ignoreMissingTags = argv.ignoreMissingTags;
+
+// Resolves the root of the Rush repo
+const resolveRoot = relativePath => {
+  // recurse until you find the "rush.json"
+  const parts = paths.appSrc.split(path.sep).reverse();
+  while (parts.length > 0) {
+    const resolved = path.join(parts.slice().reverse().join(path.sep), "rush.json");
+    if (fs.existsSync(resolved))
+      return path.join(parts.slice().reverse().join(path.sep), relativePath);
+    parts.shift();
+  }
+  process.stderr.write("Root of the Rush repository not found.  Missing a rush.json file?");
+};
+const rushCommon = resolveRoot("common");
+
+const config = {
+  $schema: "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  projectFolder: "../../",
+  compiler: {
+    tsconfigFilePath: "<projectFolder>/tsconfig.json"
+  },
+  mainEntryPointFilePath: `${entryPointFileName}.d.ts`,
+  apiReport: {
+    enabled: true,
+    reportFolder: path.resolve(path.join(rushCommon, "/api")),
+    reportTempFolder: path.resolve(path.join(rushCommon, "/temp/api")),
+  },
+  docModel: {
+    enabled: false
+  },
+  dtsRollup: {
+    enabled: false
+  },
+  tsdocMetadata: {
+    enabled: false
+  },
+  messages: {
+    tsdocMessageReporting: {
+      default: {
+        logLevel: "none"
+      }
+    },
+    extractorMessageReporting: {
+      default: {
+        logLevel: "error",
+        addToApiReportFile: false
+      },
+      "ae-incompatible-release-tags": {
+        logLevel: "error",
+        addToApiReportFile: false
+      },
+      "ae-missing-release-tag": {
+        logLevel: ignoreMissingTags ? "none" : "error",
+        addToApiReportFile: false
+      },
+      "ae-internal-missing-underscore": {
+        logLevel: "none",
+        addToApiReportFile: false
+      },
+      "ae-forgotten-export": {
+        logLevel: "none",
+        addToApiReportFile: false
+      },
+      "ae-unresolved-inheritdoc-reference": {
+        logLevel: "error",
+        addToApiReportFile: true
+      },
+      "ae-unresolved-inheritdoc-base": {
+        logLevel: "error",
+        addToApiReportFile: true
+      }
+    }
+  }
+};
+
+if (!fs.existsSync("lib")) {
+  process.stderr.write("lib folder not found. Run `rush build` before extract-api");
+  process.exit(1);
+}
+
+const configFileName = `lib/cjs/${entryPointFileName}.json`;
+fs.writeFileSync(configFileName, JSON.stringify(config, null, 2));
+
+const args = [
+  "run",
+  "-c", configFileName
+];
+if (!isCI)
+  args.push("-l");
+
+spawn(require.resolve(".bin/api-extractor"), args).then((code) => {
+  if (fs.existsSync(configFileName))
+    fs.unlinkSync(configFileName);
+
+  // Only generate the extraction of the summary locally.
+  if (isCI)
+    process.exit(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")),
+  ];
+
+  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();

package/scripts/extract.js

@@ -1,72 +1,72 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-"use strict";
-
-const argv = require("yargs").argv;
-const path = require("path");
-const paths = require("./config/paths");
-const fs = require("fs-extra");
-const readDirectory = require("recursive-readdir");
-
-const __PUBLISH_EXTRACT_START__ = "__PUBLISH_EXTRACT_START__";
-const __PUBLISH_EXTRACT_END__ = "__PUBLISH_EXTRACT_END__";
-
-const extractDir = (argv.extractFrom === undefined) ? paths.appTest : argv.extractFrom;
-const outDir = (argv.out === undefined) ? paths.libExtract : argv.out;
-const fileExt = (argv.fileExt === undefined) ? ["test.ts"] : argv.fileExt.split(",");
-const recursive = (argv.recursive === undefined) ? false : true;
-
-const ignoreFunction = (file, stats) => {
-  if (stats.isDirectory())
-    return !recursive; // don't ignore subdirectories in recursive mode
-  return !fileExt.some((ext) => file.endsWith(ext)); // don't ignore files with desired extensions
-};
-
-readDirectory(extractDir, [ignoreFunction], (error, inputFileNames) => {
-  for (const inputFileName of inputFileNames) {
-    const inputFileContents = fs.readFileSync(inputFileName, "utf8");
-
-    // Skip the file if there are no occurences of the starting comment.
-    if (inputFileContents.indexOf(__PUBLISH_EXTRACT_START__) <= 0)
-      continue;
-
-    console.log("Processing: " + inputFileName);
-    const inputLines = inputFileContents.split("\n");
-    let outputFileName = undefined;
-    let outputLines = [];
-    let startIndent = 0;
-
-    for (const inputLine of inputLines) {
-      const startIndex = inputLine.indexOf(__PUBLISH_EXTRACT_START__);
-      if (startIndex > 0) {
-        startIndent = startIndex - 3;
-        if (outputFileName)
-          throw new Error("Nested " + __PUBLISH_EXTRACT_START__);
-
-        outputFileName = inputLine.substring(startIndex + __PUBLISH_EXTRACT_START__.length).trim();
-        if (0 === outputFileName.length)
-          throw new Error("Expected output file name after " + __PUBLISH_EXTRACT_START__);
-      } else if (inputLine.indexOf(__PUBLISH_EXTRACT_END__) > 0) {
-        if (!outputFileName)
-          throw new Error("Missing " + __PUBLISH_EXTRACT_START__);
-
-        if (!fs.existsSync(outDir))
-          fs.ensureDirSync(outDir);
-
-        const outputFilePath = path.join(outDir, outputFileName);
-        console.log("> Extracting into: " + outputFilePath);
-        fs.writeFileSync(outputFilePath, outputLines.join("\n"));
-
-        outputFileName = undefined;
-        outputLines = [];
-      } else if (outputFileName) {
-        outputLines.push(inputLine.substring(startIndent).replace(/\s+$/gm, ""));
-      }
-    }
-
-    if (outputFileName)
-      throw new Error("Missing " + __PUBLISH_EXTRACT_END__);
-  }
-});
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+"use strict";
+
+const argv = require("yargs").argv;
+const path = require("path");
+const paths = require("./config/paths");
+const fs = require("fs-extra");
+const readDirectory = require("recursive-readdir");
+
+const __PUBLISH_EXTRACT_START__ = "__PUBLISH_EXTRACT_START__";
+const __PUBLISH_EXTRACT_END__ = "__PUBLISH_EXTRACT_END__";
+
+const extractDir = (argv.extractFrom === undefined) ? paths.appTest : argv.extractFrom;
+const outDir = (argv.out === undefined) ? paths.libExtract : argv.out;
+const fileExt = (argv.fileExt === undefined) ? ["test.ts"] : argv.fileExt.split(",");
+const recursive = (argv.recursive === undefined) ? false : true;
+
+const ignoreFunction = (file, stats) => {
+  if (stats.isDirectory())
+    return !recursive; // don't ignore subdirectories in recursive mode
+  return !fileExt.some((ext) => file.endsWith(ext)); // don't ignore files with desired extensions
+};
+
+readDirectory(extractDir, [ignoreFunction], (error, inputFileNames) => {
+  for (const inputFileName of inputFileNames) {
+    const inputFileContents = fs.readFileSync(inputFileName, "utf8");
+
+    // Skip the file if there are no occurences of the starting comment.
+    if (inputFileContents.indexOf(__PUBLISH_EXTRACT_START__) <= 0)
+      continue;
+
+    console.log("Processing: " + inputFileName);
+    const inputLines = inputFileContents.split("\n");
+    let outputFileName = undefined;
+    let outputLines = [];
+    let startIndent = 0;
+
+    for (const inputLine of inputLines) {
+      const startIndex = inputLine.indexOf(__PUBLISH_EXTRACT_START__);
+      if (startIndex > 0) {
+        startIndent = startIndex - 3;
+        if (outputFileName)
+          throw new Error("Nested " + __PUBLISH_EXTRACT_START__);
+
+        outputFileName = inputLine.substring(startIndex + __PUBLISH_EXTRACT_START__.length).trim();
+        if (0 === outputFileName.length)
+          throw new Error("Expected output file name after " + __PUBLISH_EXTRACT_START__);
+      } else if (inputLine.indexOf(__PUBLISH_EXTRACT_END__) > 0) {
+        if (!outputFileName)
+          throw new Error("Missing " + __PUBLISH_EXTRACT_START__);
+
+        if (!fs.existsSync(outDir))
+          fs.ensureDirSync(outDir);
+
+        const outputFilePath = path.join(outDir, outputFileName);
+        console.log("> Extracting into: " + outputFilePath);
+        fs.writeFileSync(outputFilePath, outputLines.join("\n"));
+
+        outputFileName = undefined;
+        outputLines = [];
+      } else if (outputFileName) {
+        outputLines.push(inputLine.substring(startIndent).replace(/\s+$/gm, ""));
+      }
+    }
+
+    if (outputFileName)
+      throw new Error("Missing " + __PUBLISH_EXTRACT_END__);
+  }
+});