@next/codemod 16.3.0-preview.9 → 16.3.1-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next/codemod",
-  "version": "16.3.0-preview.9",
+  "version": "16.3.1-canary.0",
   "license": "MIT",
   "repository": {
     "type": "git",

package/transforms/remove-partial-prefetch.js

@@ -5,6 +5,17 @@ const parser_1 = require("../lib/parser");
 // Route Segment Config name and the only value this codemod strips.
 const CONFIG_NAME = 'prefetch';
 const TARGET_VALUE = 'partial';
+const GENERATED_GUIDE_COMMENT = 'See: https://nextjs.org/docs/app/guides/adopting-partial-prefetching';
+function isGeneratedGuideComment(comment) {
+    return comment.value.trim() === GENERATED_GUIDE_COMMENT;
+}
+function removeGeneratedGuideComment(node) {
+    for (const target of [node, node.declaration]) {
+        if (!target?.comments)
+            continue;
+        target.comments = target.comments.filter((comment) => !isGeneratedGuideComment(comment));
+    }
+}
 // Unwrap `'partial' as const` / `'partial' satisfies T` so the value guard
 // still matches when the export is annotated.
 function unwrap(j, node) {
@@ -40,7 +51,7 @@ function stripTargetDeclarators(j, declaration) {
 // leading comments to the next statement (or the previous one when the
 // removed statement is last) so they survive the removal.
 function preserveLeadingComments(path) {
-    const comments = path.node.comments?.filter((comment) => comment.leading);
+    const comments = path.node.comments?.filter((comment) => comment.leading && !isGeneratedGuideComment(comment));
     if (!comments?.length) {
         return;
     }
@@ -88,6 +99,7 @@ function transformer(file, _api) {
             declaration.declarations.some((decl) => isTargetPrefetch(j, decl)));
     })
         .forEach((path) => {
+        removeGeneratedGuideComment(path.node);
         const declaration = path.node.declaration;
         const remaining = stripTargetDeclarators(j, declaration);
         // Remove the whole export only when nothing else was declared with it.
@@ -146,6 +158,7 @@ function transformer(file, _api) {
             return path.node.declarations.some((decl) => isTargetPrefetch(j, decl));
         })
             .forEach((path) => {
+            removeGeneratedGuideComment(path.node);
             const remaining = stripTargetDeclarators(j, path.node);
             if (remaining === 0) {
                 preserveLeadingComments(path);