diff --git a/src/lib/converter/convert-expression.ts b/src/lib/converter/convert-expression.ts index af1401cb9..8c1e4e666 100644 --- a/src/lib/converter/convert-expression.ts +++ b/src/lib/converter/convert-expression.ts @@ -17,19 +17,20 @@ export function convertDefaultValue( } } -export function convertExpression(expression: ts.Expression): string { +export function convertExpression( + expression: ts.Expression +): string | undefined { switch (expression.kind) { case ts.SyntaxKind.StringLiteral: - return '"' + (expression).text + '"'; - case ts.SyntaxKind.NumericLiteral: - return (expression).text; case ts.SyntaxKind.TrueKeyword: - return "true"; case ts.SyntaxKind.FalseKeyword: - return "false"; case ts.SyntaxKind.NullKeyword: - return "null"; + case ts.SyntaxKind.NumericLiteral: + case ts.SyntaxKind.PrefixUnaryExpression: + return expression.getText(); default: - return expression.getText(expression.getSourceFile()); + // 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/alias/specs.json b/src/test/converter/alias/specs.json index e4fbf39b0..9d60e0d99 100644 --- a/src/test/converter/alias/specs.json +++ b/src/test/converter/alias/specs.json @@ -118,7 +118,7 @@ ], "name": "Example" }, - "defaultValue": "makeExample()" + "defaultValue": "..." }, { "id": 33, @@ -133,7 +133,7 @@ "id": 29, "name": "ExampleParam" }, - "defaultValue": "makeExample2()" + "defaultValue": "..." }, { "id": 38, @@ -154,7 +154,7 @@ ], "name": "HasProp" }, - "defaultValue": "makeProp(1)" + "defaultValue": "..." } ], "groups": [ diff --git a/src/test/converter/function/specs.json b/src/test/converter/function/specs.json index 9e1a15a84..8d3578909 100644 --- a/src/test/converter/function/specs.json +++ b/src/test/converter/function/specs.json @@ -757,7 +757,7 @@ "type": "intrinsic", "name": "number" }, - "defaultValue": "Number.NaN" + "defaultValue": "..." }, { "id": 18, @@ -787,7 +787,7 @@ "type": "intrinsic", "name": "boolean" }, - "defaultValue": "null!" + "defaultValue": "..." } ], "type": { diff --git a/src/test/converter/types/specs.json b/src/test/converter/types/specs.json index 49e7f8469..ab448fd6a 100644 --- a/src/test/converter/types/specs.json +++ b/src/test/converter/types/specs.json @@ -79,7 +79,7 @@ "negative": false } }, - "defaultValue": "makeValue<1n>()" + "defaultValue": "..." }, { "id": 5, @@ -96,7 +96,7 @@ "negative": true } }, - "defaultValue": "makeValue<-1n>()" + "defaultValue": "..." }, { "id": 7, @@ -113,7 +113,7 @@ "name": "number" } }, - "defaultValue": "makeValue()" + "defaultValue": "..." } ], "groups": [ @@ -602,7 +602,7 @@ } ] }, - "defaultValue": "returnMapped()" + "defaultValue": "..." } ], "groups": [ @@ -730,7 +730,7 @@ "name": "symbol" } }, - "defaultValue": "Symbol()" + "defaultValue": "..." } ], "groups": [ diff --git a/src/test/converter/variables/specs.json b/src/test/converter/variables/specs.json index 386434ace..64cff679f 100644 --- a/src/test/converter/variables/specs.json +++ b/src/test/converter/variables/specs.json @@ -247,7 +247,7 @@ } } }, - "defaultValue": "[]" + "defaultValue": "..." }, { "id": 8, @@ -271,7 +271,7 @@ ], "name": "Array" }, - "defaultValue": "{}" + "defaultValue": "..." } ], "groups": [ @@ -621,7 +621,7 @@ ] } }, - "defaultValue": "(errorCallback: () => any) => {\n onError = errorCallback;\n return callbackReturn;\n }" + "defaultValue": "..." }, { "id": 64, @@ -684,7 +684,7 @@ ] } }, - "defaultValue": "(finallyCallback: () => any) => {\n onFinally = finallyCallback;\n return callbackReturn;\n }" + "defaultValue": "..." }, { "id": 52, @@ -747,7 +747,7 @@ ] } }, - "defaultValue": "(successCallback: () => any) => {\n onSuccess = successCallback;\n return callbackReturn;\n }" + "defaultValue": "..." } ], "groups": [ @@ -763,7 +763,7 @@ ] } }, - "defaultValue": "{\n success: (successCallback: () => any) => {\n onSuccess = successCallback;\n return callbackReturn;\n },\n error: (errorCallback: () => any) => {\n onError = errorCallback;\n return callbackReturn;\n },\n finally: (finallyCallback: () => any) => {\n onFinally = finallyCallback;\n return callbackReturn;\n },\n}" + "defaultValue": "..." }, { "id": 70, @@ -873,7 +873,7 @@ "name": "number" } }, - "defaultValue": "[100, 200, 300]" + "defaultValue": "..." }, { "id": 79, @@ -940,7 +940,7 @@ "type": "intrinsic", "name": "string" }, - "defaultValue": "z" + "defaultValue": "..." } ], "groups": [ @@ -959,7 +959,7 @@ ] } }, - "defaultValue": "(z: string) => {\n return { a: \"test\", b: z };\n }" + "defaultValue": "..." }, { "id": 78, @@ -987,7 +987,7 @@ ] } }, - "defaultValue": "{\n valueZ: \"foo\",\n valueY: (z: string) => {\n return { a: \"test\", b: z };\n },\n valueA: [100, 200, 300],\n }" + "defaultValue": "..." }, { "id": 73, @@ -1018,7 +1018,7 @@ ] } }, - "defaultValue": "function () {\n return \"foo\";\n }" + "defaultValue": "..." }, { "id": 72, @@ -1051,7 +1051,7 @@ ] } }, - "defaultValue": "{\n valueZ: \"foo\",\n valueY: function () {\n return \"foo\";\n },\n valueX: {\n valueZ: \"foo\",\n valueY: (z: string) => {\n return { a: \"test\", b: z };\n },\n valueA: [100, 200, 300],\n },\n valueA: 100,\n valueB: true,\n [Symbol.toStringTag]: \"computed\",\n [x]: true,\n [\"literal2\"]: true,\n}" + "defaultValue": "..." }, { "id": 31, diff --git a/src/test/converter/variables/specs.nodoc.json b/src/test/converter/variables/specs.nodoc.json index 386434ace..64cff679f 100644 --- a/src/test/converter/variables/specs.nodoc.json +++ b/src/test/converter/variables/specs.nodoc.json @@ -247,7 +247,7 @@ } } }, - "defaultValue": "[]" + "defaultValue": "..." }, { "id": 8, @@ -271,7 +271,7 @@ ], "name": "Array" }, - "defaultValue": "{}" + "defaultValue": "..." } ], "groups": [ @@ -621,7 +621,7 @@ ] } }, - "defaultValue": "(errorCallback: () => any) => {\n onError = errorCallback;\n return callbackReturn;\n }" + "defaultValue": "..." }, { "id": 64, @@ -684,7 +684,7 @@ ] } }, - "defaultValue": "(finallyCallback: () => any) => {\n onFinally = finallyCallback;\n return callbackReturn;\n }" + "defaultValue": "..." }, { "id": 52, @@ -747,7 +747,7 @@ ] } }, - "defaultValue": "(successCallback: () => any) => {\n onSuccess = successCallback;\n return callbackReturn;\n }" + "defaultValue": "..." } ], "groups": [ @@ -763,7 +763,7 @@ ] } }, - "defaultValue": "{\n success: (successCallback: () => any) => {\n onSuccess = successCallback;\n return callbackReturn;\n },\n error: (errorCallback: () => any) => {\n onError = errorCallback;\n return callbackReturn;\n },\n finally: (finallyCallback: () => any) => {\n onFinally = finallyCallback;\n return callbackReturn;\n },\n}" + "defaultValue": "..." }, { "id": 70, @@ -873,7 +873,7 @@ "name": "number" } }, - "defaultValue": "[100, 200, 300]" + "defaultValue": "..." }, { "id": 79, @@ -940,7 +940,7 @@ "type": "intrinsic", "name": "string" }, - "defaultValue": "z" + "defaultValue": "..." } ], "groups": [ @@ -959,7 +959,7 @@ ] } }, - "defaultValue": "(z: string) => {\n return { a: \"test\", b: z };\n }" + "defaultValue": "..." }, { "id": 78, @@ -987,7 +987,7 @@ ] } }, - "defaultValue": "{\n valueZ: \"foo\",\n valueY: (z: string) => {\n return { a: \"test\", b: z };\n },\n valueA: [100, 200, 300],\n }" + "defaultValue": "..." }, { "id": 73, @@ -1018,7 +1018,7 @@ ] } }, - "defaultValue": "function () {\n return \"foo\";\n }" + "defaultValue": "..." }, { "id": 72, @@ -1051,7 +1051,7 @@ ] } }, - "defaultValue": "{\n valueZ: \"foo\",\n valueY: function () {\n return \"foo\";\n },\n valueX: {\n valueZ: \"foo\",\n valueY: (z: string) => {\n return { a: \"test\", b: z };\n },\n valueA: [100, 200, 300],\n },\n valueA: 100,\n valueB: true,\n [Symbol.toStringTag]: \"computed\",\n [x]: true,\n [\"literal2\"]: true,\n}" + "defaultValue": "..." }, { "id": 31, diff --git a/src/test/renderer/specs/modules/enumerations.size.html b/src/test/renderer/specs/modules/enumerations.size.html index 3eb38c9a4..7e4155bc9 100644 --- a/src/test/renderer/specs/modules/enumerations.size.html +++ b/src/test/renderer/specs/modules/enumerations.size.html @@ -99,7 +99,7 @@

Variables

Let defaultSize

-
defaultSize: Size = Size.Medium
+
defaultSize: Size = ...
diff --git a/src/test/renderer/specs/modules/functions.html b/src/test/renderer/specs/modules/functions.html index e35284d24..39d718c8e 100644 --- a/src/test/renderer/specs/modules/functions.html +++ b/src/test/renderer/specs/modules/functions.html @@ -244,7 +244,7 @@
valueA: stringnumber = 100
  • -
    valueC: number = Number.NaN
    +
    valueC: number = ...
  • valueD: boolean = true
    diff --git a/src/test/renderer/specs/modules/modules.html b/src/test/renderer/specs/modules/modules.html index a93bc8b45..a4645cae9 100644 --- a/src/test/renderer/specs/modules/modules.html +++ b/src/test/renderer/specs/modules/modules.html @@ -129,7 +129,7 @@

    Let exportedGlobalVariabl

    Let objectLiteral

    -
    objectLiteral: { valueA: number; valueB: boolean; valueX: { valueA: number[]; valueY: (z: string) => { a: string; b: string }; valueZ: string }; valueY: () => string; valueZ: string } = {valueZ: "foo",valueY: function () {return "foo";},valueX: {valueZ: "foo",valueY: (z: string) => {return { a: "test", b: z };},valueA: [100, 200, 300],},valueA: 100,valueB: true,}
    +
    objectLiteral: { valueA: number; valueB: boolean; valueX: { valueA: number[]; valueY: (z: string) => { a: string; b: string }; valueZ: string }; valueY: () => string; valueZ: string } = ...
    diff --git a/src/test/renderer/specs/modules/modules.mymodule.html b/src/test/renderer/specs/modules/modules.mymodule.html index c98f7a493..a176602aa 100644 --- a/src/test/renderer/specs/modules/modules.mymodule.html +++ b/src/test/renderer/specs/modules/modules.mymodule.html @@ -107,7 +107,7 @@

    Let exportedModuleVariabl

    Let object

    -
    object: { name: string; print: (value: string) => void } = {/*** An object literal value.*/name: "Test",/*** An object literal function.*/print: function (value: string) {},}
    +
    object: { name: string; print: (value: string) => void } = ...
    diff --git a/src/test/renderer/specs/modules/weird_names.html b/src/test/renderer/specs/modules/weird_names.html index 7181901d9..3f7147cb3 100644 --- a/src/test/renderer/specs/modules/weird_names.html +++ b/src/test/renderer/specs/modules/weird_names.html @@ -83,7 +83,7 @@

    Variables

    Const foo

    -
    foo: { <c-a>: string; =: string } = {"<c-a>": "<c-b>","=": "=",}
    +
    foo: { <c-a>: string; =: string } = ...