skeleton for docstrings generation

Author: kainpets

generate-docstrings.ts

@@ -0,0 +1,18 @@
+
+import { pascalCase } from "change-case";
+import type { Endpoint } from "generate-routes.js"
+
+const generateDocstringForEndpoint = (endpoint: Endpoint): string => {
+  const responseType = `${pascalCase(endpoint.namespace)}${pascalCase(endpoint.name)}Response`;
+  const paramType = endpoint.requestFormat === 'params' ? 'ParamsType' : 'BodyType'; 
+
+
+  return `
+/**
+ * Handles ${endpoint.method} requests to ${endpoint.path}.
+ *
+ * @param {${paramType}} request - The request ${endpoint.requestFormat}.
+ * @returns {Promise<${responseType}>} 
+ */
+`;
+};

generate-routes.ts

@@ -94,7 +94,7 @@ interface Route {
   subresources: string[]
 }
 
-interface Endpoint {
+export interface Endpoint {
   name: string
   path: string
   namespace: string

tsconfig.json

@@ -37,6 +37,7 @@
     "examples/**/*",
     "tsup.config.ts",
     "prepack.ts",
-    "generate-routes.ts"
+    "generate-routes.ts",
+    "generate-docstrings.ts"
   ]
 }