Switch getComment to handlebars helper

Author: Daniel Fullmer

rollup.config.js

@@ -39,6 +39,7 @@ const handlebarsPlugin = () => ({
                     intersection: true,
                     enumerator: true,
                     json: true,
+                    getComment: true,
                 },
             });
             return `export default ${templateSpec};`;

src/openApi/v2/parser/getModel.ts

@@ -3,7 +3,6 @@ import { getPattern } from '../../../utils/getPattern';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { extendEnum } from './extendEnum';
-import { getComment } from './getComment';
 import { getEnum } from './getEnum';
 import { getEnumFromDescription } from './getEnumFromDescription';
 import { getModelComposition } from './getModelComposition';
@@ -18,7 +17,7 @@ export function getModel(openApi: OpenApi, definition: OpenApiSchema, isDefiniti
         base: 'any',
         template: null,
         link: null,
-        description: getComment(definition.description),
+        description: definition.description ?? null,
         isDefinition,
         isReadOnly: definition.readOnly === true,
         isNullable: definition['x-nullable'] === true,

src/openApi/v3/parser/getModel.ts

@@ -3,7 +3,6 @@ import { getPattern } from '../../../utils/getPattern';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { extendEnum } from './extendEnum';
-import { getComment } from './getComment';
 import { getEnum } from './getEnum';
 import { getEnumFromDescription } from './getEnumFromDescription';
 import { getModelComposition } from './getModelComposition';
@@ -19,7 +18,7 @@ export function getModel(openApi: OpenApi, definition: OpenApiSchema, isDefiniti
         base: 'any',
         template: null,
         link: null,
-        description: getComment(definition.description),
+        description: definition.description ?? null,
         isDefinition,
         isReadOnly: definition.readOnly === true,
         isNullable: definition.nullable === true,

src/openApi/v3/parser/getModelProperties.ts

@@ -25,7 +25,7 @@ export function getModelProperties(openApi: OpenApi, definition: OpenApiSchema,
                     base: model.base,
                     template: model.template,
                     link: null,
-                    description: getComment(property.description),
+                    description: property.description ?? null,
                     default: property.default,
                     hasDefault: property.default !== undefined,
                     isDefinition: false,
@@ -60,7 +60,7 @@ export function getModelProperties(openApi: OpenApi, definition: OpenApiSchema,
                     base: model.base,
                     template: model.template,
                     link: model.link,
-                    description: getComment(property.description),
+                    description: property.description ?? null,
                     default: property.default,
                     hasDefault: property.default !== undefined,
                     isDefinition: false,

src/templates/partials/exportComposition.hbs

@@ -1,6 +1,6 @@
 {{#if description}}
 /**
- * {{{description}}}
+ * {{{getComment description}}}
  */
 {{/if}}
 export type {{{name}}} = {{>type parent=name}};
@@ -12,7 +12,7 @@ export namespace {{{name}}} {
     {{#each enums}}
     {{#if description}}
     /**
-     * {{{description}}}
+     * {{{getComment description}}}
      */
     {{/if}}
     export enum {{{name}}} {

src/templates/partials/exportEnum.hbs

@@ -1,13 +1,13 @@
 {{#if description}}
 /**
- * {{{description}}}
+ * {{{getComment description}}}
  */
 {{/if}}
 export enum {{{name}}} {
     {{#each enum}}
     {{#if description}}
     /**
-     * {{{description}}}
+     * {{{getComment description}}}
      */
     {{/if}}
     {{#containsSpaces name}}

src/templates/partials/exportInterface.hbs

@@ -1,13 +1,13 @@
 {{#if description}}
 /**
- * {{{description}}}
+ * {{{getComment description}}}
  */
 {{/if}}
 export type {{{name}}} = {
     {{#each properties}}
     {{#if description}}
     /**
-     * {{{description}}}
+     * {{{getComment description}}}
      */
     {{/if}}
     {{>isReadOnly}}{{{name}}}{{>isRequired}}: {{>type parent=../name}};
@@ -21,7 +21,7 @@ export namespace {{{name}}} {
     {{#each enums}}
     {{#if description}}
     /**
-     * {{{description}}}
+     * {{{getComment description}}}
      */
     {{/if}}
     export enum {{{name}}} {

src/templates/partials/exportType.hbs

@@ -1,6 +1,6 @@
 {{#if description}}
 /**
- * {{{description}}}
+ * {{{getComment description}}}
  */
 {{/if}}
 export type {{{name}}} = {{>type}};

src/templates/partials/parameters.hbs

@@ -7,7 +7,7 @@
 }: {
 {{#each parameters}}
 {{#if description}}
-/** {{{description}}} **/
+/** {{{getComment description}}} **/
 {{/if}}
 {{{name}}}{{>isRequired}}: {{>type}},
 {{/each}}

src/templates/partials/typeInterface.hbs

@@ -3,7 +3,7 @@
 {{#each properties}}
 {{#if description}}
 /**
- * {{{description}}}
+ * {{{getComment description}}}
  */
 {{/if}}
 {{#if ../parent}}