Add metadata to documented interfaces

Author: ShukantPal

example/example.api.json

@@ -23,7 +23,7 @@
   },
   "scripts": {
     "unit-test": "",
-    "build": "webdoc --tutorials ./tutorials --site-root example-documentation  --site-domain https://webdoc-labs.github.io",
+    "build": "webdoc --tutorials ./tutorials --site-root example-documentation --site-domain https://webdoc-labs.github.io --verbose",
     "build-next": "cd .. && webdoc && cd example",
     "build-pixi-api": "cd ../../pixi-api && webdoc && cd ../webdoc/example",
     "build-pixi-api-prod": "cd ../../pixi-api && webdoc --site-root pixi-api && cd ../webdoc/example",

example/package.json

@@ -122,6 +122,10 @@ async function main(argv: yargs.Argv) {
   const documentedInterface = external.fromTree(documentTree);
   const db = exportTaffy(documentTree);
 
+  documentedInterface.metadata.linker = "(unsigned)";
+  documentedInterface.metadata.siteDomain = config.template.siteDomain;
+  documentedInterface.metadata.siteRoot = config.template.siteRoot;
+
   const _path = `${getTemplate(config)}/publish`;
   // $FlowFixMe[unsupported-syntax]
   const template = require(_path);

packages/webdoc-cli/src/index.js

@@ -14,11 +14,7 @@ import type {
   RootDoc,
   DocType,
 } from "@webdoc/types";
-
-import type {
-  LinkTable,
-} from "@webdoc/template-library";
-
+import type {DocumentedInterface} from "@webdoc/externalize";
 import type {ExplorerTarget} from './crawl-reference-explorer';
 
 export type CategorizedDocumentList = {
@@ -34,9 +30,13 @@ export type CrawlData = {
 declare function crawl(tree: RootDoc, index: string): CrawlData;
 */
 
+function crawl(
+  documentedInterface /*: DocumentedInterface */,
+  index /*: string */,
+)/*: CrawlData */ {
+  const tree = documentedInterface.root;
 
-function crawl(tree /*: RootDoc */, index /*: string */)/*: CrawlData */ {
-  buildLinks(tree);
+  buildLinks(documentedInterface);
 
   const crawlData /*: CrawlData */ = {
     index: buildIndex(tree),
@@ -46,7 +46,7 @@ function crawl(tree /*: RootDoc */, index /*: string */)/*: CrawlData */ {
 
   if (crawlData.reference) {
     // Add ClassIndex into explorer after (overview), while preserving order
-    // $FlowFixMe
+    // $FlowFixMe[unsupported-syntax]
     crawlData.reference.children = Object.assign(...[
       ...crawlData.reference.children["(overview)"] ? [{
         "(overview)": crawlData.reference.children["(overview)"],
@@ -67,22 +67,28 @@ function crawl(tree /*: RootDoc */, index /*: string */)/*: CrawlData */ {
 
 module.exports = ({crawl}/*: {crawl: typeof crawl} */);
 
-function buildLinks(tree /*: RootDoc */) /*: LinkTable */ {
-  const linkTable = {};
+function buildLinks(documentedInterface /*: DocumentedInterface */) /*: void */ {
+  const registry = documentedInterface.registry;
 
-  model.traverse(tree, (doc) => {
+  model.traverse(documentedInterface.root, (doc) => {
     if (doc.type === "RootDoc") {
       doc.packages.forEach((packageDoc) => {
-        linkTable[packageDoc.path] = linker.getURI(packageDoc);
+        if (!registry[packageDoc.id]) {
+          registry[packageDoc.id] = {};
+        }
+
+        registry[packageDoc.id].uri = linker.getURI(packageDoc);
       });
 
       return;
     }
 
-    linkTable[doc.path] = linker.getURI(doc);
-  });
+    if (!registry[doc.id]) {
+      registry[doc.id] = {};
+    }
 
-  return linkTable;
+    registry[doc.id].uri = linker.getURI(doc);
+  });
 }
 
 function buildIndex(

packages/webdoc-default-template/helper/crawl/crawl.js

@@ -64,6 +64,7 @@ exports.publish = async function publish(options /*: PublishOptions */) {
   const config = options.config;
 
   linker.siteRoot = config.template.siteRoot;
+  options.documentedInterface.metadata.linker = "require('@webdoc/template-library').LinkerPlugin";
 
   const docTree = options.documentTree;
   const outDir = path.normalize(options.config.opts.destination);
@@ -72,7 +73,7 @@ exports.publish = async function publish(options /*: PublishOptions */) {
 
   fse.ensureDir(outDir);
 
-  const crawlData = crawl(docTree, index);
+  const crawlData = crawl(options.documentedInterface, index);
   const appBarItems = _.merge(config.template.appBar.items, {
     /* NOTE: config.template.appBar.items is the primary object so we retain the order as the user
         desires. */

packages/webdoc-default-template/publish.js

@@ -27,6 +27,8 @@ export type SerializedReturn = {
 export type DocumentedInterface = {
   version: string;
   metadata: {
+    siteRoot?: string;
+    siteDomain?: string;
     linker?: "require('@webdoc/template-library').LinkerPlugin" | string;
     [string]: string;
   };
@@ -36,4 +38,4 @@ export type DocumentedInterface = {
       uri: string;
     };
   };
-};
+};