Add support for initializers which are identifiers

Resolves #1730.
TypeStrong · Oct 10, 2021 · 4b927ff · 4b927ff
1 parent 0d04c08
commit 4b927ff
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Unreleased
 
+### Features
+
+-   Added support for displaying identifiers & property access expressions in initializers, #1730.
+
 ### Bug Fixes
 
 -   Fixed flash when navigating to a second page when OS theme does not match selected theme, #1709.

diff --git a/src/lib/converter/convert-expression.ts b/src/lib/converter/convert-expression.ts
@@ -17,14 +17,15 @@ export function convertDefaultValue(
     }
 }
 
-export function convertExpression(expression: ts.Expression) {
+export function convertExpression(expression: ts.Expression): string {
     switch (expression.kind) {
         case ts.SyntaxKind.StringLiteral:
         case ts.SyntaxKind.TrueKeyword:
         case ts.SyntaxKind.FalseKeyword:
         case ts.SyntaxKind.NullKeyword:
         case ts.SyntaxKind.NumericLiteral:
         case ts.SyntaxKind.PrefixUnaryExpression:
+        case ts.SyntaxKind.Identifier:
             return expression.getText();
     }
 
@@ -42,6 +43,21 @@ export function convertExpression(expression: ts.Expression) {
         return "{}";
     }
 
+    // a.b.c.d
+    if (ts.isPropertyAccessExpression(expression)) {
+        const parts = [expression.name.getText()];
+        let iter = expression.expression;
+        while (ts.isPropertyAccessExpression(iter)) {
+            parts.unshift(iter.name.getText());
+            iter = iter.expression;
+        }
+
+        if (ts.isIdentifier(iter)) {
+            parts.unshift(iter.text);
+            return parts.join(".");
+        }
+    }
+
     // More complex expressions are generally not useful in the documentation.
     // Show that there was a value, but not specifics.
     return "...";

diff --git a/src/test/converter/exports/specs.json b/src/test/converter/exports/specs.json
@@ -110,7 +110,7 @@
                 "type": "literal",
                 "value": 1
               },
-              "defaultValue": "..."
+              "defaultValue": "Mod.a"
             },
             {
               "id": 24,
@@ -123,7 +123,7 @@
                 "id": 29,
                 "name": "__module"
               },
-              "defaultValue": "..."
+              "defaultValue": "Mod"
             },
             {
               "id": 27,
@@ -136,7 +136,7 @@
                 "id": 29,
                 "name": "a"
               },
-              "defaultValue": "..."
+              "defaultValue": "Mod.a"
             },
             {
               "id": 25,
@@ -149,7 +149,7 @@
                 "id": 29,
                 "name": "__module"
               },
-              "defaultValue": "..."
+              "defaultValue": "Mod"
             }
           ],
           "groups": [

diff --git a/src/test/converter/function/specs.json b/src/test/converter/function/specs.json
@@ -1090,7 +1090,7 @@
                     "type": "intrinsic",
                     "name": "number"
                   },
-                  "defaultValue": "..."
+                  "defaultValue": "Number.NaN"
                 },
                 {
                   "id": 18,

diff --git a/src/test/converter/variables/specs.json b/src/test/converter/variables/specs.json
@@ -911,7 +911,7 @@
                                             "type": "intrinsic",
                                             "name": "string"
                                           },
-                                          "defaultValue": "..."
+                                          "defaultValue": "z"
                                         }
                                       ],
                                       "groups": [