add tests

Author: BenLorantfy

src/__tests__/data/ColumnWithMethods.tsx

@@ -26,20 +26,28 @@ export class Column extends React.Component<IColumnProps, {}> {
 
   /**
    * My super cool method
-   * @param myNum Documentation for parameter 1
+   * @param myParam Documentation for parameter 1
    * @public
-   * @returns The answer to the universe times myNum
+   * @returns The answer to the universe
    */
-  static calculateAnswerr(myNum: number): number {
-    return 42 * myNum;
+  myCoolMethod(myParam: number, mySecondParam: string): number {
+    return 42;
   }
 
   /**
-   * hello how are you
    * @public
    */
-  myNormalMethod() {
-    return 78;
+  myBasicMethod() {
+    return null;
+  }
+
+  /**
+   * @public
+   */
+  myArrowFunction = () => 23;
+
+  myPrivateFunction() {
+    return 99;
   }
 
   public render() {

src/__tests__/data/ColumnWithStaticMethods.tsx

@@ -0,0 +1,43 @@
+import * as React from 'react';
+
+/**
+ * Column properties.
+ */
+export interface IColumnProps {
+  /** prop1 description */
+  prop1?: string;
+  /** prop2 description */
+  prop2: number;
+  /**
+   * prop3 description
+   */
+  prop3: () => void;
+  /** prop4 description */
+  prop4: 'option1' | 'option2' | 'option3';
+}
+
+/**
+ * Column description
+ */
+export class Column extends React.Component<IColumnProps, {}> {
+  public static defaultProps: Partial<IColumnProps> = {
+    prop1: 'prop1'
+  };
+
+  /**
+   * My super cool static method
+   * @param myParam Documentation for parameter 1
+   * @public
+   * @returns The answer to the universe
+   */
+  static myStaticMethod(myParam: number, mySecondParam: string): number {
+    return 42;
+  }
+
+  public render() {
+    const { prop1 } = this.props;
+    return <div>{prop1}</div>;
+  }
+}
+
+export default Column;

src/__tests__/parser.ts

@@ -842,4 +842,57 @@ describe('parser', () => {
       assert.equal(parsed.displayName, 'StatelessDisplayNameStyledComponent');
     });
   });
+
+  describe('methods', () => {
+    it('should properly parse methods', () => {
+      const [parsed] = parse(fixturePath('ColumnWithMethods'));
+      const methods = parsed.methods;
+      const myCoolMethod = methods[0];
+
+      assert.equal(myCoolMethod.description, 'My super cool method');
+      assert.equal(myCoolMethod.docblock, 'My super cool method\n@param myParam Documentation for parameter 1\n@public\n@returns The answer to the universe'); // tslint:disable-line max-line-length
+      assert.deepEqual(myCoolMethod.modifiers, []);
+      assert.equal(myCoolMethod.name, 'myCoolMethod');
+      assert.deepEqual(myCoolMethod.params, [
+        {
+          description: 'Documentation for parameter 1',
+          name: 'myParam'
+        },
+        {
+          description: null,
+          name: 'mySecondParam'
+        }
+      ]);
+      assert.deepEqual(myCoolMethod.returns, {
+        description: 'The answer to the universe',
+        type: 'number'
+      });
+    });
+
+    it('should properly parse static methods', () => {
+      const [parsed] = parse(fixturePath('ColumnWithStaticMethods'));
+      const methods = parsed.methods;
+
+      assert.equal(methods[0].name, 'myStaticMethod');
+      assert.deepEqual(methods[0].modifiers, ['static']);
+    });
+
+    it('should handle method with no information', () => {
+      const [parsed] = parse(fixturePath('ColumnWithMethods'));
+      const methods = parsed.methods;
+      assert.equal(methods[1].name, 'myBasicMethod');
+    });
+
+    it('should handle arrow function', () => {
+      const [parsed] = parse(fixturePath('ColumnWithMethods'));
+      const methods = parsed.methods;
+      assert.equal(methods[2].name, 'myArrowFunction');
+    });
+
+    it('should not parse functions not marked with @public', () => {
+      const [parsed] = parse(fixturePath('ColumnWithMethods'));
+      const methods = parsed.methods;
+      assert.equal(Boolean(methods.find((method => method.name === 'myPrivateFunction'))), false);
+    });
+  });
 });

src/parser.ts

@@ -35,7 +35,7 @@ export interface Method {
   name: string;
   docblock: string;
   modifiers: string[];
-  params: Array<{ name: string, description?: string }>;
+  params: Array<{ name: string, description?: string|null }>;
   returns?: {
     description?: string|null;
     type?: string;
@@ -232,8 +232,8 @@ export class Parser {
     const displayName =
       resolvedComponentName || computeComponentName(exp, source);
     const description = this.findDocComment(commentSource).fullComment;
+    const methods = this.getMethodsInfo(type);
 
-    // here
     if (propsType) {
       const defaultProps = this.extractDefaultPropsFromComponent(exp, source);
       const props = this.getPropsInfo(propsType, defaultProps);
@@ -246,7 +246,6 @@ export class Parser {
         }
       }
 
-      const methods = this.getMethodsInfo(type);
       return {
         description,
         displayName,
@@ -257,7 +256,7 @@ export class Parser {
       return {
         description,
         displayName,
-        methods: [],
+        methods,
         props: {}
       };
     }
@@ -327,7 +326,7 @@ export class Parser {
       }
     });
 
-    if (type.symbol.members) {
+    if (type.symbol && type.symbol.members) {
       type.symbol.members.forEach((member) => {
         methodSymbols.push(member);
       });
@@ -384,7 +383,7 @@ export class Parser {
   public getParameterInfo(callSignature: ts.Signature) {
     return callSignature.parameters.map((param) => {
       return {
-        description: ts.displayPartsToString(param.getDocumentationComment(this.checker)),
+        description: ts.displayPartsToString(param.getDocumentationComment(this.checker)) || null,
         name: param.getName()
       };
     });