handle leading comments

vercel · Oct 11, 2024 · ff7c9a5 · ff7c9a5
1 parent 82d7e98
commit ff7c9a5
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 9 deletions.
diff --git a/...ransforms/__testfixtures__/next-async-request-api-dynamic-props/access-props-27.input.tsx b/...ransforms/__testfixtures__/next-async-request-api-dynamic-props/access-props-27.input.tsx
@@ -32,3 +32,21 @@ export function PATCH(req, ctx) {
     { /* @next-codemod-ignore */ ...ctx }
   )
 }
+
+export function PUT(req, ctx) {
+  console.log(
+    {
+      // @next-codemod-ignore
+      ...ctx
+    }
+  )
+}
+
+export function OPTIONS(req, ctx) {
+  console.log(
+    {
+      // @next-codemod-incorrect-ignore
+      ...ctx
+    }
+  )
+}
diff --git a/...ansforms/__testfixtures__/next-async-request-api-dynamic-props/access-props-27.output.tsx b/...ansforms/__testfixtures__/next-async-request-api-dynamic-props/access-props-27.output.tsx
@@ -35,3 +35,22 @@ export function PATCH(req, ctx) {
     { /* @next-codemod-ignore */ ...ctx }
   )
 }
+
+export function PUT(req, ctx) {
+  console.log(
+    {
+      // @next-codemod-ignore
+      ...ctx
+    }
+  )
+}
+
+export function OPTIONS(req, ctx) {
+  console.log(
+    {
+      /* @next-codemod-error 'ctx' is used with spread syntax (...). Any asynchronous properties of 'ctx' must be awaited when accessed. */
+      // @next-codemod-incorrect-ignore
+      ...ctx
+    }
+  )
+}
diff --git a/packages/next-codemod/transforms/lib/async-request-api/utils.ts b/packages/next-codemod/transforms/lib/async-request-api/utils.ts
@@ -425,9 +425,8 @@ export function wrapParentheseIfNeeded(
   return hasChainAccess ? j.parenthesizedExpression(expression) : expression
 }
 
-export function insertCommentOnce(
-  node: ASTPath<any>['node'],
-  j: API['j'],
+function existsComment(
+  comments: ASTPath<any>['node']['comments'],
   comment: string
 ): boolean {
   const isCodemodErrorComment = comment
@@ -436,8 +435,9 @@ export function insertCommentOnce(
 
   let hasIgnoreComment = false
   let hasComment = false
-  if (node.comments) {
-    node.comments.forEach((commentNode) => {
+
+  if (comments) {
+    comments.forEach((commentNode) => {
       const currentComment = commentNode.value
       if (currentComment.trim().startsWith(NEXT_CODEMOD_IGNORE_ERROR_PREFIX)) {
         hasIgnoreComment = true
@@ -450,14 +450,33 @@ export function insertCommentOnce(
     // check if there's already a @next-codemod-ignore comment.
     // if ignore comment exists, bypass the comment insertion.
     if (hasIgnoreComment && isCodemodErrorComment) {
-      return false
+      return true
     }
     if (hasComment) {
-      return false
+      return true
     }
   }
-  node.comments = [j.commentBlock(comment), ...(node.comments || [])]
-  return true
+  return false
+}
+
+export function insertCommentOnce(
+  node: ASTPath<any>['node'],
+  j: API['j'],
+  comment: string
+): boolean {
+  const hasCommentInInlineComments = existsComment(node.comments, comment)
+  const hasCommentInLeadingComments = existsComment(
+    node.leadingComments,
+    comment
+  )
+
+  if (!hasCommentInInlineComments && !hasCommentInLeadingComments) {
+    // Always insert into inline comment
+    node.comments = [j.commentBlock(comment), ...(node.comments || [])]
+    return true
+  }
+
+  return false
 }
 
 export function getVariableDeclaratorId(