feat: Added jsdoc to d.ts files

Author: KnisterPeter

Diff for: index.ts

@@ -27,6 +27,7 @@ export interface IProp {
   optional: boolean;
   importType?: string;
   importPath?: string;
+  documentation?: string;
 }
 
 export interface IPropTypes {
@@ -121,7 +122,9 @@ function parseAst(ast: any, instanceOfResolver: InstanceOfResolver): IParsingRes
             propTypes = {};
             walk(attributeNode.value, {
               'ObjectProperty': (propertyNode: any): void => {
-                propTypes[propertyNode.key.name] = getTypeFromPropType(propertyNode.value, instanceOfResolver);
+                const prop: IProp = getTypeFromPropType(propertyNode.value, instanceOfResolver);
+                prop.documentation = getOptionalDocumentation(propertyNode);
+                propTypes[propertyNode.key.name] = prop;
               }
             });
           }
@@ -135,6 +138,12 @@ function parseAst(ast: any, instanceOfResolver: InstanceOfResolver): IParsingRes
   };
 }
 
+function getOptionalDocumentation(propertyNode: any): string {
+  return (((propertyNode.leadingComments || []) as any[])
+    .filter((comment: any) => comment.type == 'CommentBlock')[0] || {})
+    .value;
+}
+
 interface IAstWalkHandlers {
   [type: string]: (node: IASTNode) => void;
 }
@@ -293,26 +302,41 @@ export class Writer {
     }
   }
 
-  public props(name: string, props: any, fn?: () => void): void {
+  public props(name: string, props: IPropTypes, fn?: () => void): void {
     this.interface(`${name}Props`, () => {
       this.prop('key', 'any', true);
       Object.keys(props).forEach((propName: any) => {
         const prop: IProp = props[propName];
-        this.prop(propName, prop.type, prop.optional);
+        this.prop(propName, prop.type, prop.optional, prop.documentation);
       });
     });
     if (fn) {
       fn();
     }
   }
 
-  public prop(name: string, type: string, optional: boolean, fn?: () => void): void {
+  public prop(name: string, type: string, optional: boolean, documentation?: string): void {
     this.indent();
+    if (documentation) {
+      this.comment(documentation);
+    }
     this.code += `${name}${optional ? '?' : ''}: ${type};`;
     this.nl();
-    if (fn) {
-      fn();
-    }
+  }
+
+  public comment(comment: string): void {
+    this.code += '/*';
+    const lines: string[] = (comment || '').replace(/\t/g, '').split(/\n/g);
+    lines.forEach((line: string, index: number) => {
+      this.code += line;
+      if (index < lines.length - 1) {
+        this.nl();
+        this.indent();
+      }
+    });
+    this.code += '*/';
+    this.nl();
+    this.indent();
   }
 
   public interface(name: string, fn: () => void): void {

Diff for: tests/simple-component.d.ts

@@ -4,6 +4,9 @@ declare module 'simple-component' {
 
 	interface SimpleComponentProps {
 		key?: any;
+		/**
+		 * This is a jsdoc comment for optionalAny.
+		 */
 		optionalAny?: any;
 		optionalArray?: any[];
 		optionalBool?: boolean;

Diff for: tests/simple-component.jsx

@@ -3,6 +3,9 @@ import * as React from 'react';
 export default class SimpleComponent extends React.Component {
 
 	static propTypes = {
+		/**
+		 * This is a jsdoc comment for optionalAny.
+		 */
 		optionalAny: React.PropTypes.any,
 		optionalArray: React.PropTypes.array,
 		optionalBool: React.PropTypes.bool,

Diff for: tests/writer-test.ts

@@ -36,4 +36,8 @@ describe('The Writer', () => {
     writer.class('Name', false);
     assert.equal(writer.toString(), 'class Name extends React.Component<any, any> {\n}\n');
   });
+  it('should write an indented block comment', () => {
+    writer.comment('* yada\n\t\t\t\tyada\n ');
+    assert.equal(writer.toString(), '/** yada\nyada\n */\n');
+  });
 });