Merge pull request #93 from webdoc-labs/fix/default-ve

Resolve default value expressions for negative numbers, fail in CI on linting & unit-testing

Author: ShukantPal

azure-pipelines.yml

@@ -36,13 +36,11 @@ steps:
     rush flow
   displayName: "Type check"
   workingDirectory: webdoc
-  continueOnError: true
 
 - script: |
     rush lint
   displayName: "Lint"
   workingDirectory: webdoc
-  continueOnError: true
 
 - script: |
     rush unit-test

packages/webdoc-default-template/helper/renderer-plugins/signature.js

@@ -62,6 +62,9 @@ exports.signaturePlugin = {
       if (!options.noTail && doc.dataType) {
         signature += ": " + linker.linkTo(doc.dataType, undefined, {htmlSafe: false});
       }
+      if (doc.defaultValue) {
+        signature += " = " + doc.defaultValue;
+      }
       break;
     case "ClassDoc":
       if (doc.extends) {

packages/webdoc-parser/src/symbols-babel/extract-symbol.js

@@ -5,6 +5,7 @@
 
 import {
   type ArrowFunctionExpression,
+  type BabelNodeExpression,
   type FunctionExpression,
   type MemberExpression,
   type Node,
@@ -18,6 +19,7 @@ import {
   isClassExpression,
   isClassMethod,
   isClassProperty,
+  isExpression,
   isExpressionStatement,
   isFunctionDeclaration,
   isFunctionExpression,
@@ -40,6 +42,7 @@ import {
   isTSPropertySignature,
   isTSTypeElement,
   isThisExpression,
+  isUnaryExpression,
   isVariableDeclarator,
 } from "@babel/types";
 
@@ -129,6 +132,16 @@ export default function extractSymbol(
           nodeSymbol.meta.dataType = createSimpleKeywordType("boolean");
         }
       }
+    } else if (isExpression(node.value)) {
+      const defaultValue = resolveExpression(node.value);
+
+      if (typeof defaultValue === "string") {
+        nodeSymbol.meta.defaultValue = defaultValue;
+
+        if (!isNaN(parseFloat(defaultValue))) {
+          nodeSymbol.meta.dataType = createSimpleKeywordType("number");
+        }
+      }
     }
   } else if (isClassDeclaration(node) || isClassExpression(node)) {
     // Example:
@@ -391,6 +404,21 @@ function resolveRootObject(expression: MemberExpression): string {
   return isThisExpression(expression) ? "this" : expression.name;
 }
 
+// Used to get default value
+// TODO: Resolve a lot more expressions
+function resolveExpression(expression: BabelNodeExpression): string | void {
+  if (isLiteral(expression)) {
+    if (isStringLiteral(expression)) {
+      return `"${expression.value}"`;
+    } else {
+      return `${expression.value}`;
+    }
+  }
+  if (isUnaryExpression(expression)) {
+    return `-${resolveExpression(expression.argument) || ""}`;
+  }
+}
+
 // Whether the member expression assigns to this, e.g.
 // this.member.inside.deep -> true
 // top.inside -> false

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 readonly initProperty: number = 11;
+        private readonly initProperty: number = -11;
 
         constructor() {
           /**
@@ -47,7 +47,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.meta.defaultValue).to.equal("-11");
     expect(symbolInitProperty.comment).to.not.equal("");
     expect(symbolInitProperty.meta.readonly).to.equal(true);
   });