Merge pull request styleguidist#376 from ron0115/master

feat: get comment info for union type
ecraig12345 · Aug 1, 2021 · 4bffdfb · 4bffdfb
2 parents fe1d0fa + 8b5358f
commit 4bffdfb
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 18 deletions.
diff --git a/src/__tests__/data/RemoveOptionalValuesFromEnum.tsx b/src/__tests__/data/RemoveOptionalValuesFromEnum.tsx
@@ -1,6 +1,7 @@
 import * as React from 'react';
 
 enum sampleEnum {
+  /** test comment */
   ONE = 'one',
   TWO = 'two',
   THREE = 'three'

diff --git a/src/__tests__/parser.ts b/src/__tests__/parser.ts
@@ -1246,9 +1246,24 @@ describe('parser', () => {
                 raw: 'sampleEnum',
                 type: 'enum',
                 value: [
-                  { value: '"one"' },
-                  { value: '"two"' },
-                  { value: '"three"' }
+                  {
+                    value: '"one"',
+                    description: '',
+                    fullComment: '',
+                    tags: {}
+                  },
+                  {
+                    value: '"two"',
+                    description: '',
+                    fullComment: '',
+                    tags: {}
+                  },
+                  {
+                    value: '"three"',
+                    description: '',
+                    fullComment: '',
+                    tags: {}
+                  }
                 ]
               },
               sampleString: { type: 'string' }
@@ -1292,15 +1307,9 @@ describe('parser', () => {
                 raw: 'SampleEnum',
                 type: 'enum',
                 value: [
-                  {
-                    value: '0'
-                  },
-                  {
-                    value: '1'
-                  },
-                  {
-                    value: '"c"'
-                  }
+                  { value: '0', description: '', fullComment: '', tags: {} },
+                  { value: '1', description: '', fullComment: '', tags: {} },
+                  { value: '"c"', description: '', fullComment: '', tags: {} }
                 ]
               },
               sampleUnionNonGeneric: {
@@ -1513,9 +1522,14 @@ describe('parser', () => {
               required: false,
               type: 'enum',
               value: [
-                { value: '"one"' },
-                { value: '"two"' },
-                { value: '"three"' }
+                {
+                  value: '"one"',
+                  description: 'test comment',
+                  fullComment: 'test comment',
+                  tags: {}
+                },
+                { value: '"two"', description: '', fullComment: '', tags: {} },
+                { value: '"three"', description: '', fullComment: '', tags: {} }
               ]
             },
             sampleString: { type: 'string', required: false }

diff --git a/src/parser.ts b/src/parser.ts
@@ -581,6 +581,21 @@ export class Parser {
     return this.checker.typeToString(type);
   }
 
+  private getInfoFromUnionType(
+    type: ts.Type
+  ): {
+    value: string | number;
+  } & Partial<JSDoc> {
+    let commentInfo = {};
+    if (type.getSymbol()) {
+      commentInfo = { ...this.getFullJsDocComment(type.getSymbol()!) };
+    }
+    return {
+      value: this.getValuesFromUnionType(type),
+      ...commentInfo
+    };
+  }
+
   public getDocgenType(propType: ts.Type, isRequired: boolean): PropItemType {
     // When we are going to process the type, we check if this type has a constraint (is a generic type with constraint)
     if (propType.getConstraint()) {
@@ -606,9 +621,7 @@ export class Parser {
                 ts.TypeFlags.Undefined)
           ))
       ) {
-        let value = propType.types.map(type => ({
-          value: this.getValuesFromUnionType(type)
-        }));
+        let value = propType.types.map(type => this.getInfoFromUnionType(type));
 
         if (this.shouldRemoveUndefinedFromOptional && !isRequired) {
           value = value.filter(option => option.value != 'undefined');