Fix crash when a field has 'deprecated', but not 'description' (#549)

* Add failing test case * Fix crash when deprecated is defined without description * Add test case for #540 too
bcherny · Aug 29, 2023 · 2887a52 · 2887a52
1 parent 699eda8
commit 2887a52
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 4 deletions.
diff --git a/src/generator.ts b/src/generator.ts
@@ -316,12 +316,14 @@ function generateInterface(ast: TInterface, options: Options): string {
   )
 }
 
-function generateComment(comment: string, deprecated?: boolean): string {
+function generateComment(comment?: string, deprecated?: boolean): string {
   const commentLines = ['/**']
   if (deprecated) {
     commentLines.push(' * @deprecated')
   }
-  commentLines.push(...comment.split('\n').map(_ => ' * ' + _))
+  if (typeof comment !== 'undefined') {
+    commentLines.push(...comment.split('\n').map(_ => ' * ' + _))
+  }
   commentLines.push(' */')
   return commentLines.join('\n')
 }

diff --git a/test/__snapshots__/test/test.ts.md b/test/__snapshots__/test/test.ts.md
@@ -827,7 +827,6 @@ Generated by [AVA](https://avajs.dev).
     export interface ExampleSchema {␊
       /**␊
        * @deprecated␊
-       * nested comment␊
        */␊
       firstName: string;␊
       /**␊
@@ -839,6 +838,7 @@ Generated by [AVA](https://avajs.dev).
        * nested comment␊
        */␊
       lastName?: string;␊
+      description?: string;␊
     }␊
     `
 

diff --git a/test/__snapshots__/test/test.ts.snap b/test/__snapshots__/test/test.ts.snap
diff --git a/test/e2e/deprecated.ts b/test/e2e/deprecated.ts
@@ -5,10 +5,10 @@ export const input = {
   deprecated: true,
   description: 'comment',
   properties: {
+    // https://github.com/bcherny/json-schema-to-typescript/issues/548
     firstName: {
       type: 'string',
       deprecated: true,
-      description: 'nested comment',
     },
     middleName: {
       type: 'string',
@@ -20,6 +20,10 @@ export const input = {
       deprecated: false,
       description: 'nested comment',
     },
+    // https://github.com/bcherny/json-schema-to-typescript/issues/540
+    description: {
+      type: 'string',
+    },
   },
   additionalProperties: false,
   required: ['firstName'],