Tree file layout in LinkerPlugin + fix #60

ShukantPal · ShukantPal · commit 6c126621fb44 · 2020-12-06T13:26:08.000-05:00
diff --git a/packages/webdoc-default-template/helper/crawl/crawl-reference-explorer.js b/packages/webdoc-default-template/helper/crawl/crawl-reference-explorer.js
@@ -42,7 +42,7 @@ function crawlReference(doc /*: Doc */) {
 exports.crawlReference = crawlReference;
 
 function getPage(doc /*: Doc */) {
-  return linker.getURI(doc);
+  return "/" + linker.getURI(doc);
 }
 
 /*::
@@ -161,7 +161,7 @@ function buildExplorerTargetsTree(
   parentTitle /*: string */ = "",
 ) /*: ExplorerTarget */ {
   const doc = node.doc;
-  const page = doc.type !== "RootDoc" ? getPage(doc) : "index.html";
+  const page = doc.type !== "RootDoc" ? getPage(doc) : "/index.html";
 
   let title = "";
 
@@ -187,11 +187,11 @@ function buildExplorerTargetsTree(
     };
 
     if (node.doc.type === "RootDoc") {
-      node.children["(overview)"].page = "index.html";
+      node.children["(overview)"].page = "/index.html";
 
       node.children.ClassIndex = {
         title: "Class Index",
-        page: linker.createURI("Class-Index.html"),
+        page: "/" + linker.createURI("Class-Index"),
       };
     }
 
diff --git a/packages/webdoc-default-template/src/app/components/Explorer/index.js b/packages/webdoc-default-template/src/app/components/Explorer/index.js
@@ -12,7 +12,7 @@ export default function Explorer(props) {
   const children = [];
 
   if (!fetched) {
-    fetch("explorer/reference.json")
+    fetch("/explorer/reference.json")
       .then((response) => {
         if (response.ok) {
           response.json().then((idata) => {
diff --git a/packages/webdoc-default-template/static/scripts/default-template.js b/packages/webdoc-default-template/static/scripts/default-template.js
@@ -4970,7 +4970,7 @@ function Explorer(props) {
   var children = [];
 
   if (!fetched) {
-    fetch("explorer/reference.json").then(function (response) {
+    fetch("/explorer/reference.json").then(function (response) {
       if (response.ok) {
         response.json().then(function (idata) {
           setData(idata || {});
diff --git a/packages/webdoc-default-template/tmpl/layout.tmpl b/packages/webdoc-default-template/tmpl/layout.tmpl
@@ -10,14 +10,14 @@ const rootData = obj
     <meta charset="utf-8" />
     <title>webdoc: <?js= title ?></title>
 
-    <link type="text/css" rel="stylesheet" href="styles/index.css" />
+    <link type="text/css" rel="stylesheet" href="/styles/index.css" />
     <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" />
     <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono:300,400,500,700&display=swap" />
     <link type="text/css" rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.0.3/styles/googlecode.min.css">
 
     <script crossorigin src="https://unpkg.com/react@16/umd/react.development.js"></script>
     <script crossorigin src="https://unpkg.com/react-dom@16/umd/react-dom.development.js"></script>
-    <script src="scripts/default-template.js"></script>
+    <script src="/scripts/default-template.js"></script>
   </head>
   <body class="root">
     <div class="docs">
diff --git a/packages/webdoc-template-library/package.json b/packages/webdoc-template-library/package.json
@@ -47,7 +47,8 @@
     "lodash": "^4.17.15",
     "missionlog": "1.6.0",
     "nanoid": "~3.1.16",
-    "parse-github-url": "1.0.2"
+    "parse-github-url": "1.0.2",
+    "fs-extra": "^9.0.1"
   },
   "devDependencies": {
     "@babel/core": "^7.9.0",
diff --git a/packages/webdoc-template-library/src/pipeline-elements/FlushToFile.js b/packages/webdoc-template-library/src/pipeline-elements/FlushToFile.js
@@ -1,7 +1,7 @@
 // @flow
 
+import * as fse from "fs-extra";
 import type {TemplatePipelineElement} from "../TemplatePipeline";
-import fs from "fs";
 
 type FlushData = {
   outputFile: string;
@@ -40,7 +40,7 @@ export class FlushToFile implements TemplatePipelineElement<FlushData> {
       throw new Error("No outputFile specified in pipeline-data");
     }
 
-    fs.writeFile(pipelineData.outputFile, input, (err) => {
+    fse.outputFile(pipelineData.outputFile, input, (err) => {
       if (err) throw err;
     });
 
diff --git a/packages/webdoc-template-library/src/template-plugins/LinkerPlugin.js b/packages/webdoc-template-library/src/template-plugins/LinkerPlugin.js
@@ -21,6 +21,8 @@ export type LinkerFileRecord = {
   uri?: string,
 };
 
+export type FileLayout = "linear" | "tree";
+
 /**
  * Shell wrapper around {@link LinkerPlugin}.
  *
@@ -100,6 +102,12 @@ function LinkerPluginShell() {
      */
     documentRegistry = new Map<string, LinkerDocumentRecord>();
 
+    /**
+     * The mode with which the path for output files is choosen.
+     * @protected
+     */
+    fileLayout = "tree";
+
     /**
      * This holds all the linker's data on each output file, mapping each URI lowercased.
      * @protected
@@ -373,6 +381,10 @@ function LinkerPluginShell() {
         // make sure we don't create hidden files, or files whose names start with a dash
         .replace(/^[.-]/, "");
 
+      if (this.fileLayout === "tree") {
+        seedURI = seedURI.replace(/[.]/g, "/");
+      }
+
       // in case we've now stripped the entire basename (uncommon, but possible):
       seedURI = seedURI.length ? seedURI : "_";
       seedURI += ".html";
