fix: ensure leading and trailing trivia for overloads ends up in output

Closes #1244
dsherret · May 21, 2022 · 0d043b5 · 0d043b5
1 parent abc840d
commit 0d043b5
Show file tree

Hide file tree

Showing 7 changed files with 92 additions and 8 deletions.
diff --git a/deno/ts_morph.js b/deno/ts_morph.js
@@ -6319,15 +6319,15 @@ class NodePrinter extends Printer {
         this.printTrailingTrivia(writer, structure);
     }
     printLeadingTrivia(writer, structure) {
-        const leadingTrivia = structure["leadingTrivia"];
+        const leadingTrivia = structure.leadingTrivia;
         if (leadingTrivia != null) {
             this.printTrivia(writer, leadingTrivia);
             if (writer.isInComment())
                 writer.closeComment();
         }
     }
     printTrailingTrivia(writer, structure) {
-        const trailingTrivia = structure["trailingTrivia"];
+        const trailingTrivia = structure.trailingTrivia;
         if (trailingTrivia != null)
             this.printTrivia(writer, trailingTrivia);
     }
@@ -7406,8 +7406,10 @@ class ConstructorDeclarationStructurePrinter extends NodePrinter {
         }
     }
     printOverload(writer, structure) {
+        this.printLeadingTrivia(writer, structure);
         this.printHeader(writer, structure);
         writer.write(";");
+        this.printTrailingTrivia(writer, structure);
     }
     printHeader(writer, structure) {
         this.factory.forJSDoc().printDocs(writer, structure.docs);
@@ -7495,8 +7497,10 @@ class MethodDeclarationStructurePrinter extends NodePrinter {
         }
     }
     printOverload(writer, name, structure) {
+        this.printLeadingTrivia(writer, structure);
         this.printHeader(writer, name, structure);
         writer.write(";");
+        this.printTrailingTrivia(writer, structure);
     }
     printHeader(writer, name, structure) {
         this.factory.forJSDoc().printDocs(writer, structure.docs);
@@ -7877,8 +7881,10 @@ class FunctionDeclarationStructurePrinter extends NodePrinter {
         }
     }
     printOverload(writer, name, structure) {
+        this.printLeadingTrivia(writer, structure);
         this.printHeader(writer, name, structure);
         writer.write(";");
+        this.printTrailingTrivia(writer, structure);
     }
     printHeader(writer, name, structure) {
         this.factory.forJSDoc().printDocs(writer, structure.docs);

diff --git a/packages/ts-morph/src/structurePrinters/NodePrinter.ts b/packages/ts-morph/src/structurePrinters/NodePrinter.ts
@@ -22,8 +22,8 @@ export abstract class NodePrinter<TStructure> extends Printer<TStructure> {
 
   protected abstract printTextInternal(writer: CodeBlockWriter, structure: TStructure): void;
 
-  printLeadingTrivia(writer: CodeBlockWriter, structure: TStructure) {
-    const leadingTrivia = (structure as any)["leadingTrivia"] as Structure["leadingTrivia"];
+  printLeadingTrivia(writer: CodeBlockWriter, structure: { leadingTrivia?: Structure["leadingTrivia"] }) {
+    const leadingTrivia = structure.leadingTrivia;
 
     if (leadingTrivia != null) {
       this.printTrivia(writer, leadingTrivia);
@@ -33,8 +33,8 @@ export abstract class NodePrinter<TStructure> extends Printer<TStructure> {
     }
   }
 
-  printTrailingTrivia(writer: CodeBlockWriter, structure: TStructure) {
-    const trailingTrivia = (structure as any)["trailingTrivia"] as Structure["trailingTrivia"];
+  printTrailingTrivia(writer: CodeBlockWriter, structure: { trailingTrivia?: Structure["leadingTrivia"] }) {
+    const trailingTrivia = structure.trailingTrivia;
 
     if (trailingTrivia != null)
       this.printTrivia(writer, trailingTrivia);

diff --git a/packages/ts-morph/src/structurePrinters/class/ConstructorDeclarationStructurePrinter.ts b/packages/ts-morph/src/structurePrinters/class/ConstructorDeclarationStructurePrinter.ts
@@ -61,8 +61,10 @@ export class ConstructorDeclarationStructurePrinter extends NodePrinter<Optional
   }
 
   printOverload(writer: CodeBlockWriter, structure: OptionalKind<ConstructorDeclarationOverloadStructure>) {
+    this.printLeadingTrivia(writer, structure);
     this.printHeader(writer, structure);
     writer.write(";");
+    this.printTrailingTrivia(writer, structure);
   }
 
   private printHeader(writer: CodeBlockWriter, structure: OptionalKind<ConstructorDeclarationStructure | ConstructorDeclarationOverloadStructure>) {

diff --git a/packages/ts-morph/src/structurePrinters/class/MethodDeclarationStructurePrinter.ts b/packages/ts-morph/src/structurePrinters/class/MethodDeclarationStructurePrinter.ts
@@ -65,8 +65,10 @@ export class MethodDeclarationStructurePrinter extends NodePrinter<OptionalKind<
   }
 
   printOverload(writer: CodeBlockWriter, name: string, structure: OptionalKind<MethodDeclarationOverloadStructure>) {
+    this.printLeadingTrivia(writer, structure);
     this.printHeader(writer, name, structure);
     writer.write(";");
+    this.printTrailingTrivia(writer, structure);
   }
 
   private printHeader(

diff --git a/packages/ts-morph/src/structurePrinters/function/FunctionDeclarationStructurePrinter.ts b/packages/ts-morph/src/structurePrinters/function/FunctionDeclarationStructurePrinter.ts
@@ -70,8 +70,10 @@ export class FunctionDeclarationStructurePrinter extends NodePrinter<OptionalKin
   }
 
   printOverload(writer: CodeBlockWriter, name: string | undefined, structure: OptionalKind<FunctionDeclarationOverloadStructure>) {
+    this.printLeadingTrivia(writer, structure);
     this.printHeader(writer, name, structure);
     writer.write(";");
+    this.printTrailingTrivia(writer, structure);
   }
 
   private printHeader(

diff --git a/packages/ts-morph/src/tests/issues/1244tests.ts b/packages/ts-morph/src/tests/issues/1244tests.ts
@@ -0,0 +1,72 @@
+import { expect } from "chai";
+import { Project } from "../../Project";
+import { StructureKind } from "../../structures";
+
+describe("tests for issue #1244", () => {
+  it("write leading and trailing trivia on overloads", () => {
+    const project = new Project({ useInMemoryFileSystem: true, skipLoadingLibFiles: true });
+
+    const file = project.createSourceFile("test.ts", ``);
+    file.addStatements([{
+      kind: StructureKind.Function,
+      leadingTrivia: "// leading trivia function",
+      trailingTrivia: "// trailing trivia function",
+      overloads: [
+        {
+          leadingTrivia: "// leading trivia overload",
+          trailingTrivia: "// trailing trivia overload",
+          returnType: "string",
+        },
+      ],
+      name: "functionName",
+      statements: "return 'hello';",
+    }, {
+      kind: StructureKind.Class,
+      name: "MyClass",
+      methods: [{
+        leadingTrivia: "// leading trivia method",
+        trailingTrivia: "// trailing trivia method",
+        overloads: [
+          {
+            leadingTrivia: "// leading trivia overload",
+            trailingTrivia: "// trailing trivia overload",
+            returnType: "string",
+          },
+        ],
+        name: "method",
+      }],
+      ctors: [{
+        leadingTrivia: "// leading trivia ctor",
+        trailingTrivia: "// trailing trivia ctor",
+        overloads: [
+          {
+            leadingTrivia: "// leading trivia overload",
+            trailingTrivia: "// trailing trivia overload",
+          },
+        ],
+      }],
+    }]);
+
+    expect(file.getFullText()).to.equal(`// leading trivia function
+// leading trivia overload
+function functionName(): string;// trailing trivia overload
+function functionName() {
+    return 'hello';
+}// trailing trivia function
+
+class MyClass {
+    // leading trivia ctor
+    // leading trivia overload
+    constructor();// trailing trivia overload
+    constructor() {
+    }// trailing trivia ctor
+
+    // leading trivia method
+    // leading trivia overload
+    method(): string;// trailing trivia overload
+    method() {
+    }// trailing trivia method
+}
+`);
+  });
+});
diff --git a/packages/ts-morph/src/tests/issues/1273tests.ts b/packages/ts-morph/src/tests/issues/1273tests.ts
@@ -2,8 +2,8 @@ import { ts } from "@ts-morph/common";
 import { expect } from "chai";
 import { Project } from "../../Project";
 
-describe("tests for issue #1227", () => {
-  it("should find referencing source files", () => {
+describe("tests for issue #1273", () => {
+  it("should output synthetic comments on nodes with only addSyntheticLeadingComment", () => {
     const project = new Project({ useInMemoryFileSystem: true, compilerOptions: { removeComments: false } });
 
     const file = project.createSourceFile("x.ts", `const x: number = 5 * 9;`);