Merge pull request #68 from webdoc-labs/fix/fields

Fix: Inference for types and default values in fields

Author: ShukantPal

packages/webdoc-parser/src/transformer/symbol-to-doc.js

@@ -133,6 +133,8 @@ export default function symbolToDoc(symbol: Symbol): ?Doc {
 
   options.abstract = symbol.meta.abstract;
   options.access = symbol.meta.access;
+  options.dataType = symbol.meta.dataType;
+  options.defaultValue = symbol.meta.defaultValue;
   options.scope = symbol.meta.scope;
   options.loc = symbol.loc;
 

packages/webdoc-parser/test/lang-ts.js

@@ -8,7 +8,7 @@ describe("@webdoc/parser.LanguageIntegration{@lang ts}", function() {
   it("should parse classes correctly", function() {
     let symtree = buildSymbolTree(`
       class ClassName {
-        private initProperty: number;
+        private initProperty: number = 11;
 
         constructor() {
           /**
@@ -48,6 +48,7 @@ describe("@webdoc/parser.LanguageIntegration{@lang ts}", function() {
     expect(symbolInitProperty.meta.dataType).to.not.equal(undefined);
     expect(symbolInitProperty.meta.dataType[0]).to.equal("number");
     expect(symbolInitProperty.meta.access).to.equal("private");
+    expect(symbolInitProperty.meta.defaultValue).to.equal(11);
     expect(symbolInitProperty.comment).to.not.equal("");
   });
 

packages/webdoc-parser/test/parse-ts.js

@@ -0,0 +1,35 @@
+const {createPackageDoc} = require("@webdoc/model");
+const {parse} = require("../lib/parse");
+
+const expect = require("chai").expect;
+
+describe("@webdoc/parser.parser", function() {
+  it("should infer access, default value, and type for fields", function() {
+    const docs = parse([{
+      content: `
+/** Example class */
+class Example {
+  /**
+   * Field description
+   */
+  protected field: boolean = true;
+}
+`,
+      path: ".ts",
+      package: createPackageDoc(),
+    }]);
+
+    expect(docs.members.length).to.equal(1);
+    expect(docs.members[0].members.length).to.equal(1);
+
+    const fieldDoc = docs.members[0].members[0];
+
+    expect(fieldDoc.access).to.equal("protected");
+    expect(fieldDoc.dataType && fieldDoc.dataType[0]).to.equal("boolean");
+    expect(fieldDoc.defaultValue).to.equal(true);
+
+    // TODO: Fix this. No space should be there (added/not-fixed b/c this was
+    // in a PR for different issue)
+    expect(fieldDoc.brief).to.equal(" Field description");
+  });
+});