@next/codemod 16.4.0-canary.3 → 16.4.0-canary.31

package/README.md

@@ -7,3 +7,14 @@ Codemods are transformations that run on your codebase programmatically. This al
 ## Documentation
 
 Visit [nextjs.org/docs/advanced-features/codemods](https://nextjs.org/docs/app/guides/upgrading/codemods) to view the documentation for this package.
+
+## Skip optional feature adoption
+
+`upgrade --skip-adoption` skips codemods marked as feature adoption in the
+registry while keeping version migrations and normal dependency selection.
+Currently this excludes `cache-components-instant-false` and the
+`remove-partial-prefetch` cleanup used after adopting partial prefetching.
+Both transforms can still be run explicitly.
+
+Combine it with `--yes` for an unattended version upgrade. Without
+`--skip-adoption`, the existing upgrade selections are unchanged.

package/bin/next-codemod.js

@@ -44,6 +44,7 @@ program
     .usage('[revision] [options]')
     .option('--verbose', 'Verbose output', false)
     .option('-y, --yes', 'Skip every interactive prompt and accept its default. Also auto-enabled when stdin is not a TTY (e.g. running under an agent or in CI).', false)
+    .option('--skip-adoption', 'Skip optional feature-adoption codemods while applying version migrations.', false)
     .action(async (revision, options) => {
     try {
         await (0, upgrade_1.runUpgrade)(revision, options);

package/bin/transform.js

@@ -56,7 +56,7 @@ async function runTransform(transform, path, options) {
         }, { onCancel: utils_1.onCancel });
         transformer = res.transformer;
     }
-    if (transformer === 'next-request-geo-ip') {
+    if (transformer === 'next-request-geo-ip' && !options.nonInteractive) {
         const { isAppDeployedToVercel } = await (0, prompts_1.default)({
             type: 'confirm',
             name: 'isAppDeployedToVercel',
@@ -99,7 +99,7 @@ async function runTransform(transform, path, options) {
     args.push('--parser=tsx');
     args.push('--ignore-pattern=**/node_modules/**');
     args.push('--ignore-pattern=**/.next/**');
-    args.push('--extensions=tsx,ts,jsx,js');
+    args.push('--extensions=tsx,ts,jsx,js,mjs');
     args = args.concat(['--transform', transformerPath]);
     if (jscodeshift) {
         args = args.concat(jscodeshift);

package/bin/upgrade.js

@@ -225,7 +225,7 @@ async function runUpgrade(revision, options) {
         (0, semver_1.compare)(targetNextVersion, '16.0.0-canary') < 0) {
         await suggestTurbopack(appPackageJson, targetNextVersion, nonInteractive);
     }
-    const codemods = await suggestCodemods(installedNextVersion, targetNextVersion, nonInteractive);
+    const codemods = await suggestCodemods(installedNextVersion, targetNextVersion, nonInteractive, options.skipAdoption);
     const packageManager = (0, handle_package_1.getPkgManager)(cwd);
     let shouldRunReactCodemods = false;
     let shouldRunReactTypesCodemods = false;
@@ -357,7 +357,11 @@ async function runUpgrade(revision, options) {
         os.EOL);
     (0, handle_package_1.runInstallation)(packageManager, { cwd });
     for (const codemod of codemods) {
-        await (0, transform_1.runTransform)(codemod, cwd, { force: true, verbose });
+        await (0, transform_1.runTransform)(codemod, cwd, {
+            force: true,
+            verbose,
+            nonInteractive,
+        });
     }
     // To reduce user-side burden of selecting which codemods to run as it needs additional
     // understanding of the codemods, we run all of the applicable codemods.
@@ -489,7 +493,7 @@ async function suggestTurbopack(packageJson, targetNextVersion, nonInteractive)
     packageJson.scripts['dev'] =
         responseCustomDevScript.customDevScript || devScript;
 }
-async function suggestCodemods(initialNextVersion, targetNextVersion, nonInteractive) {
+async function suggestCodemods(initialNextVersion, targetNextVersion, nonInteractive, skipAdoption = false) {
     // example:
     // codemod version: 15.0.0-canary.45
     // 14.3             -> 15.0.0-canary.45: apply
@@ -508,7 +512,7 @@ async function suggestCodemods(initialNextVersion, targetNextVersion, nonInterac
     if (targetVersionIndex === -1) {
         targetVersionIndex = utils_1.TRANSFORMER_INQUIRER_CHOICES.length;
     }
-    const relevantCodemods = utils_1.TRANSFORMER_INQUIRER_CHOICES.slice(initialVersionIndex, targetVersionIndex);
+    const relevantCodemods = utils_1.TRANSFORMER_INQUIRER_CHOICES.slice(initialVersionIndex, targetVersionIndex).filter((codemod) => !skipAdoption || !codemod.adoption);
     if (relevantCodemods.length === 0) {
         return [];
     }

package/lib/utils.js

@@ -3,11 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TRANSFORMER_INQUIRER_CHOICES = void 0;
+exports.TRANSFORMER_INQUIRER_CHOICES = exports.NEXT_CODEMOD_IGNORE_ERROR_PREFIX = exports.NEXT_CODEMOD_ERROR_PREFIX = void 0;
 exports.checkGitStatus = checkGitStatus;
 exports.onCancel = onCancel;
 const picocolors_1 = require("picocolors");
 const is_git_clean_1 = __importDefault(require("is-git-clean"));
+exports.NEXT_CODEMOD_ERROR_PREFIX = '@next-codemod-error';
+exports.NEXT_CODEMOD_IGNORE_ERROR_PREFIX = '@next-codemod-ignore';
 function checkGitStatus(force) {
     let clean = false;
     let errorMessage = 'Unable to determine if git directory is clean';
@@ -136,11 +138,13 @@ exports.TRANSFORMER_INQUIRER_CHOICES = [
         title: 'Add `export const instant = false` to App Router pages and layouts to ease Cache Components adoption',
         value: 'cache-components-instant-false',
         version: '16.3.0',
+        adoption: true,
     },
     {
         title: "Remove `export const prefetch = 'partial'` Route Segment Config from App Router pages and layouts after enabling `partialPrefetching` globally",
         value: 'remove-partial-prefetch',
         version: '16.3.0',
+        adoption: true,
     },
 ];
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next/codemod",
-  "version": "16.4.0-canary.3",
+  "version": "16.4.0-canary.31",
   "license": "MIT",
   "repository": {
     "type": "git",

package/transforms/cache-components-instant-false.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = transformer;
 const parser_1 = require("../lib/parser");
+const utils_1 = require("../lib/utils");
 /**
  * Blanket-inserts `export const instant = false` into every App Router `page`,
  * `layout`, and `default` file so they're marked as allowed to block when
@@ -86,15 +87,16 @@ function transformer(file, _api) {
     if (hasInstantBinding) {
         return file.source;
     }
-    // Build `export const instant = false`. The two `//` comments above it
-    // (TODO + See:) are attached as leading comments on the declaration so
+    // Build `export const instant = false`. The ignore reason, removal condition,
+    // and guide link are attached as leading comments on the declaration so
     // recast prints them right above it.
-    const todoComment = j.commentLine(' TODO: Cache Components adoption. Refactor this route so this opt-out can be removed.', true, false);
+    const ignoreComment = j.commentLine(` ${utils_1.NEXT_CODEMOD_IGNORE_ERROR_PREFIX} Cache Components adoption: this segment temporarily allows blocking.`, true, false);
+    const removalComment = j.commentLine(' Remove this opt-out after verifying the segment passes validation without it.', true, false);
     const seeComment = j.commentLine(' See: https://nextjs.org/docs/app/guides/migrating-to-cache-components', true, false);
     const instantExport = j.exportNamedDeclaration(j.variableDeclaration('const', [
         j.variableDeclarator(j.identifier('instant'), j.booleanLiteral(false)),
     ]));
-    instantExport.comments = [todoComment, seeComment];
+    instantExport.comments = [ignoreComment, removalComment, seeComment];
     // Insert after the last top-level import, or at the top of the module
     // if there are no imports.
     const body = program.body;
@@ -110,14 +112,19 @@ function transformer(file, _api) {
         // No imports. Inserting at index 0 would steal any file-level leading
         // comments (e.g. `// @ts-nocheck`) from `body[0]` because recast
         // attributes them to whatever is first. Move those leading comments
-        // off `body[0]` onto the new export *before* its TODO/See: lines, so
+        // off `body[0]` onto the new export *before* its adoption comments, so
         // they print in their original position.
         const first = body[0];
         const allComments = (first.comments ?? []);
         const firstLeading = allComments.filter((c) => c.leading === true);
         if (firstLeading.length > 0) {
             first.comments = allComments.filter((c) => c.leading !== true);
-            instantExport.comments = [...firstLeading, todoComment, seeComment];
+            instantExport.comments = [
+                ...firstLeading,
+                ignoreComment,
+                removalComment,
+                seeComment,
+            ];
         }
         body.unshift(instantExport);
     }

package/transforms/lib/async-request-api/next-async-dynamic-api.js

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformDynamicAPI = transformDynamicAPI;
 const utils_1 = require("./utils");
 const parser_1 = require("../../../lib/parser");
-const DYNAMIC_IMPORT_WARN_COMMENT = ` @next-codemod-error The APIs under 'next/headers' are async now, need to be manually awaited. `;
+const utils_2 = require("../../../lib/utils");
+const DYNAMIC_IMPORT_WARN_COMMENT = ` ${utils_2.NEXT_CODEMOD_ERROR_PREFIX} The APIs under 'next/headers' are async now, need to be manually awaited. `;
 function findDynamicImportsAndComment(root, j) {
     let modified = false;
     // find all the dynamic imports of `next/headers`,
@@ -146,12 +147,12 @@ function transformDynamicAPI(source, _api, filePath) {
                             needsReactUseImport = true;
                         }
                         else {
-                            const casted = castTypesOrAddComment(j, path, originRequestApiName, root, filePath, insertedTypes, ` ${utils_1.NEXT_CODEMOD_ERROR_PREFIX} Manually await this call and refactor the function to be async `);
+                            const casted = castTypesOrAddComment(j, path, originRequestApiName, root, filePath, insertedTypes, ` ${utils_2.NEXT_CODEMOD_ERROR_PREFIX} Manually await this call and refactor the function to be async `);
                             modified ||= casted;
                         }
                     }
                     else {
-                        const casted = castTypesOrAddComment(j, path, originRequestApiName, root, filePath, insertedTypes, ` ${utils_1.NEXT_CODEMOD_ERROR_PREFIX} please manually await this call, codemod cannot transform due to undetermined async scope `);
+                        const casted = castTypesOrAddComment(j, path, originRequestApiName, root, filePath, insertedTypes, ` ${utils_2.NEXT_CODEMOD_ERROR_PREFIX} please manually await this call, codemod cannot transform due to undetermined async scope `);
                         modified ||= casted;
                     }
                 }
@@ -227,6 +228,18 @@ function castTypesOrAddComment(j, path, originRequestApiName, root, filePath, in
           e.g. `<path>` is cookies(), convert it to `(<path> as unknown as UnsafeUnwrappedCookies)`
         */
         const targetType = API_CAST_TYPE_MAP[originRequestApiName];
+        const repairComment = ` ${utils_2.NEXT_CODEMOD_ERROR_PREFIX} Await this API and update its callers; remove the temporary ${targetType} cast after repairing the migration. `;
+        const parentCast = path.parentPath?.node;
+        const outerCast = path.parentPath?.parentPath?.node;
+        if (j.TSAsExpression.check(parentCast) &&
+            j.TSAsExpression.check(outerCast) &&
+            j.TSTypeReference.check(outerCast.typeAnnotation) &&
+            j.Identifier.check(outerCast.typeAnnotation.typeName) &&
+            outerCast.typeAnnotation.typeName.name === targetType) {
+            // Re-parsing attaches the leading marker to the outer cast.
+            return (0, utils_1.insertCommentOnce)(outerCast, j, repairComment);
+        }
+        (0, utils_1.insertCommentOnce)(path.node, j, repairComment);
         const newCastExpression = j.tsAsExpression(j.tsAsExpression(path.node, j.tsUnknownKeyword()), j.tsTypeReference(j.identifier(targetType)));
         // Replace the original expression with the new cast expression,
         // also wrap () around the new cast expression.

package/transforms/lib/async-request-api/next-async-dynamic-prop.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformDynamicProps = transformDynamicProps;
 const utils_1 = require("./utils");
 const parser_1 = require("../../../lib/parser");
+const utils_2 = require("../../../lib/utils");
 const PAGE_PROPS = 'props';
 // Find all the member access of the prop, and await them
 // e.g. If there's argument `props`, find all the member access of props.<name>.
@@ -40,7 +41,7 @@ function awaitMemberAccessOfProp(propIdName, path, j) {
             parentScopeOfMemberAccess.node !== path.node) {
             // If it's not able to convert, add a comment to the prop access to warn the user
             // e.g. the parent scope is sync, await keyword can't be applied
-            const comment = ` ${utils_1.NEXT_CODEMOD_ERROR_PREFIX} '${propIdName}.${memberProperty.name}' is accessed without awaiting.`;
+            const comment = ` ${utils_2.NEXT_CODEMOD_ERROR_PREFIX} '${propIdName}.${memberProperty.name}' is accessed without awaiting.`;
             (0, utils_1.insertCommentOnce)(member, j, comment);
             return;
         }
@@ -121,7 +122,7 @@ function commentOnMatchedReExports(root, j) {
                         specifier.exported.name === 'default')) {
                     if (j.Literal.check(path.value.source)) {
                         const localName = specifier.local.name;
-                        const commentInserted = (0, utils_1.insertCommentOnce)(specifier, j, ` ${utils_1.NEXT_CODEMOD_ERROR_PREFIX} \`${localName}\` export is re-exported. Check if this component uses \`params\` or \`searchParams\``);
+                        const commentInserted = (0, utils_1.insertCommentOnce)(specifier, j, ` ${utils_2.NEXT_CODEMOD_ERROR_PREFIX} \`${localName}\` export is re-exported. Check if this component uses \`params\` or \`searchParams\``);
                         modified ||= commentInserted;
                     }
                     else if (path.value.source === null) {
@@ -134,7 +135,7 @@ function commentOnMatchedReExports(root, j) {
                             return importPath.value.specifiers.some((importSpecifier) => importSpecifier.local.name === localName);
                         });
                         if (importDeclaration.size() > 0) {
-                            const commentInserted = (0, utils_1.insertCommentOnce)(specifier, j, ` ${utils_1.NEXT_CODEMOD_ERROR_PREFIX} \`${localName}\` export is re-exported. Check if this component uses \`params\` or \`searchParams\``);
+                            const commentInserted = (0, utils_1.insertCommentOnce)(specifier, j, ` ${utils_2.NEXT_CODEMOD_ERROR_PREFIX} \`${localName}\` export is re-exported. Check if this component uses \`params\` or \`searchParams\``);
                             modified ||= commentInserted;
                         }
                     }
@@ -410,7 +411,7 @@ function transformDynamicProps(source, _api, filePath) {
                     // find the argument `currentParam`
                     const args = callExpression.value.arguments;
                     const propPassedAsArg = args.find((arg) => j.Identifier.check(arg) && arg.name === argName);
-                    const comment = ` ${utils_1.NEXT_CODEMOD_ERROR_PREFIX} '${argName}' is passed as an argument. Any asynchronous properties of 'props' must be awaited when accessed. `;
+                    const comment = ` ${utils_2.NEXT_CODEMOD_ERROR_PREFIX} '${argName}' is passed as an argument. Any asynchronous properties of 'props' must be awaited when accessed. `;
                     const inserted = (0, utils_1.insertCommentOnce)(propPassedAsArg, j, comment);
                     modified ||= inserted;
                 });
@@ -750,7 +751,7 @@ function commentSpreadProps(path, propsIdentifierName, j) {
     const objSpreadProperties = functionBodyCollection.find(j.SpreadElement, {
         argument: { name: propsIdentifierName },
     });
-    const comment = ` ${utils_1.NEXT_CODEMOD_ERROR_PREFIX} '${propsIdentifierName}' is used with spread syntax (...). Any asynchronous properties of '${propsIdentifierName}' must be awaited when accessed. `;
+    const comment = ` ${utils_2.NEXT_CODEMOD_ERROR_PREFIX} '${propsIdentifierName}' is used with spread syntax (...). Any asynchronous properties of '${propsIdentifierName}' must be awaited when accessed. `;
     // Add comment before it
     jsxSpreadProperties.forEach((spread) => {
         const inserted = (0, utils_1.insertCommentOnce)(spread.value, j, comment);

package/transforms/lib/async-request-api/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isReactHookName = exports.TARGET_PROP_NAMES = exports.TARGET_NAMED_EXPORTS = exports.TARGET_ROUTE_EXPORTS = exports.NEXT_CODEMOD_ERROR_PREFIX = exports.NEXTJS_ENTRY_FILES = void 0;
+exports.isReactHookName = exports.TARGET_PROP_NAMES = exports.TARGET_NAMED_EXPORTS = exports.TARGET_ROUTE_EXPORTS = exports.NEXTJS_ENTRY_FILES = void 0;
 exports.isFunctionType = isFunctionType;
 exports.isMatchedFunctionExported = isMatchedFunctionExported;
 exports.determineClientDirective = determineClientDirective;
@@ -19,8 +19,7 @@ exports.containsReactHooksCallExpressions = containsReactHooksCallExpressions;
 exports.isParentUseCallExpression = isParentUseCallExpression;
 exports.isParentPromiseAllCallExpression = isParentPromiseAllCallExpression;
 exports.NEXTJS_ENTRY_FILES = /([\\/]|^)(page|layout|route|default)\.(t|j)sx?$/;
-exports.NEXT_CODEMOD_ERROR_PREFIX = '@next-codemod-error';
-const NEXT_CODEMOD_IGNORE_ERROR_PREFIX = '@next-codemod-ignore';
+const utils_1 = require("../../../lib/utils");
 exports.TARGET_ROUTE_EXPORTS = new Set([
     'GET',
     'POST',
@@ -332,13 +331,13 @@ function wrapParentheseIfNeeded(hasChainAccess, j, expression) {
 function existsComment(comments, comment) {
     const isCodemodErrorComment = comment
         .trim()
-        .startsWith(exports.NEXT_CODEMOD_ERROR_PREFIX);
+        .startsWith(utils_1.NEXT_CODEMOD_ERROR_PREFIX);
     let hasIgnoreComment = false;
     let hasComment = false;
     if (comments) {
         comments.forEach((commentNode) => {
             const currentComment = commentNode.value;
-            if (currentComment.trim().startsWith(NEXT_CODEMOD_IGNORE_ERROR_PREFIX)) {
+            if (currentComment.trim().startsWith(utils_1.NEXT_CODEMOD_IGNORE_ERROR_PREFIX)) {
                 hasIgnoreComment = true;
             }
             if (currentComment === comment) {

package/transforms/new-link.js

@@ -4,7 +4,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = transformer;
 const parser_1 = require("../lib/parser");
-const utils_1 = require("./lib/async-request-api/utils");
+const utils_1 = require("../lib/utils");
 function transformer(file, _api) {
     const j = (0, parser_1.createParserFromPath)(file.path);
     const $j = j(file.source);