ensure that no 'undefined' docstrings get added for functional dict definitions (#35)

Author: TheLartians

src/parseProperty.ts

@@ -65,7 +65,9 @@ export const getDocumentationStringForDict = (state: ParserState, symbol: ts.Sym
   const documentation = symbol
     .getDocumentationComment(state.typechecker)
     .map((v) => v.text)
+    .filter(v => !!v)
     .join("  \n");
+  
   if (documentation.length > 0) {
     return `${JSON.stringify(name)}: ${documentation}`
   } else {

src/parseTypeDefinition.ts

@@ -53,11 +53,12 @@ export const parseTypeDefinition = (
 
       const propertyDocumentation = properties
         .map((v) => getDocumentationStringForDict(state, v))
-        .filter(v => v !== undefined)
+        .filter(v => !!v)
         .join("\n");
 
-      const innerDocstring = documentation?.replaceAll("\n", "  \n") + (propertyDocumentation.length > 0 ? "\n## Entries\n" + propertyDocumentation : "");
+      const innerDocstring = (documentation ?? "").replaceAll("\n", "  \n") + (propertyDocumentation.length > 0 ? "\n## Entries\n" + propertyDocumentation : "");
       const docstring = innerDocstring.length > 0 ? `\n"""\n${innerDocstring}\n"""` : "";
+
       const definition = `${name} = TypedDict(${JSON.stringify(name)}, {\n  ${parsedProperties.join(",\n  ")}\n})${docstring}`;
 
       state.statements.push(definition);

src/testing/dicts.test.ts

@@ -93,8 +93,10 @@ class A(TypedDict):
     const result = await transpileString(`export type A = {
       "foo.bar"?: string,
     }`);
-    expect(result).toContain(
-      `A = TypedDict("A", {
+    expect(result).toEqual(
+      `from typing_extensions import NotRequired, TypedDict
+
+A = TypedDict("A", {
   "foo.bar": NotRequired[str]
 })`,
     );