Handle optional param types when parsing jsdoc format (#89)

reactjs · Jun 22, 2016 · 618a898 · 618a898
1 parent 3d576d4
commit 618a898
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 1 deletion.
diff --git a/src/utils/__tests__/parseJsDoc-test.js b/src/utils/__tests__/parseJsDoc-test.js
@@ -64,6 +64,22 @@ describe('parseJsDoc', () => {
       });
     });
 
+    it('extracts jsdoc optional', () => {
+      const docblock = `
+        @param {string=} bar
+      `;
+      expect(parseJsDoc(docblock)).toEqual({
+        description: null,
+        returns: null,
+        params: [{
+          name: 'bar',
+          type: {name: 'string'},
+          description: null,
+          optional: true,
+        }],
+      });
+    });
+
     describe('returns', () => {
 
       it('returns null if return is not documented', () => {

diff --git a/src/utils/parseJsDoc.js b/src/utils/parseJsDoc.js
@@ -17,6 +17,7 @@ type JsDoc = {
     name: string;
     description: ?string;
     type: ?{name: string};
+    optional?: boolean;
   }];
   returns: ?{
     description: ?string;
@@ -28,7 +29,14 @@ function getType(tag) {
   if (!tag.type) {
     return null;
   }
-  return {name: tag.type.name};
+  return {name: tag.type.name ? tag.type.name : tag.type.expression.name};
+}
+
+function getOptional(tag) {
+  if (tag.type && tag.type.type && tag.type.type === 'OptionalType') {
+    return true;
+  }
+  return;
 }
 
 // Add jsdoc @return description.
@@ -57,6 +65,7 @@ function getParamsJsDoc(jsDoc) {
         name: tag.name,
         description: tag.description,
         type: getType(tag),
+        optional: getOptional(tag),
       };
     });
 }