refactor: use type inference for inputs wiht default values

Closes ng-bootstrap#288

Author: pkozlowski-opensource

misc/api-doc-test-cases/directives-with-inputs-types-to-infer.ts

@@ -0,0 +1,11 @@
+import {Directive, Input} from '@angular/core';
+
+@Directive({
+  selector: '[foo]'
+})
+export class Foo {
+
+  @Input() fooBoolean = false;
+  @Input() fooNumber = 5;
+  @Input() fooString = 'bar';
+}

misc/api-doc-test-cases/directives-with-tricky-inputs.ts

@@ -6,7 +6,8 @@ import {Directive, Input} from '@angular/core';
 export class Foo {
   @Input('foo') _foo;
   @Input() set bar(newVal) {
-  };
+  }
+  
   @Input('baz') set _baz(newVal) {
-  };
+  }
 }

misc/api-doc.js

@@ -9,7 +9,10 @@ function getNamesCompareFn(name) {
 }
 
 class APIDocVisitor {
-  constructor(fileNames) { this.program = ts.createProgram(fileNames, {}); }
+  constructor(fileNames) {
+    this.program = ts.createProgram(fileNames, {});
+    this.typeChecker = this.program.getTypeChecker(true);
+  }
 
 
   visitSourceFile(fileName) {
@@ -105,7 +108,7 @@ class APIDocVisitor {
     return {
       name: inArgs.length ? inArgs[0].text : property.name.text,
       defaultValue: property.initializer ? this.stringifyDefaultValue(property.initializer) : undefined,
-      type: this.stringifyTypeInfo(property.type),
+      type: this.typeChecker.typeToString(this.typeChecker.getTypeAtLocation(property)),
       description: ts.displayPartsToString(property.symbol.getDocumentationComment())
     };
   }
@@ -144,27 +147,6 @@ class APIDocVisitor {
 
     return null;
   }
-
-  stringifyTypeInfo(type) {
-    // TODO: this is probably covered by some helper method in TS, investigate
-
-    if (!type) {
-      return undefined;
-    }
-
-    switch (type.kind) {
-      case ts.SyntaxKind.BooleanKeyword:
-        return 'boolean';
-      case ts.SyntaxKind.NumberKeyword:
-        return 'number';
-      case ts.SyntaxKind.StringKeyword:
-        return 'string';
-      case ts.SyntaxKind.UnionType:
-        return type.types.map((typeNode) => { return this.stringifyTypeInfo(typeNode); }).join(' | ');
-      default:
-        return 'unknown';
-    }
-  }
 }
 
 function parseOutApiDocs(programFiles) {

misc/api-doc.spec.js

@@ -40,7 +40,7 @@ describe('APIDocVisitor', function() {
 
     expect(inputDocs[2].name).toBe('foo');
     expect(inputDocs[2].defaultValue).toBe('5');
-    expect(inputDocs[2].type).toBeUndefined();
+    expect(inputDocs[2].type).toBe('number');
     expect(inputDocs[2].description).toBe('Has default value');
   });
 
@@ -54,6 +54,19 @@ describe('APIDocVisitor', function() {
     expect(inputDocs[2].defaultValue).toBe('bar');
   });
 
+  it('should extract inferred types', function() {
+    var inputDocs = apiDoc(['./misc/api-doc-test-cases/directives-with-inputs-types-to-infer.ts']).Foo.inputs;
+
+    expect(inputDocs.length).toBe(3);
+
+    expect(inputDocs[0].defaultValue).toBe('false');
+    expect(inputDocs[0].type).toBe('boolean');
+    expect(inputDocs[1].defaultValue).toBe('5');
+    expect(inputDocs[1].type).toBe('number');
+    expect(inputDocs[2].defaultValue).toBe('bar');
+    expect(inputDocs[2].type).toBe('string');
+  });
+
   it('should extract inputs info from setters', function() {
     var inputDocs = apiDoc(['./misc/api-doc-test-cases/directives-with-tricky-inputs.ts']).Foo.inputs;
 

src/accordion/accordion.ts

@@ -33,9 +33,9 @@ let nextId = 0;
   directives: [NgbCollapse]
 })
 export class NgbPanel {
-  @Input() disabled: boolean = false;
-  @Input() id: string = `ngb-panel-${nextId++}`;
-  @Input() open: boolean = false;
+  @Input() disabled = false;
+  @Input() id = `ngb-panel-${nextId++}`;
+  @Input() open = false;
   @Input() title: string;
 
   constructor(@Optional() @Inject(forwardRef(() => NgbAccordion)) private accordion: NgbAccordion) {}

src/alert/alert.ts

@@ -20,11 +20,11 @@ export class NgbAlert {
    * A flag indicating if a given alert can be dismissed (closed) by a user. If this flag is set, a close button (in a
    * form of a cross) will be displayed.
    */
-  @Input() dismissible: boolean = true;
+  @Input() dismissible = true;
   /**
    * Alert type (CSS class). Bootstrap 4 recognizes the following types: "success", "info", "warning" and "danger".
   */
-  @Input() type: string = 'warning';
+  @Input() type = 'warning';
   /**
    * An event emitted when the close button is clicked. This event has no payload. Only relevant for dismissible alerts.
    */

src/collapse/collapse.ts

@@ -12,7 +12,7 @@ export class NgbCollapse {
   /**
    * A flag indicating collapsed (true) or open (false) state.
    */
-  @Input('ngbCollapse') collapsed: boolean = false;
+  @Input('ngbCollapse') collapsed = false;
 }
 
 export const NGB_COLLAPSE_DIRECTIVES = [NgbCollapse];