Merge pull request bcherny#26 from darcyparker/multiLineDesc

Multiple line description support

Author: bcherny

src/TsTypes.ts

@@ -1,5 +1,10 @@
 import { camelCase, upperFirst } from 'lodash'
 
+const multiLineCommentStart  = '/** '
+const multiLineCommentIndent = ' *  '
+const multiLineCommentEnd    = ' */'
+const newLineRegex = /\\n|\n/
+
 export namespace TsType {
 
   export interface TsTypeSettings {
@@ -36,7 +41,13 @@ export namespace TsType {
       return this.id && upperFirst(camelCase(this.id))
     }
     protected toBlockComment(settings: TsTypeSettings) {
-      return this.description && settings.declarationDescription ? `/** ${this.description} */\n` : ''
+      return this.description && settings.declarationDescription ?
+        `${this.description
+            .split(newLineRegex)
+            .map((line, lineNum) => (lineNum > 0 ? multiLineCommentIndent : multiLineCommentStart) + line)
+            .join('\n') + multiLineCommentEnd + '\n'
+        }` :
+        ''
     }
     protected _toDeclaration(decl: string, settings: TsTypeSettings): string {
       return this.toBlockComment(settings) + decl + (settings.endTypeWithSemicolon ? ';' : '')
@@ -181,14 +192,23 @@ export namespace TsType {
       let id = this.safeId()
       return declaration || !id ? `{
         ${this.props.map(_ => {
-          let decl = '    ' + _.name
+          const indentString =  '    '
+          let decl = indentString + _.name
+
           if (!_.required)
             decl += '?'
           decl += ': ' + _.type.toType(settings)
           if (settings.endPropertyWithSemicolon)
             decl += ';'
+
+          //All descriptions will be inside jsdoc-style comments to support hinting in editors
+          //(ie intellisense)
           if (settings.propertyDescription && _.type.description && !_.type.id)
-            decl += ' // ' + _.type.description
+            decl = _.type.description
+                .split(newLineRegex)
+                .map((line, lineNum, lines) => (lineNum > 0 ? multiLineCommentIndent : indentString + multiLineCommentStart) + line)
+                .join('\n' + indentString) + multiLineCommentEnd + '\n' + decl
+
           return decl
         }).join('\n')}
 }` : id

test/cases/basics.ts

@@ -34,7 +34,8 @@ export var configurations = [
     types: `export interface ExampleSchema {
   firstName: string;
   lastName: string;
-  age?: number; // Age in years
+  /** Age in years */
+  age?: number;
   height?: number;
   favoriteFoods?: any[];
   likesDogs?: boolean;

test/cases/not-extendable.ts

@@ -21,5 +21,6 @@ export var schema = {
 export var types = `export interface ExampleSchema {
   firstName: string;
   lastName: string;
-  age?: number; // Age in years
+  /** Age in years */
+  age?: number;
 }`

test/cases/ref.ts

@@ -19,7 +19,8 @@ export var configurations = [
     types: `export interface ExampleSchema {
   firstName: string;
   lastName: string;
-  age?: number; // Age in years
+  /** Age in years */
+  age?: number;
   height?: number;
   favoriteFoods?: any[];
   likesDogs?: boolean;
@@ -37,4 +38,4 @@ export interface Referencing {
   foo: ExampleSchema;
 }`
   }
-]
+]

test/cases/with-description-newlines.ts

@@ -0,0 +1,31 @@
+export var schema = {
+  "title": "Example Schema",
+  "description": "My cool schema",
+  "type": "object",
+  "properties": {
+    "firstName": {
+      "description": "first name single line description",
+      "type": "string"
+    },
+    "lastName": {
+      "type": "string"
+    },
+    "age": {
+      "description": "Age description with\nmultiple lines",
+      "type": "integer",
+      "minimum": 0
+    }
+  },
+  "required": ["firstName", "lastName"]
+}
+
+export var types = `/** My cool schema */
+export interface ExampleSchema {
+  /** first name single line description */
+  firstName: string;
+  lastName: string;
+  /** Age description with
+   *  multiple lines */
+  age?: number;
+  [k: string]: any;
+}`

test/cases/with-description.ts

@@ -22,6 +22,7 @@ export var types = `/** My cool schema */
 export interface ExampleSchema {
   firstName: string;
   lastName: string;
-  age?: number; // Age in years
+  /** Age in years */
+  age?: number;
   [k: string]: any;
 }`