summary refs log tree commit diff
path: root/api/jest/getRouteDescriptions.js
diff options
context:
space:
mode:
authorFlam3rboy <34555296+Flam3rboy@users.noreply.github.com>2021-09-23 17:03:36 +0200
committerGitHub <noreply@github.com>2021-09-23 17:03:36 +0200
commit5823f8efb4d1335281b64bfcaddf33bd9453cf08 (patch)
tree08c4420554b707d7207da6c2a9f15b4fcdf87e61 /api/jest/getRouteDescriptions.js
parentMerge pull request #394 from ChrisChrome/erlpack-fix (diff)
parent:bug: prepare/postinstall only works for packages not local npm install (diff)
downloadserver-5823f8efb4d1335281b64bfcaddf33bd9453cf08.tar.xz
Merge pull request #372 from fosscord/unittests
Automatic Unittests + documentation
Diffstat (limited to 'api/jest/getRouteDescriptions.js')
-rw-r--r--api/jest/getRouteDescriptions.js66
1 files changed, 66 insertions, 0 deletions
diff --git a/api/jest/getRouteDescriptions.js b/api/jest/getRouteDescriptions.js
new file mode 100644

index 00000000..4f8d2e75 --- /dev/null +++ b/api/jest/getRouteDescriptions.js
@@ -0,0 +1,66 @@ +const { traverseDirectory } = require("lambert-server"); +const path = require("path"); +const express = require("express"); +const RouteUtility = require("../dist/util/route"); +const Router = express.Router; + +/** + * Some documentation. + * + * @type {Map<string, RouteUtility.RouteOptions>} + */ +const routes = new Map(); +let currentPath = ""; +let currentFile = ""; +const methods = ["get", "post", "put", "delete", "patch"]; + +function registerPath(file, method, prefix, path, ...args) { + const urlPath = prefix + path; + const sourceFile = file.replace("/dist/", "/src/").replace(".js", ".ts"); + const opts = args.find((x) => typeof x === "object"); + if (opts) { + routes.set(urlPath + "|" + method, opts); // @ts-ignore + opts.file = sourceFile; + // console.log(method, urlPath, opts); + } else { + console.log(`${sourceFile}\nrouter.${method}("${path}") is missing the "route()" description middleware\n`); + } +} + +function routeOptions(opts) { + return opts; +} + +// @ts-ignore +RouteUtility.route = routeOptions; + +express.Router = (opts) => { + const path = currentPath; + const file = currentFile; + const router = Router(opts); + + for (const method of methods) { + router[method] = registerPath.bind(null, file, method, path); + } + + return router; +}; + +module.exports = function getRouteDescriptions() { + const root = path.join(__dirname, "..", "dist", "routes", "/"); + traverseDirectory({ dirname: root, recursive: true }, (file) => { + currentFile = file; + let path = file.replace(root.slice(0, -1), ""); + path = path.split(".").slice(0, -1).join("."); // trancate .js/.ts file extension of path + path = path.replaceAll("#", ":").replaceAll("\\", "/"); // replace # with : for path parameters and windows paths with slashes + if (path.endsWith("/index")) path = path.slice(0, "/index".length * -1); // delete index from path + currentPath = path; + + try { + require(file); + } catch (error) { + console.error("error loading file " + file, error); + } + }); + return routes; +};