Add support for 'ssh_' modules (#12)

* Add support for 'ssh_' modules

* Also include the dist files

* Add some more info to the error

* Explicitly skip the 'index' file

* Add all of the non-module files in the 'src/modules' path

* Fix index TOC output

Author: dfellis

dist/lib/resources/helpers/toc.js

@@ -24,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Handlebars = __importStar(require("handlebars"));
-function displayChild(child, children) {
+function displayChild(child, _children) {
     const md = [];
     // it is a module, print it
     md.push(`#### [${child.name}](${child.url})\n\n`);
@@ -80,7 +80,7 @@ function displayChild(child, children) {
 }
 function default_1(theme) {
     Handlebars.registerHelper("toc", function () {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         const md = [];
         const { hideInPageTOC } = theme;
         const isVisible = (_a = this.groups) === null || _a === void 0 ? void 0 : _a.some((group) => group.allChildrenHaveOwnDocument());
@@ -117,6 +117,20 @@ function default_1(theme) {
                     md.push(...content);
                 }
             }
+            // ssh
+            const ssh = (_d = this.children) === null || _d === void 0 ? void 0 : _d.filter((child) => {
+                var _a, _b;
+                return ((_a = child.parent) === null || _a === void 0 ? void 0 : _a.id) == 0 &&
+                    child.kind == 2 &&
+                    ((_b = child.url) === null || _b === void 0 ? void 0 : _b.startsWith("ssh"));
+            });
+            md.push("### Server (via SSH)");
+            for (const child of ssh !== null && ssh !== void 0 ? ssh : []) {
+                if (!child.name.includes("/")) {
+                    const content = displayChild(child, ssh !== null && ssh !== void 0 ? ssh : []);
+                    md.push(...content);
+                }
+            }
         }
         return md.length > 0 ? md.join("\n") : null;
     });

dist/lib/theme.js

@@ -112,6 +112,12 @@ class MarkdownTheme extends typedoc_1.Theme {
             fragment = fragment + "aws";
         else if (url.startsWith("iasql"))
             fragment = fragment + "builtin";
+        else if (url.startsWith("ssh"))
+            fragment = fragment + "ssh";
+        else if (['index', 'interfaces', 'subscribers',].includes(url))
+            fragment = fragment; // Known static elements to skip
+        else
+            throw new Error(`Unsupported module type ${url}, please update the docusaurus plugin!`);
         if (mapping.directory == "enums")
             fragment = fragment + "/enums";
         else if (mapping.directory == "classes")
@@ -292,5 +298,5 @@ class MarkdownTheme extends typedoc_1.Theme {
         return "sql.md";
     }
 }
-exports.MarkdownTheme = MarkdownTheme;
 MarkdownTheme.URL_PREFIX = /^(http|ftp)s?:\/\//;
+exports.MarkdownTheme = MarkdownTheme;

src/lib/resources/helpers/toc.ts

@@ -4,7 +4,7 @@ import { MarkdownTheme } from "../../theme";
 
 function displayChild(
   child: DeclarationReflection,
-  children: DeclarationReflection[]
+  _children: DeclarationReflection[]
 ) {
   const md: string[] = [];
 
@@ -114,6 +114,22 @@ export default function (theme: MarkdownTheme) {
             md.push(...content);
           }
         }
+
+        // ssh
+        const ssh = this.children?.filter(
+          (child) =>
+            child.parent?.id == 0 &&
+            child.kind == 2 &&
+            child.url?.startsWith("ssh")
+        );
+        md.push("### Server (via SSH)");
+
+        for (const child of ssh ?? []) {
+          if (!child.name.includes("/")) {
+            const content = displayChild(child, ssh ?? []);
+            md.push(...content);
+          }
+        }
       }
       return md.length > 0 ? md.join("\n") : null;
     }

src/lib/theme.ts

@@ -145,6 +145,9 @@ export class MarkdownTheme extends Theme {
     let fragment = "";
     if (url.startsWith("aws")) fragment = fragment + "aws";
     else if (url.startsWith("iasql")) fragment = fragment + "builtin";
+    else if (url.startsWith("ssh")) fragment = fragment + "ssh";
+    else if (['index', 'interfaces', 'subscribers', ].includes(url)) fragment = fragment; // Known static elements to skip
+    else throw new Error(`Unsupported module type ${url}, please update the docusaurus plugin!`);
 
     if (mapping.directory == "enums") fragment = fragment + "/enums";
     else if (mapping.directory == "classes") fragment = fragment + "/tables";