add schema descriptions as jsdocs

Author: omermecitoglu

src/core/renderers/schema.ts

@@ -5,13 +5,15 @@ import schemaTemplate from "~/templates/schema.hbs";
 type SchemaTemplate = {
   importedSchemas: string[],
   name: string,
+  description: string,
   properties: ModelProperty[],
 };
 
-export default function generateSchema(name: string, properties: ModelProperty[], importedSchemas: string[]) {
+export default function generateSchema(name: string, properties: ModelProperty[], importedSchemas: string[], description?: string) {
   const template = getTemplate<SchemaTemplate>(schemaTemplate);
   return template({
     name,
+    description: description || "missing-description",
     properties,
     importedSchemas,
   });

src/index.ts

@@ -31,7 +31,7 @@ import findPredefinedSchemas from "./core/schemas";
       if (schema.type === "object") {
         const properties = resolveProperties(schema.properties, schema.required ?? []);
         const importedSchemas = resolveSchemasFromProps(schema.properties);
-        const content = generateSchema(schemaName, properties, importedSchemas);
+        const content = generateSchema(schemaName, properties, importedSchemas, schema.description);
         await createFile(content, `${schemaName}.ts`, outputDir, "dist/schemas");
       }
     }

src/templates/schema.hbs

@@ -1,13 +1,15 @@
 {{#each importedSchemas}}
 import type {{this}} from "./{{this}}";
 {{/each}}
-
+/**
+ * {{{description}}}
+ */
 type {{name}} = {
   {{#each properties}}
   /**
-  * {{{this.description}}}
-  */
-  {{{this.content}}}
+   * {{{description}}}
+   */
+  {{{content}}}
   {{/each}}
 };