Merge pull request ferdikoomen#910 from jurgenbelien/feature/description-in-schema

Add description to schema output

Author: ferdikoomen

rollup.config.js

@@ -32,6 +32,7 @@ const handlebarsPlugin = () => ({
                 preventIndent: true,
                 knownHelpersOnly: true,
                 knownHelpers: {
+                    escapeSinglequotes: true,
                     equals: true,
                     notEquals: true,
                     containsSpaces: true,

src/templates/partials/schemaComposition.hbs

@@ -1,5 +1,8 @@
 {
     type: '{{export}}',
+{{#if description}}
+    description: '{{{escapeSinglequotes description}}}',
+{{/if}}
     contains: [{{#each properties}}{{>schema}}{{#unless @last}}, {{/unless}}{{/each}}],
 {{#if isReadOnly}}
     isReadOnly: {{{isReadOnly}}},

src/templates/partials/schemaGeneric.hbs

@@ -2,6 +2,9 @@
 {{#if type}}
     type: '{{{base}}}',
 {{/if}}
+{{#if description}}
+    description: '{{{escapeSinglequotes description}}}',
+{{/if}}
 {{#if isReadOnly}}
     isReadOnly: {{{isReadOnly}}},
 {{/if}}

src/templates/partials/schemaInterface.hbs

@@ -1,4 +1,7 @@
 {
+{{#if description}}
+    description: '{{{escapeSinglequotes description}}}',
+{{/if}}
     properties: {
 {{#if properties}}
     {{#each properties}}

src/utils/registerHandlebarHelpers.ts

@@ -10,6 +10,10 @@ export function registerHandlebarHelpers(root: {
     useOptions: boolean;
     useUnionTypes: boolean;
 }): void {
+    Handlebars.registerHelper('escapeQuotes', function (value: string): string {
+        return value.replace(/(')/g, '\\$1');
+    });
+
     Handlebars.registerHelper(
         'equals',
         function (this: any, a: string, b: string, options: Handlebars.HelperOptions): string {