fix: variadic arguments are incorrectly displayed as base type in docs

src/docgen/schema.ts

@@ -104,6 +104,10 @@ export interface ParameterSchema extends Optional, Documentable {
    */
   readonly type: TypeSchema;
 
+  /**
+   * Whether the parameter is variadic.
+   */
+  readonly variadic: boolean;
 }
 
 /**

src/docgen/transpile/csharp.ts

@@ -132,6 +132,7 @@ export class CSharpTranspile extends transpile.TranspileBase {
       parentType: this.type(parameter.parentType),
       typeReference: typeRef,
       optional: parameter.optional,
+      variadic: parameter.variadic,
       declaration: this.formatParameter(name, typeRef),
     };
   }
@@ -144,6 +145,7 @@ export class CSharpTranspile extends transpile.TranspileBase {
       parentType: this.type(property.parentType),
       typeReference: typeRef,
       optional: property.optional,
+      variadic: false,
       declaration: this.formatProperty(name, typeRef, property),
     };
   }
@@ -217,6 +219,10 @@ export class CSharpTranspile extends transpile.TranspileBase {
       typeFormatter: (t) => t.name,
     });
     const suffix = transpiled.optional ? ' = null' : '';
+
+    if (transpiled.variadic) {
+      return `params ${tf}[] ${transpiled.name}${suffix}`;
+    }
     return `${tf} ${transpiled.name}${suffix}`;
   }
 

src/docgen/transpile/go.ts

@@ -142,7 +142,8 @@ export class GoTranspile extends transpile.TranspileBase {
       parentType: this.type(parameter.parentType),
       typeReference: typeRef,
       optional: parameter.optional,
-      declaration: this.formatParameter(name, typeRef),
+      variadic: parameter.variadic,
+      declaration: this.formatParameter(name, typeRef, parameter.variadic),
     };
   }
 
@@ -154,6 +155,8 @@ export class GoTranspile extends transpile.TranspileBase {
       parentType: this.type(property.parentType),
       typeReference: typeRef,
       optional: property.optional,
+      // Only parameters can be variadic, not properties.
+      variadic: false,
       declaration: this.formatProperty(name, typeRef, property),
     };
   }
@@ -219,18 +222,22 @@ export class GoTranspile extends transpile.TranspileBase {
   private formatFnParam(
     transpiled: transpile.TranspiledParameter | transpile.TranspiledProperty,
   ): string {
-    return this.formatParameter(transpiled.name, transpiled.typeReference);
+    return this.formatParameter(transpiled.name, transpiled.typeReference, transpiled.variadic);
   }
 
   private formatImport(type: transpile.TranspiledType): string {
     return `import "${type.module}${type.submodule ? `/${type.submodule}` : ''}"`;
   }
 
-  private formatParameter(name: string, typeReference: transpile.TranspiledTypeReference) {
+  private formatParameter(name: string, typeReference: transpile.TranspiledTypeReference, variadic: boolean) {
     const tf = typeReference.toString({
       typeFormatter: (t) => t.name,
     });
 
+    if (variadic) {
+      return `${name} ...${tf}`;
+    }
+
     return `${name} ${tf}`;
   }
 

src/docgen/transpile/java.ts

@@ -213,6 +213,7 @@ export class JavaTranspile extends transpile.TranspileBase {
       parentType: this.type(parameter.parentType),
       typeReference: typeRef,
       optional: parameter.optional,
+      variadic: parameter.variadic,
       declaration: this.formatProperty(parameter.name, typeRef),
     };
   }
@@ -224,6 +225,7 @@ export class JavaTranspile extends transpile.TranspileBase {
       parentType: this.type(property.parentType),
       typeReference: typeRef,
       optional: property.optional,
+      variadic: false,
       declaration: this.formatProperty(property.name, typeRef),
     };
   }
@@ -296,6 +298,11 @@ export class JavaTranspile extends transpile.TranspileBase {
     const tf = transpiled.typeReference.toString({
       typeFormatter: (t) => t.name,
     });
+
+    if (transpiled.variadic) {
+      return `${tf} ${transpiled.name}...`;
+    }
+
     return `${tf} ${transpiled.name}`;
   }
 

src/docgen/transpile/python.ts

@@ -150,6 +150,7 @@ export class PythonTranspile extends transpile.TranspileBase {
       parentType: this.type(property.parentType),
       typeReference: typeRef,
       optional: property.optional,
+      variadic: false,
       declaration: this.formatProperty(name, typeRef),
     };
   }
@@ -171,6 +172,7 @@ export class PythonTranspile extends transpile.TranspileBase {
       parentType: this.type(parameter.parentType),
       typeReference: typeRef,
       optional: parameter.optional,
+      variadic: parameter.variadic,
       declaration: this.formatProperty(name, typeRef),
     };
   }
@@ -306,6 +308,11 @@ export class PythonTranspile extends transpile.TranspileBase {
     const tf = transpiled.typeReference.toString({
       typeFormatter: (t) => t.name,
     });
+
+    if (transpiled.variadic) {
+      return `${transpiled.name}: *${tf}${transpiled.optional ? ' = None' : ''}`;
+    }
+
     return `${transpiled.name}: ${tf}${transpiled.optional ? ' = None' : ''}`;
   }
 

src/docgen/transpile/transpile.ts

@@ -213,6 +213,10 @@ export interface TranspiledParameter {
    * Whether or not the parameter is optional.
    */
   readonly optional: boolean;
+  /**
+   * Whether or not the parameter is variadic.
+   */
+  readonly variadic: boolean;
   /**
    * The signature of the property, or its getter if the language
    * supports that.

src/docgen/transpile/typescript.ts

@@ -123,6 +123,7 @@ export class TypeScriptTranspile extends transpile.TranspileBase {
       parentType: this.type(property.parentType),
       typeReference: typeRef,
       optional: property.optional,
+      variadic: false,
       declaration: this.formatProperty(property.name, typeRef),
     };
   }
@@ -143,6 +144,7 @@ export class TypeScriptTranspile extends transpile.TranspileBase {
       parentType: this.type(parameter.parentType),
       typeReference: typeRef,
       optional: parameter.optional,
+      variadic: parameter.variadic,
       declaration: this.formatProperty(parameter.name, typeRef),
     };
   }
@@ -236,6 +238,11 @@ export class TypeScriptTranspile extends transpile.TranspileBase {
     const tf = transpiled.typeReference.toString({
       typeFormatter: (t) => t.name,
     });
+
+    if (transpiled.variadic) {
+      return `${transpiled.name}${transpiled.optional ? '?' : ''}: ...${tf}[]`;
+    }
+
     return `${transpiled.name}${transpiled.optional ? '?' : ''}: ${tf}`;
   }
 

src/docgen/view/parameter.ts

@@ -24,6 +24,7 @@ export class Parameter {
       optional: this.transpiledParam.optional === true ? true : undefined, // to save space
       default: this.parameter.spec.docs?.default,
       type: this.transpiledParam.typeReference.toJson(),
+      variadic: this.parameter.spec.variadic ?? false,
       docs: extractDocs(this.parameter.docs),
     };
   }

test/__fixtures__/assemblies/class-with-variadic-arguments@1.106.0/.jsii

@@ -0,0 +1,207 @@
+{
+  "author": {
+    "email": "john.doe@acme.com",
+    "name": "John Doe",
+    "roles": [
+      "author"
+    ]
+  },
+  "dependencies": {
+    "constructs": "^10.3.0"
+  },
+  "dependencyClosure": {
+    "constructs": {
+      "targets": {
+        "dotnet": {
+          "namespace": "Constructs",
+          "packageId": "Constructs"
+        },
+        "go": {
+          "moduleName": "github.com/aws/constructs-go"
+        },
+        "java": {
+          "maven": {
+            "artifactId": "constructs",
+            "groupId": "software.constructs"
+          },
+          "package": "software.constructs"
+        },
+        "js": {
+          "npm": "constructs"
+        },
+        "python": {
+          "distName": "constructs",
+          "module": "constructs"
+        }
+      }
+    }
+  },
+  "description": "",
+  "docs": {
+    "stability": "stable"
+  },
+  "homepage": "https://github.com/acme/project-name.git",
+  "jsiiVersion": "5.5.1",
+  "keywords": [],
+  "license": "ISC",
+  "metadata": {
+    "jsii": {
+      "pacmak": {
+        "hasDefaultInterfaces": true
+      }
+    },
+    "tscRootDir": "src"
+  },
+  "name": "my-construct-library",
+  "readme": {
+    "markdown": ""
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/acme/project-name.git"
+  },
+  "schema": "jsii/0.10.0",
+  "targets": {
+    "js": {
+      "npm": "my-construct-library"
+    },
+    "python": {
+      "distName": "sumu_constructs.core",
+      "module": "sumu_constructs.core"
+    },
+    "go": {
+      "moduleName": "github.com/acme/project-name"
+    }
+  },
+  "types": {
+    "my-construct-library.MyVariadicClass": {
+      "assembly": "my-construct-library",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "my-construct-library.MyVariadicClass",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/index.ts",
+          "line": 22
+        },
+        "parameters": [
+          {
+            "name": "id",
+            "type": {
+              "primitive": "number"
+            }
+          },
+          {
+            "name": "variadicProps",
+            "type": {
+              "primitive": "number"
+            },
+            "variadic": true
+          }
+        ],
+        "variadic": true
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/index.ts",
+        "line": 19
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 27
+          },
+          "name": "myFunction",
+          "parameters": [
+            {
+              "name": "singleInput",
+              "type": {
+                "primitive": "number"
+              }
+            },
+            {
+              "name": "variadicInput",
+              "type": {
+                "primitive": "number"
+              },
+              "variadic": true
+            }
+          ],
+          "variadic": true
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 27
+          },
+          "name": "myStaticFunction",
+          "parameters": [
+            {
+              "name": "staticSingleInput",
+              "type": {
+                "primitive": "number"
+              }
+            },
+            {
+              "name": "staticVariadicInput",
+              "type": {
+                "primitive": "number"
+              },
+              "variadic": true
+            }
+          ],
+          "variadic": true,
+          "static": true
+        }
+      ],
+      "name": "MyVariadicClass",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 20
+          },
+          "name": "id",
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 21
+          },
+          "name": "props",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "number"
+              },
+              "kind": "array"
+            }
+          }
+        }
+      ],
+      "symbolId": "src/index:MyVariadicClass"
+    }
+  },
+  "version": "1.0.0",
+  "fingerprint": "MVY8gZ0InYVnyxT4u6+25G013Gn2Cz+1MCYVqOonyPs="
+}