@next/codemod 16.3.0-preview.3 → 16.3.0-preview.4

package/bin/agents-md.js

@@ -59,8 +59,17 @@ async function runAgentsMd(options) {
         targetFile = promptedOptions.targetFile;
     }
     const claudeMdPath = path_1.default.join(cwd, targetFile);
-    const docsPath = path_1.default.join(cwd, DOCS_DIR_NAME);
-    const docsLinkPath = `./${DOCS_DIR_NAME}`;
+    // Next.js >= 16.2.0 ships its docs inside the published package. When the
+    // installed version matches the requested one, index the bundled docs
+    // directly instead of downloading a copy into .next-docs.
+    const bundledDocs = (0, agents_md_1.getBundledDocsInfo)(cwd);
+    const useBundledDocs = bundledDocs !== null && bundledDocs.version === nextjsVersion;
+    const docsPath = useBundledDocs
+        ? bundledDocs.docsPath
+        : path_1.default.join(cwd, DOCS_DIR_NAME);
+    const docsLinkPath = useBundledDocs
+        ? (0, agents_md_1.getBundledDocsLinkPath)(cwd, bundledDocs.docsPath)
+        : `./${DOCS_DIR_NAME}`;
     let sizeBefore = 0;
     let isNewFile = true;
     let existingContent = '';
@@ -69,14 +78,19 @@ async function runAgentsMd(options) {
         sizeBefore = Buffer.byteLength(existingContent, 'utf-8');
         isNewFile = false;
     }
-    console.log(`\nDownloading Next.js ${picocolors_1.default.cyan(nextjsVersion)} documentation to ${picocolors_1.default.cyan(DOCS_DIR_NAME)}...`);
-    const pullResult = await (0, agents_md_1.pullDocs)({
-        cwd,
-        version: nextjsVersion,
-        docsDir: docsPath,
-    });
-    if (!pullResult.success) {
-        throw new shared_1.BadInput(`Failed to pull docs: ${pullResult.error}`);
+    if (useBundledDocs) {
+        console.log(`\nUsing the docs bundled with Next.js ${picocolors_1.default.cyan(nextjsVersion)} at ${picocolors_1.default.cyan(docsLinkPath)} (no download needed).`);
+    }
+    else {
+        console.log(`\nDownloading Next.js ${picocolors_1.default.cyan(nextjsVersion)} documentation to ${picocolors_1.default.cyan(DOCS_DIR_NAME)}...`);
+        const pullResult = await (0, agents_md_1.pullDocs)({
+            cwd,
+            version: nextjsVersion,
+            docsDir: docsPath,
+        });
+        if (!pullResult.success) {
+            throw new shared_1.BadInput(`Failed to pull docs: ${pullResult.error}`);
+        }
     }
     const docFiles = (0, agents_md_1.collectDocFiles)(docsPath);
     const sections = (0, agents_md_1.buildDocTree)(docFiles);
@@ -88,13 +102,15 @@ async function runAgentsMd(options) {
     const newContent = (0, agents_md_1.injectIntoClaudeMd)(existingContent, indexContent);
     fs_1.default.writeFileSync(claudeMdPath, newContent, 'utf-8');
     const sizeAfter = Buffer.byteLength(newContent, 'utf-8');
-    const gitignoreResult = (0, agents_md_1.ensureGitignoreEntry)(cwd);
+    // .next-docs only exists on the download path; bundled docs live in
+    // node_modules, which is already ignored.
+    const gitignoreResult = useBundledDocs ? null : (0, agents_md_1.ensureGitignoreEntry)(cwd);
     const action = isNewFile ? 'Created' : 'Updated';
     const sizeInfo = isNewFile
         ? formatSize(sizeAfter)
         : `${formatSize(sizeBefore)} → ${formatSize(sizeAfter)}`;
     console.log(`${picocolors_1.default.green('✓')} ${action} ${picocolors_1.default.bold(targetFile)} (${sizeInfo})`);
-    if (gitignoreResult.updated) {
+    if (gitignoreResult?.updated) {
         console.log(`${picocolors_1.default.green('✓')} Added ${picocolors_1.default.bold(DOCS_DIR_NAME)} to .gitignore`);
     }
     console.log('');

package/bin/upgrade.js

@@ -500,6 +500,16 @@ function writeOverridesField(packageJson, packageManager, overrides) {
         }
     }
     else if (packageManager === 'pnpm') {
+        // pnpm v11 silently ignores `pnpm.overrides` in package.json. The
+        // canonical location moved to `pnpm-workspace.yaml#overrides`.
+        // See https://pnpm.io/settings and https://github.com/pnpm/pnpm/issues/11536.
+        // When the version cannot be detected, assume the current (v11+) layout
+        // since that's the surface where silently-dropped overrides hurt most.
+        const pnpmMajorVersion = (0, handle_package_1.getPnpmMajorVersion)();
+        if (pnpmMajorVersion === null || pnpmMajorVersion >= 11) {
+            writePnpmWorkspaceOverrides(overrides);
+            return;
+        }
         // pnpm supports pnpm.overrides and pnpm.resolutions
         if (packageJson.resolutions) {
             for (const [key, value] of entries) {
@@ -545,6 +555,28 @@ function writeOverridesField(packageJson, packageManager, overrides) {
         }
     }
 }
+function writePnpmWorkspaceOverrides(overrides) {
+    // Deferred require so `js-yaml` is only loaded when we hit the pnpm v11+
+    // branch (i.e. not for npm/yarn/bun/pnpm-v10 upgrades). The package is CJS,
+    // so a sync `require()` keeps this function synchronous.
+    const yaml = require('js-yaml');
+    const filePath = path_1.default.join(cwd, 'pnpm-workspace.yaml');
+    let doc = {};
+    if (fs_1.default.existsSync(filePath)) {
+        const existing = fs_1.default.readFileSync(filePath, 'utf8');
+        const parsed = yaml.load(existing);
+        if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
+            doc = parsed;
+        }
+    }
+    if (!doc.overrides || typeof doc.overrides !== 'object') {
+        doc.overrides = {};
+    }
+    for (const [key, value] of Object.entries(overrides)) {
+        doc.overrides[key] = value;
+    }
+    fs_1.default.writeFileSync(filePath, yaml.dump(doc));
+}
 function warnDependenciesOutOfRange(appPackageJson, versionMapping) {
     const allDirectDependencies = {
         ...appPackageJson.dependencies,

package/lib/__tests__/agents-md-e2e.test.js

@@ -293,6 +293,123 @@ This is my project documentation.
     }
   }, 30000) // Increase timeout for git clone
 
+  describe('bundled docs (Next.js >= 16.2.0)', () => {
+    // Simulate an install of a Next.js version that ships docs inside the
+    // published package at node_modules/next/dist/docs.
+    function setupBundledNext(projectDir, version) {
+      const nextDir = path.join(projectDir, 'node_modules', 'next')
+      const gettingStartedDir = path.join(
+        nextDir,
+        'dist',
+        'docs',
+        '01-app',
+        '01-getting-started'
+      )
+      fs.mkdirSync(gettingStartedDir, { recursive: true })
+      fs.writeFileSync(
+        path.join(nextDir, 'package.json'),
+        JSON.stringify({ name: 'next', version })
+      )
+      fs.writeFileSync(
+        path.join(nextDir, 'dist', 'docs', 'index.md'),
+        '# Next.js Docs'
+      )
+      fs.writeFileSync(
+        path.join(gettingStartedDir, '01-installation.md'),
+        '# Installation'
+      )
+      fs.writeFileSync(
+        path.join(gettingStartedDir, '02-project-structure.md'),
+        '# Project Structure'
+      )
+    }
+
+    it('indexes bundled docs instead of downloading when installed Next.js ships them', async () => {
+      setupBundledNext(testProjectDir, '16.2.0')
+
+      const originalCwd = process.cwd()
+      process.chdir(testProjectDir)
+
+      try {
+        await runAgentsMd({ output: 'CLAUDE.md' })
+
+        // No .next-docs copy and no .gitignore entry for it
+        expect(fs.existsSync(path.join(testProjectDir, '.next-docs'))).toBe(
+          false
+        )
+        expect(fs.existsSync(path.join(testProjectDir, '.gitignore'))).toBe(
+          false
+        )
+
+        const claudeMdContent = fs.readFileSync(
+          path.join(testProjectDir, 'CLAUDE.md'),
+          'utf-8'
+        )
+        expect(claudeMdContent).toContain(
+          'root: ./node_modules/next/dist/docs'
+        )
+        expect(claudeMdContent).toContain('01-installation.md')
+
+        const output = consoleOutput.join('\n')
+        expect(output).toContain('bundled with Next.js')
+        expect(output).not.toContain('Downloading')
+      } finally {
+        process.chdir(originalCwd)
+      }
+    })
+
+    it('uses bundled docs when --version matches the installed version', async () => {
+      setupBundledNext(testProjectDir, '16.2.0')
+
+      const originalCwd = process.cwd()
+      process.chdir(testProjectDir)
+
+      try {
+        await runAgentsMd({ version: '16.2.0', output: 'AGENTS.md' })
+
+        expect(fs.existsSync(path.join(testProjectDir, '.next-docs'))).toBe(
+          false
+        )
+
+        const agentsMdContent = fs.readFileSync(
+          path.join(testProjectDir, 'AGENTS.md'),
+          'utf-8'
+        )
+        expect(agentsMdContent).toContain(
+          'root: ./node_modules/next/dist/docs'
+        )
+      } finally {
+        process.chdir(originalCwd)
+      }
+    })
+
+    it('falls back to downloading when --version differs from the installed version', async () => {
+      setupBundledNext(testProjectDir, '16.2.0')
+
+      const originalCwd = process.cwd()
+      process.chdir(testProjectDir)
+
+      try {
+        await runAgentsMd({ version: '15.0.0', output: 'CLAUDE.md' })
+
+        expect(fs.existsSync(path.join(testProjectDir, '.next-docs'))).toBe(
+          true
+        )
+
+        const claudeMdContent = fs.readFileSync(
+          path.join(testProjectDir, 'CLAUDE.md'),
+          'utf-8'
+        )
+        expect(claudeMdContent).toContain('root: ./.next-docs')
+
+        const output = consoleOutput.join('\n')
+        expect(output).toContain('Downloading')
+      } finally {
+        process.chdir(originalCwd)
+      }
+    }, 30000) // Increase timeout for git clone
+  })
+
   describe('getNextjsVersion', () => {
     const fixturesDir = path.join(__dirname, 'fixtures/agents-md')
 

package/lib/agents-md.js

@@ -10,6 +10,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getNextjsVersion = getNextjsVersion;
+exports.getBundledDocsInfo = getBundledDocsInfo;
+exports.getBundledDocsLinkPath = getBundledDocsLinkPath;
 exports.pullDocs = pullDocs;
 exports.collectDocFiles = collectDocFiles;
 exports.buildDocTree = buildDocTree;
@@ -45,6 +47,36 @@ function getNextjsVersion(cwd) {
         };
     }
 }
+/**
+ * Next.js ships its documentation inside the published package (at
+ * `dist/docs`) since 16.2.0. When the install resolved from `cwd` has
+ * bundled docs, the index can point at them directly instead of
+ * downloading a copy into `.next-docs`.
+ */
+function getBundledDocsInfo(cwd) {
+    try {
+        const nextPkgPath = require.resolve('next/package.json', { paths: [cwd] });
+        const pkg = JSON.parse(fs_1.default.readFileSync(nextPkgPath, 'utf-8'));
+        const docsPath = path_1.default.join(path_1.default.dirname(nextPkgPath), 'dist', 'docs');
+        if (!pkg.version || collectDocFiles(docsPath).length === 0) {
+            return null;
+        }
+        return { docsPath, version: pkg.version };
+    }
+    catch {
+        return null;
+    }
+}
+function getBundledDocsLinkPath(cwd, docsPath) {
+    // Prefer the conventional path when it resolves from the project
+    // (covers hoisted installs; pnpm exposes next via a node_modules symlink).
+    const conventional = path_1.default.join(cwd, 'node_modules', 'next', 'dist', 'docs');
+    if (fs_1.default.existsSync(conventional)) {
+        return './node_modules/next/dist/docs';
+    }
+    const relative = path_1.default.relative(cwd, docsPath).replace(/\\/g, '/');
+    return relative.startsWith('.') ? relative : `./${relative}`;
+}
 function versionToGitHubTag(version) {
     return version.startsWith('v') ? version : `v${version}`;
 }

package/lib/handle-package.js

@@ -3,6 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPackageManagerVersion = getPackageManagerVersion;
+exports.getPnpmMajorVersion = getPnpmMajorVersion;
 exports.getPkgManager = getPkgManager;
 exports.uninstallPackage = uninstallPackage;
 exports.installPackages = installPackages;
@@ -10,7 +12,49 @@ exports.runInstallation = runInstallation;
 exports.addPackageDependency = addPackageDependency;
 const find_up_1 = __importDefault(require("find-up"));
 const execa_1 = __importDefault(require("execa"));
+const node_child_process_1 = require("node:child_process");
 const node_path_1 = require("node:path");
+/**
+ * Get the full version string for the given package manager.
+ *
+ * First tries to parse from `npm_config_user_agent` (e.g., "pnpm/9.13.2 npm/? ..."),
+ * then falls back to spawning `<packageManager> --version`.
+ *
+ * Returns null if unable to determine the version.
+ *
+ * Mirrors `packages/create-next-app/helpers/get-pkg-manager.ts`.
+ */
+function getPackageManagerVersion(packageManager) {
+    const userAgent = process.env.npm_config_user_agent || '';
+    const userAgentMatch = userAgent.match(new RegExp(`${packageManager}/([\\d.]+[\\w.-]*)`));
+    if (userAgentMatch) {
+        return userAgentMatch[1];
+    }
+    try {
+        const version = (0, node_child_process_1.execSync)(`${packageManager} --version`, {
+            encoding: 'utf8',
+            stdio: ['pipe', 'pipe', 'ignore'],
+        }).trim();
+        if (/^\d+\.\d+\.\d+/.test(version)) {
+            return version;
+        }
+    }
+    catch {
+        // package manager not available or failed to run
+    }
+    return null;
+}
+/**
+ * Get the major version of pnpm being used.
+ * Returns null if unable to determine the version.
+ */
+function getPnpmMajorVersion() {
+    const version = getPackageManagerVersion('pnpm');
+    if (!version)
+        return null;
+    const major = parseInt(version.split('.')[0], 10);
+    return Number.isNaN(major) ? null : major;
+}
 function getPkgManager(baseDir) {
     try {
         const lockFile = find_up_1.default.sync([

package/lib/utils.js

@@ -132,5 +132,10 @@ exports.TRANSFORMER_INQUIRER_CHOICES = [
         value: 'remove-experimental-ppr',
         version: '16.0.0-canary.11',
     },
+    {
+        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',
+    },
 ];
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next/codemod",
-  "version": "16.3.0-preview.3",
+  "version": "16.3.0-preview.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -14,6 +14,7 @@
     "find-up": "4.1.0",
     "globby": "11.0.1",
     "is-git-clean": "1.1.0",
+    "js-yaml": "4.2.0",
     "jscodeshift": "17.0.0",
     "picocolors": "1.0.0",
     "prompts": "2.4.2",
@@ -27,19 +28,19 @@
     "lib/**/*.js",
     "lib/cra-to-next/gitignore"
   ],
-  "scripts": {
-    "build": "pnpm tsc -d -p tsconfig.json",
-    "prepublishOnly": "cd ../../ && turbo run build",
-    "dev": "pnpm tsc -d -w -p tsconfig.json",
-    "test": "jest",
-    "test:upgrade-fixture": "./scripts/test-upgrade-fixture.sh"
-  },
   "bin": "./bin/next-codemod.js",
   "devDependencies": {
     "@types/find-up": "4.0.0",
+    "@types/js-yaml": "4.0.9",
     "@types/jscodeshift": "0.11.0",
     "@types/prompts": "2.4.2",
     "@types/semver": "7.3.1",
     "typescript": "6.0.2"
+  },
+  "scripts": {
+    "build": "pnpm tsc -d -p tsconfig.json",
+    "dev": "pnpm tsc -d -w -p tsconfig.json",
+    "test": "jest",
+    "test:upgrade-fixture": "./scripts/test-upgrade-fixture.sh"
   }
-}
+}

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

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = transformer;
+const parser_1 = require("../lib/parser");
+/**
+ * Blanket-inserts `export const instant = false` into every App Router `page`,
+ * `layout`, and `default` file so they're marked as allowed to block when
+ * `cacheComponents` is enabled. Each opt-out is meant to be walked back, one
+ * route at a time, using the companion adoption skill.
+ *
+ * - Skips files that already declare or export `instant` in any form (never
+ *   overrides existing config or appends a duplicate binding).
+ * - Skips Client/Server Component modules (`"use client"` / `"use server"`):
+ *   `instant` is a Server Component route segment config, so exporting it from
+ *   those modules is a build error.
+ * - Targets `page` / `layout` / `default` only (not `route` — `instant` does
+ *   not apply to route handlers). `default.tsx` is the parallel-route fallback,
+ *   a server segment that accepts route segment config like the other two.
+ */
+function transformer(file, _api) {
+    if (process.env.NODE_ENV !== 'test' &&
+        !/(^|[/\\])app[/\\].*?(page|layout|default)\.[^/\\]+$/.test(file.path)) {
+        return file.source;
+    }
+    const j = (0, parser_1.createParserFromPath)(file.path);
+    const root = j(file.source);
+    // Bail on Client/Server Component modules. `instant` is a Server Component
+    // route segment config; exporting it from a `"use client"` (or `"use server"`)
+    // module fails the build. Parsers represent the directive either in
+    // `program.directives` or as a leading string-literal `ExpressionStatement`.
+    const program = root.get().node.program;
+    const isClientOrServerDirective = (value) => value === 'use client' || value === 'use server';
+    let hasModuleDirective = (program.directives ?? []).some((d) => isClientOrServerDirective(d?.value?.value));
+    if (!hasModuleDirective) {
+        for (const node of program.body) {
+            if (node.type !== 'ExpressionStatement' ||
+                (node.expression?.type !== 'StringLiteral' &&
+                    node.expression?.type !== 'Literal')) {
+                // Directives must lead the module; stop at the first non-directive.
+                break;
+            }
+            if (isClientOrServerDirective(node.expression.value)) {
+                hasModuleDirective = true;
+                break;
+            }
+        }
+    }
+    if (hasModuleDirective) {
+        return file.source;
+    }
+    // Bail if `instant` already exists in any form, so we never append a
+    // duplicate declaration (which would be a `SyntaxError`). This covers:
+    //   export const instant = ...
+    //   export const a = 1, instant = ...   (any declarator position)
+    //   const instant = ...                 (local binding)
+    //   const { instant } = ...             (destructured binding)
+    //   export { instant }
+    //   export { foo as instant }
+    //   export function instant() {} / export class instant {}
+    const bindsInstant = (node) => {
+        switch (node?.type) {
+            case 'Identifier':
+                return node.name === 'instant';
+            case 'ObjectPattern':
+                return node.properties.some((prop) => prop.type === 'RestElement'
+                    ? bindsInstant(prop.argument)
+                    : bindsInstant(prop.value ?? prop.argument));
+            case 'ArrayPattern':
+                return node.elements.some((el) => el != null && bindsInstant(el));
+            case 'AssignmentPattern':
+                return bindsInstant(node.left);
+            case 'RestElement':
+                return bindsInstant(node.argument);
+            default:
+                return false;
+        }
+    };
+    const hasInstantBinding = root
+        .find(j.VariableDeclarator)
+        .filter((p) => bindsInstant(p.node.id))
+        .size() > 0 ||
+        root.find(j.ExportSpecifier, { exported: { name: 'instant' } }).size() >
+            0 ||
+        root.find(j.FunctionDeclaration, { id: { name: 'instant' } }).size() > 0 ||
+        root.find(j.ClassDeclaration, { id: { name: 'instant' } }).size() > 0;
+    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
+    // 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 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];
+    // Insert after the last top-level import, or at the top of the module
+    // if there are no imports.
+    const body = program.body;
+    let lastImportIndex = -1;
+    for (let i = 0; i < body.length; i++) {
+        if (body[i].type === 'ImportDeclaration')
+            lastImportIndex = i;
+    }
+    if (lastImportIndex !== -1) {
+        body.splice(lastImportIndex + 1, 0, instantExport);
+    }
+    else if (body.length > 0) {
+        // 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
+        // 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];
+        }
+        body.unshift(instantExport);
+    }
+    else {
+        body.push(instantExport);
+    }
+    return root.toSource();
+}
+//# sourceMappingURL=cache-components-instant-false.js.map