give hint of codemod ignore in swc

crates/next-custom-transforms/src/transforms/lint_codemod_comments.rs

@@ -21,7 +21,8 @@ where
 }
 
 // declare a const of comment prefix
-const COMMENT_PREFIX: &str = "@next-codemod-error";
+const COMMENT_ERROR_PREFIX: &str = "@next-codemod-error";
+const COMMENT_BYPASS_PREFIX: &str = "@next-codemod-ignore";
 
 impl<C> LintErrorComment<C>
 where
@@ -31,7 +32,7 @@ where
         let trimmed_text = comment.text.trim();
         // if comment contains @next/codemod comment "@next-codemod-error",
         // report an error from the linter to fail the build
-        if trimmed_text.contains(COMMENT_PREFIX) {
+        if trimmed_text.contains(COMMENT_ERROR_PREFIX) {
             let span = if is_leading {
                 comment
                     .span
@@ -41,11 +42,14 @@ where
                     .span
                     .with_hi(comment.span.hi() + swc_core::common::BytePos(1))
             };
-            let action = trimmed_text.replace(COMMENT_PREFIX, "");
+            let action = trimmed_text.replace(COMMENT_ERROR_PREFIX, "");
             let err_message = format!(
-                "You have unresolved @next/codemod comments that need to be reviewed, please \
-                 address and remove them to proceed with the build.\nAction: \"{}\"",
-                action
+                "You have unresolved @next/codemod comment \"{}\" that need to be reviewed, \
+                 please address and remove them to proceed with the build.\nYou can also bypass \
+                 the build error by replacing \"{}\" with \"{}\".",
+                action.trim(),
+                COMMENT_ERROR_PREFIX,
+                COMMENT_BYPASS_PREFIX
             );
             report(span, &err_message);
         }

test/e2e/app-dir/error-on-next-codemod-comment/error-on-next-codemod-comment.test.ts

@@ -29,52 +29,76 @@ describe('app-dir - error-on-next-codemod-comment', () => {
           Ecmascript file had an error
             1 | export default function Page() {
           > 2 |   // @next-codemod-error remove jsx of next line
-              |  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+              |  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             3 |   return <p>hello world</p>
             4 | }
             5 |
 
-          You have unresolved @next/codemod comments that need to be reviewed, please address and remove them to proceed with the build.
-          Action: " remove jsx of next line""
+          You have unresolved @next/codemod comment "remove jsx of next line" that need to be reviewed, please address and remove them to proceed with the build.
+          You can also bypass the build error by replacing "@next-codemod-error" with "@next-codemod-ignore"."
         `)
       } else {
         expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
           "./app/page.tsx
-          Error:   x You have unresolved @next/codemod comment needs to be removed, please address and remove it to proceed build.
-            | Action: " remove jsx of next line"
+          Error:   x You have unresolved @next/codemod comment "remove jsx of next line" that need to be reviewed, please address and remove them to proceed with the build.
+            | You can also bypass the build error by replacing "@next-codemod-error" with "@next-codemod-ignore".
              ,-[2:1]
            1 | export default function Page() {
            2 |   // @next-codemod-error remove jsx of next line
-             :  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+             :  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
            3 |   return <p>hello world</p>
            4 | }
              \`----"
         `)
       }
     })
 
-    it('should disappear the error when you remove the codemod comment', async () => {
+    it('should disappear the error when you rre the codemod comment', async () => {
       const browser = await next.browser('/')
 
       await assertHasRedbox(browser)
 
-      await next.patchFile(
-        'app/page.tsx',
-        `
-        export default function Page() { return <p>hello world</p> }
-      `
-      )
+      let originFileContent
+      await next.patchFile('app/page.tsx', (code) => {
+        originFileContent = code
+        return code.replace(
+          '// @next-codemod-error remove jsx of next line',
+          ''
+        )
+      })
 
       await retry(async () => {
         await assertNoRedbox(browser)
       })
+
+      // Recover the original file content
+      await next.patchFile('app/page.tsx', originFileContent)
+    })
+
+    it('should disappear the error when you replace with bypass comment', async () => {
+      const browser = await next.browser('/')
+
+      await assertHasRedbox(browser)
+
+      let originFileContent
+      await next.patchFile('app/page.tsx', (code) => {
+        originFileContent = code
+        return code.replace('@next-codemod-error', '@next-codemod-bypass')
+      })
+
+      await retry(async () => {
+        await assertNoRedbox(browser)
+      })
+
+      // Recover the original file content
+      await next.patchFile('app/page.tsx', originFileContent)
     })
   } else {
     it('should fail the build with next build', async () => {
       const res = await next.build()
       expect(res.exitCode).toBe(1)
       expect(res.cliOutput).toContain(
-        'You have unresolved @next/codemod comments that need to be reviewed, please address and remove them to proceed with the build.'
+        'You have unresolved @next/codemod comment "remove jsx of next line" that need to be reviewed, please address and remove them to proceed with the build'
       )
     })
   }