Auto-generate plugin docs (WIP)

src/api/docs.ts

@@ -0,0 +1,70 @@
+import express from "express";
+import { availablePlugins } from "../plugins/availablePlugins";
+import { ZeppelinPlugin } from "../plugins/ZeppelinPlugin";
+import { notFound } from "./responses";
+import { CommandManager, ICommandConfig } from "knub/dist/CommandManager";
+
+const commandManager = new CommandManager();
+
+export function initDocs(app: express.Express) {
+  const docsPlugins = availablePlugins.filter(pluginClass => pluginClass.showInDocs);
+
+  app.get("/docs/plugins", (req: express.Request, res: express.Response) => {
+    res.json(
+      docsPlugins.map(pluginClass => {
+        const thinInfo = pluginClass.pluginInfo ? { prettyName: pluginClass.pluginInfo.prettyName } : {};
+        return {
+          name: pluginClass.pluginName,
+          info: thinInfo,
+        };
+      }),
+    );
+  });
+
+  app.get("/docs/plugins/:pluginName", (req: express.Request, res: express.Response) => {
+    const pluginClass = docsPlugins.find(obj => obj.pluginName === req.params.pluginName);
+    if (!pluginClass) {
+      return notFound(res);
+    }
+
+    const props = Reflect.ownKeys(pluginClass.prototype);
+    const commands = props.reduce((arr, prop) => {
+      if (typeof prop !== "string") return arr;
+      const propCommands = Reflect.getMetadata("commands", pluginClass.prototype, prop);
+      if (propCommands) {
+        arr.push(
+          ...propCommands.map(cmd => {
+            const trigger = typeof cmd.command === "string" ? cmd.command : cmd.command.source;
+            const parameters = cmd.parameters
+              ? typeof cmd.parameters === "string"
+                ? commandManager.parseParameterString(cmd.parameters)
+                : cmd.parameters
+              : [];
+            const config: ICommandConfig = cmd.options || {};
+            if (config.overloads) {
+              config.overloads = config.overloads.map(overload => {
+                return typeof overload === "string" ? commandManager.parseParameterString(overload) : overload;
+              });
+            }
+
+            return {
+              trigger,
+              parameters,
+              config,
+            };
+          }),
+        );
+      }
+      return arr;
+    }, []);
+
+    const options = (pluginClass as typeof ZeppelinPlugin).getStaticDefaultOptions();
+
+    res.json({
+      name: pluginClass.pluginName,
+      info: pluginClass.pluginInfo || {},
+      options,
+      commands,
+    });
+  });
+}

src/api/index.ts

@@ -4,6 +4,7 @@ import cors from "cors";
 import { initAuth } from "./auth";
 import { initGuildsAPI } from "./guilds";
 import { initArchives } from "./archives";
+import { initDocs } from "./docs";
 import { connect } from "../data/db";
 import path from "path";
 import { TokenError } from "passport-oauth2";
@@ -12,15 +13,13 @@ import { PluginError } from "knub";
 require("dotenv").config({ path: path.resolve(__dirname, "..", "..", "api.env") });
 
 function errorHandler(err) {
-  // tslint:disable:no-console
-  console.error(err.stack || err);
+  console.error(err.stack || err); // tslint:disable-line:no-console
   process.exit(1);
-  // tslint:enable:no-console
 }
 
 process.on("unhandledRejection", errorHandler);
 
-console.log("Connecting to database...");
+console.log("Connecting to database..."); // tslint:disable-line
 connect().then(() => {
   const app = express();
 
@@ -34,6 +33,7 @@ connect().then(() => {
   initAuth(app);
   initGuildsAPI(app);
   initArchives(app);
+  initDocs(app);
 
   // Default route
   app.get("/", (req, res) => {
@@ -45,7 +45,7 @@ connect().then(() => {
     if (err instanceof TokenError) {
       clientError(res, "Invalid code");
     } else {
-      console.error(err);
+      console.error(err); // tslint:disable-line
       error(res, "Server error", err.status || 500);
     }
   });
@@ -56,5 +56,6 @@ connect().then(() => {
   });
 
   const port = process.env.PORT || 3000;
+  // tslint:disable-next-line
   app.listen(port, () => console.log(`API server listening on port ${port}`));
 });