Merge pull request #12 from codemodsquad/fix/comments

fix(comments): preserve comments

Author: jedwards1211

src/util/insertStatementsBefore.ts

@@ -8,6 +8,11 @@ export default function insertStatementsBefore<
 >(path: NodePath<any>, statements: Statements): NodePaths<Statements> {
   let target = parentStatement(path)
   const { parentPath } = target
+  const firstStatement = Array.isArray(statements) ? statements[0] : statements
+  if (target.node && firstStatement) {
+    t.inheritLeadingComments(firstStatement, target.node)
+    target.node.leadingComments = null
+  }
   if (
     (parentPath.isBlockParent() || parentPath.isIfStatement()) &&
     !parentPath.isBlockStatement()

src/util/recastBugWorkarounds.ts

@@ -3,6 +3,10 @@ import { NodePath } from '@babel/traverse'
 
 export default function recastBugWorkarounds(path: NodePath<any>): void {
   path.traverse({
+    exit(path: NodePath<t.Node>) {
+      const anyNode = path.node as any
+      anyNode.comments = anyNode.leadingComments
+    },
     AwaitExpression(path: NodePath<t.AwaitExpression>) {
       const argument = path.get('argument')
       const { parentPath } = path

src/util/replaceWithStatements.ts

@@ -15,6 +15,16 @@ export default function replaceWithStatements<Statements extends t.Statement[]>(
       'path must be a child of a BlockParent, SwitchCase, or IfStatement'
     )
   }
+  const oldNode = path.node
+  if (oldNode) {
+    if (oldNode && statements[0]) {
+      t.inheritLeadingComments(statements[0], oldNode)
+    }
+    if (oldNode && statements[statements.length - 1]) {
+      t.inheritTrailingComments(statements[statements.length - 1], oldNode)
+    }
+    t.removeComments(oldNode)
+  }
   if (!parentPath.isBlockStatement()) {
     return (path.replaceWith(t.blockStatement(statements)) as any)[0].get(
       'body'

test/fixtures/bugs_BelongsToMany.create.ts

@@ -50,9 +50,9 @@ class BelongsToMany {
       }
     }
 
+    // Create the related model instance
     const newAssociatedObject = await association.target.create(values, options);
     await sourceInstance[association.accessors.add](newAssociatedObject, _.omit(options, ['fields']));
-    // Create the related model instance
     return newAssociatedObject;
   }
 }

test/fixtures/bugs_Sequelize.transaction.ts

@@ -52,6 +52,8 @@ class Sequelize {
         await transaction.commit();
         return await result;
       } catch (err) {
+        // Rollback transaction if not already finished (commit, rollback, etc)
+        // and reject with original error (ignore any error in rollback)
         if (!transaction.finished) {
           try {
             await transaction.rollback();

test/fixtures/leadingComment.ts

@@ -0,0 +1,21 @@
+export const input = `
+function foo() {
+  // this is a test
+  return bar.then(baz => {
+    return process(baz)
+  }).then(results => {
+    console.log(results)
+  })
+}
+`
+
+export const options = {}
+
+export const expected = `
+async function foo() {
+  // this is a test
+  const baz = await bar
+  const results = await process(baz)
+  console.log(results)
+}
+`