@itwin/build-tools 3.1.0-dev.19 → 3.1.0-dev.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/build-tools",
-  "version": "3.1.0-dev.19",
+  "version": "3.1.0-dev.20",
   "description": "Bentley build tools",
   "license": "MIT",
   "repository": {
@@ -38,7 +38,7 @@
     "yargs": "^16.0.0"
   },
   "devDependencies": {
-    "@itwin/eslint-plugin": "3.1.0-dev.19",
+    "@itwin/eslint-plugin": "3.1.0-dev.20",
     "@types/node": "14.14.31",
     "eslint": "^7.11.0"
   },

package/scripts/docs.js

@@ -12,6 +12,7 @@ const cpx = require("cpx2");
 const fs = require("fs");
 const { spawn, handleInterrupts } = require("./utils/simpleSpawn");
 const { validateTags } = require("./utils/validateTags");
+const { addSourceDir } = require("./utils/addSourceDir");
 const argv = require("yargs").argv;
 
 // Makes the script crash on unhandled rejections instead of silently
@@ -88,6 +89,9 @@ spawn(require.resolve(".bin/typedoc"), args).then((code) => {
     cpx.copySync(path.join(process.cwd(), 'CHANGELOG.json'), outputDir);
   }
 
+  // Append the directory of the package to the output
+  addSourceDir(json, process.cwd());
+
   if (code === 0) {
     let tagErrors = validateTags(json);
     if (tagErrors.toString()) {

package/scripts/utils/addSourceDir.js

@@ -0,0 +1,22 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+
+const FS = require('fs-extra');
+const rootPackageJson = require('../../../../package.json');
+
+// Appends the directory of the package root to the Typedoc JSON output
+function addSourceDir(file, directory) {
+  if (FS.existsSync(file) && FS.statSync(file).isFile()) {
+    const contents = FS.readFileSync(file, 'utf-8');
+    let packageRoot = directory.substring(directory.indexOf(rootPackageJson.name) + rootPackageJson.name.length + 1);
+    let jsonContents = JSON.parse(contents);
+    jsonContents['packageRoot'] = packageRoot.endsWith('src') ? packageRoot : `${packageRoot}\\${'src'}`;
+    FS.writeFileSync(file, Buffer.from(JSON.stringify(jsonContents, null, 2)));
+  }
+}
+
+module.exports = {
+  addSourceDir
+};