add handling for next-codemod-ignore

vercel · Oct 11, 2024 · 4f0b070 · 4f0b070
1 parent ae38de9
commit 4f0b070
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 3 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
@@ -26,3 +26,9 @@ export function POST(req, ctx) {
     { ...req }
   )
 }
+
+export function PATCH(req, ctx) {
+  console.log(
+    { /* @next-codemod-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
@@ -29,3 +29,9 @@ export function POST(req, ctx) {
     { ...req }
   )
 }
+
+export function PATCH(req, ctx) {
+  console.log(
+    { /* @next-codemod-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
@@ -18,6 +18,7 @@ export type FunctionScope =
   | ArrowFunctionExpression
 
 export const NEXT_CODEMOD_ERROR_PREFIX = '@next-codemod-error'
+const NEXT_CODEMOD_IGNORE_ERROR_PREFIX = '@next-codemod-ignore'
 
 export const TARGET_ROUTE_EXPORTS = new Set([
   'GET',
@@ -429,10 +430,28 @@ export function insertCommentOnce(
   j: API['j'],
   comment: string
 ): boolean {
+  const isCodemodErrorComment = comment
+    .trim()
+    .startsWith(NEXT_CODEMOD_ERROR_PREFIX)
+
+  let hasIgnoreComment = false
+  let hasComment = false
   if (node.comments) {
-    const hasComment = node.comments.some(
-      (commentNode) => commentNode.value === comment
-    )
+    node.comments.forEach((commentNode) => {
+      const currentComment = commentNode.value
+      if (currentComment.trim().startsWith(NEXT_CODEMOD_IGNORE_ERROR_PREFIX)) {
+        hasIgnoreComment = true
+      }
+      if (currentComment === comment) {
+        hasComment = true
+      }
+    })
+    // If it's inserting codemod error comment,
+    // check if there's already a @next-codemod-ignore comment.
+    // if ignore comment exists, bypass the comment insertion.
+    if (hasIgnoreComment && isCodemodErrorComment) {
+      return false
+    }
     if (hasComment) {
       return false
     }