@next/codemod 15.0.0-canary.165 → 15.0.0-canary.166

package/bin/cli.js

@@ -24,6 +24,7 @@ const execa_1 = __importDefault(require("execa"));
 const picocolors_1 = require("picocolors");
 const is_git_clean_1 = __importDefault(require("is-git-clean"));
 const handle_package_1 = require("../lib/handle-package");
+const upgrade_1 = require("./upgrade");
 exports.jscodeshiftExecutable = require.resolve('.bin/jscodeshift');
 exports.transformerDirectory = path_1.default.join(__dirname, '../', 'transforms');
 function checkGitStatus(force) {
@@ -187,6 +188,10 @@ function run() {
     if (!cli.flags.dry) {
         checkGitStatus(cli.flags.force);
     }
+    const isUpgrade = cli.input[0] === 'upgrade' || cli.input[0] === 'up';
+    if (isUpgrade) {
+        return (0, upgrade_1.runUpgrade)().catch(console.error);
+    }
     if (cli.input[0] &&
         !TRANSFORMER_INQUIRER_CHOICES.find((x) => x.value === cli.input[0])) {
         console.error('Invalid transform choice, pick one of:');

package/bin/upgrade.js

@@ -0,0 +1,246 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runUpgrade = runUpgrade;
+const prompts_1 = __importDefault(require("prompts"));
+const fs_1 = __importDefault(require("fs"));
+const child_process_1 = require("child_process");
+const path_1 = __importDefault(require("path"));
+const compare_versions_1 = require("compare-versions");
+const chalk_1 = __importDefault(require("chalk"));
+const codemods_1 = require("../lib/codemods");
+const handle_package_1 = require("../lib/handle-package");
+function runUpgrade() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const appPackageJsonPath = path_1.default.resolve(process.cwd(), 'package.json');
+        let appPackageJson = JSON.parse(fs_1.default.readFileSync(appPackageJsonPath, 'utf8'));
+        yield detectWorkspace(appPackageJson);
+        let targetNextPackageJson;
+        let targetVersionSpecifier = '';
+        const shortcutVersion = (_a = process.argv[2]) === null || _a === void 0 ? void 0 : _a.replace('@', '');
+        if (shortcutVersion) {
+            const res = yield fetch(`https://registry.npmjs.org/next/${shortcutVersion}`);
+            if (res.status === 200) {
+                targetNextPackageJson = yield res.json();
+                targetVersionSpecifier = targetNextPackageJson.version;
+            }
+            else {
+                console.error(`${chalk_1.default.yellow('Next.js ' + shortcutVersion)} does not exist. Check available versions at ${chalk_1.default.underline('https://www.npmjs.com/package/next?activeTab=versions')}, or choose one from below\n`);
+            }
+        }
+        const installedNextVersion = yield getInstalledNextVersion();
+        if (!targetNextPackageJson) {
+            let nextPackageJson = {};
+            try {
+                const resCanary = yield fetch(`https://registry.npmjs.org/next/canary`);
+                nextPackageJson['canary'] = yield resCanary.json();
+                const resRc = yield fetch(`https://registry.npmjs.org/next/rc`);
+                nextPackageJson['rc'] = yield resRc.json();
+                const resLatest = yield fetch(`https://registry.npmjs.org/next/latest`);
+                nextPackageJson['latest'] = yield resLatest.json();
+            }
+            catch (error) {
+                console.error('Failed to fetch versions from npm registry.');
+                return;
+            }
+            let showRc = true;
+            if (nextPackageJson['latest'].version && nextPackageJson['rc'].version) {
+                showRc =
+                    (0, compare_versions_1.compareVersions)(nextPackageJson['rc'].version, nextPackageJson['latest'].version) === 1;
+            }
+            const choices = [
+                {
+                    title: 'Canary',
+                    value: 'canary',
+                    description: `Experimental version with latest features (${nextPackageJson['canary'].version})`,
+                },
+            ];
+            if (showRc) {
+                choices.push({
+                    title: 'Release Candidate',
+                    value: 'rc',
+                    description: `Pre-release version for final testing (${nextPackageJson['rc'].version})`,
+                });
+            }
+            choices.push({
+                title: 'Stable',
+                value: 'latest',
+                description: `Production-ready release (${nextPackageJson['latest'].version})`,
+            });
+            if (installedNextVersion) {
+                console.log(`You are currently using ${chalk_1.default.blue('Next.js ' + installedNextVersion)}`);
+            }
+            const initialVersionSpecifierIdx = yield getVersionSpecifierIdx(installedNextVersion, showRc);
+            const response = yield (0, prompts_1.default)({
+                type: 'select',
+                name: 'version',
+                message: 'What Next.js version do you want to upgrade to?',
+                choices: choices,
+                initial: initialVersionSpecifierIdx,
+            }, { onCancel: () => process.exit(0) });
+            targetNextPackageJson = nextPackageJson[response.version];
+            targetVersionSpecifier = response.version;
+        }
+        const targetNextVersion = targetNextPackageJson.version;
+        if (targetNextVersion &&
+            (0, compare_versions_1.compareVersions)(targetNextVersion, '15.0.0-canary') >= 0) {
+            yield suggestTurbopack(appPackageJson);
+        }
+        fs_1.default.writeFileSync(appPackageJsonPath, JSON.stringify(appPackageJson, null, 2));
+        const packageManager = (0, handle_package_1.getPkgManager)(process.cwd());
+        const nextDependency = `next@${targetNextVersion}`;
+        const reactDependencies = [
+            `react@${targetNextPackageJson.peerDependencies['react']}`,
+            `@types/react@${targetNextPackageJson.devDependencies['@types/react']}`,
+            `react-dom@${targetNextPackageJson.peerDependencies['react-dom']}`,
+            `@types/react-dom@${targetNextPackageJson.devDependencies['@types/react-dom']}`,
+        ];
+        (0, handle_package_1.installPackage)([nextDependency, ...reactDependencies], packageManager);
+        console.log(`Upgrading your project to ${chalk_1.default.blue('Next.js ' + targetVersionSpecifier)}...\n`);
+        yield suggestCodemods(installedNextVersion, targetNextVersion);
+        console.log(`\n${chalk_1.default.green('✔')} Your Next.js project has been upgraded successfully. ${chalk_1.default.bold('Time to ship! 🚢')}`);
+    });
+}
+function detectWorkspace(appPackageJson) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let isWorkspace = appPackageJson.workspaces ||
+            fs_1.default.existsSync(path_1.default.resolve(process.cwd(), 'pnpm-workspace.yaml'));
+        if (!isWorkspace)
+            return;
+        console.log(`${chalk_1.default.red('⚠️')} You seem to be in the root of a monorepo. ${chalk_1.default.blue('@next/upgrade')} should be run in a specific app directory within the monorepo.`);
+        const response = yield (0, prompts_1.default)({
+            type: 'confirm',
+            name: 'value',
+            message: 'Do you still want to continue?',
+            initial: false,
+        }, { onCancel: () => process.exit(0) });
+        if (!response.value) {
+            process.exit(0);
+        }
+    });
+}
+function getInstalledNextVersion() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const installedNextPackageJsonDir = require.resolve('next/package.json', {
+            paths: [process.cwd()],
+        });
+        const installedNextPackageJson = JSON.parse(fs_1.default.readFileSync(installedNextPackageJsonDir, 'utf8'));
+        return installedNextPackageJson.version;
+    });
+}
+/*
+ * Returns the index of the current version's specifier in the
+ * array ['canary', 'rc', 'latest'] or ['canary', 'latest']
+ */
+function getVersionSpecifierIdx(installedNextVersion, showRc) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (installedNextVersion == null) {
+            return 0;
+        }
+        if (installedNextVersion.includes('canary')) {
+            return 0;
+        }
+        if (installedNextVersion.includes('rc')) {
+            return 1;
+        }
+        return showRc ? 2 : 1;
+    });
+}
+/*
+ * Heuristics are used to determine whether to Turbopack is enabled or not and
+ * to determine how to update the dev script.
+ *
+ * 1. If the dev script contains `--turbo` option, we assume that Turbopack is
+ *    already enabled.
+ * 2. If the dev script contains the string `next dev`, we replace it to
+ *    `next dev --turbo`.
+ * 3. Otherwise, we ask the user to manually add `--turbo` to their dev command,
+ *    showing the current dev command as the initial value.
+ */
+function suggestTurbopack(packageJson) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const devScript = packageJson.scripts['dev'];
+        if (devScript.includes('--turbo'))
+            return;
+        const responseTurbopack = yield (0, prompts_1.default)({
+            type: 'confirm',
+            name: 'enable',
+            message: 'Turbopack is now the stable default for dev mode. Enable it?',
+            initial: true,
+        }, {
+            onCancel: () => {
+                process.exit(0);
+            },
+        });
+        if (!responseTurbopack.enable) {
+            return;
+        }
+        if (devScript.includes('next dev')) {
+            packageJson.scripts['dev'] = devScript.replace('next dev', 'next dev --turbo');
+            return;
+        }
+        const responseCustomDevScript = yield (0, prompts_1.default)({
+            type: 'text',
+            name: 'customDevScript',
+            message: 'Please add `--turbo` to your dev command:',
+            initial: devScript,
+        });
+        packageJson.scripts['dev'] =
+            responseCustomDevScript.customDevScript || devScript;
+    });
+}
+function suggestCodemods(initialNextVersion, targetNextVersion) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const initialVersionIndex = codemods_1.availableCodemods.findIndex((versionCodemods) => (0, compare_versions_1.compareVersions)(versionCodemods.version, initialNextVersion) > 0);
+        if (initialVersionIndex === -1) {
+            return;
+        }
+        let targetVersionIndex = codemods_1.availableCodemods.findIndex((versionCodemods) => (0, compare_versions_1.compareVersions)(versionCodemods.version, targetNextVersion) > 0);
+        if (targetVersionIndex === -1) {
+            targetVersionIndex = codemods_1.availableCodemods.length;
+        }
+        const relevantCodemods = codemods_1.availableCodemods
+            .slice(initialVersionIndex, targetVersionIndex)
+            .flatMap((versionCodemods) => versionCodemods.codemods);
+        if (relevantCodemods.length === 0) {
+            return;
+        }
+        let codemodsString = `\nThe following ${chalk_1.default.blue('codemods')} are available for your upgrade:`;
+        relevantCodemods.forEach((codemod) => {
+            codemodsString += `\n- ${codemod.title} ${chalk_1.default.gray(`(${codemod.value})`)}`;
+        });
+        codemodsString += '\n';
+        console.log(codemodsString);
+        const responseCodemods = yield (0, prompts_1.default)({
+            type: 'confirm',
+            name: 'apply',
+            message: `Do you want to apply these codemods?`,
+            initial: true,
+        }, {
+            onCancel: () => {
+                process.exit(0);
+            },
+        });
+        if (!responseCodemods.apply) {
+            return;
+        }
+        for (const codemod of relevantCodemods) {
+            (0, child_process_1.execSync)(`npx @next/codemod@latest ${codemod.value} ${process.cwd()} --force`, {
+                stdio: 'inherit',
+            });
+        }
+    });
+}
+//# sourceMappingURL=upgrade.js.map

package/lib/codemods.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.availableCodemods = void 0;
+exports.availableCodemods = [
+    {
+        version: '6',
+        codemods: [
+            {
+                title: 'Use withRouter',
+                value: 'url-to-withrouter',
+            },
+        ],
+    },
+    {
+        version: '8',
+        codemods: [
+            {
+                title: 'Transform AMP HOC into page config',
+                value: 'withamp-to-config',
+            },
+        ],
+    },
+    {
+        version: '9',
+        codemods: [
+            {
+                title: 'Transform Anonymous Components into Named Components',
+                value: 'name-default-component',
+            },
+        ],
+    },
+    {
+        version: '10',
+        codemods: [
+            {
+                title: 'Add React Import',
+                value: 'add-missing-react-import',
+            },
+        ],
+    },
+    {
+        version: '11',
+        codemods: [
+            {
+                title: 'Migrate from CRA',
+                value: 'cra-to-next',
+            },
+        ],
+    },
+    {
+        version: '13.0',
+        codemods: [
+            {
+                title: 'Remove <a> Tags From Link Components',
+                value: 'new-link',
+            },
+            {
+                title: 'Migrate to the New Image Component',
+                value: 'next-image-experimental',
+            },
+            {
+                title: 'Rename Next Image Imports',
+                value: 'next-image-to-legacy-image',
+            },
+        ],
+    },
+    {
+        version: '13.2',
+        codemods: [
+            {
+                title: 'Use Built-in Font',
+                value: 'built-in-next-font',
+            },
+        ],
+    },
+    {
+        version: '14.0',
+        codemods: [
+            {
+                title: 'Migrate ImageResponse imports',
+                value: 'next-og-import',
+            },
+            {
+                title: 'Use viewport export',
+                value: 'metadata-to-viewport-export',
+            },
+        ],
+    },
+    {
+        version: '15.0',
+        codemods: [
+            {
+                title: 'Transforms usage of Next.js async Request APIs',
+                value: 'next-async-request-api',
+            },
+            {
+                title: 'Migrate `geo` and `ip` properties on `NextRequest`',
+                value: 'next-request-geo-ip',
+            },
+        ],
+    },
+];
+//# sourceMappingURL=codemods.js.map

package/lib/handle-package.js

@@ -3,24 +3,54 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPkgManager = getPkgManager;
 exports.uninstallPackage = uninstallPackage;
 exports.installPackage = installPackage;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const execa_1 = __importDefault(require("execa"));
 function getPkgManager(baseDir) {
-    for (const { lockFile, packageManager } of [
-        { lockFile: 'yarn.lock', packageManager: 'yarn' },
-        { lockFile: 'pnpm-lock.yaml', packageManager: 'pnpm' },
-        { lockFile: 'package-lock.json', packageManager: 'npm' },
-    ]) {
-        if (fs_1.default.existsSync(path_1.default.join(baseDir, lockFile))) {
-            return packageManager;
+    try {
+        for (const { lockFile, packageManager } of [
+            { lockFile: 'yarn.lock', packageManager: 'yarn' },
+            { lockFile: 'pnpm-lock.yaml', packageManager: 'pnpm' },
+            { lockFile: 'package-lock.json', packageManager: 'npm' },
+            { lockFile: 'bun.lockb', packageManager: 'bun' },
+        ]) {
+            if (fs_1.default.existsSync(path_1.default.join(baseDir, lockFile))) {
+                return packageManager;
+            }
+        }
+        const userAgent = process.env.npm_config_user_agent;
+        if (userAgent) {
+            if (userAgent.startsWith('yarn')) {
+                return 'yarn';
+            }
+            else if (userAgent.startsWith('pnpm')) {
+                return 'pnpm';
+            }
+        }
+        try {
+            execa_1.default.sync('yarn --version', { stdio: 'ignore' });
+            return 'yarn';
         }
+        catch (_a) {
+            try {
+                execa_1.default.sync('pnpm --version', { stdio: 'ignore' });
+                return 'pnpm';
+            }
+            catch (_b) {
+                execa_1.default.sync('bun --version', { stdio: 'ignore' });
+                return 'bun';
+            }
+        }
+    }
+    catch (_c) {
+        return 'npm';
     }
 }
-function uninstallPackage(packageToUninstall) {
-    const pkgManager = getPkgManager(process.cwd());
+function uninstallPackage(packageToUninstall, pkgManager) {
+    pkgManager !== null && pkgManager !== void 0 ? pkgManager : (pkgManager = getPkgManager(process.cwd()));
     if (!pkgManager)
         throw new Error('Failed to find package manager');
     let command = 'uninstall';
@@ -29,10 +59,13 @@ function uninstallPackage(packageToUninstall) {
     }
     execa_1.default.sync(pkgManager, [command, packageToUninstall], { stdio: 'inherit' });
 }
-function installPackage(packageToInstall) {
-    const pkgManager = getPkgManager(process.cwd());
+function installPackage(packageToInstall, pkgManager) {
+    pkgManager !== null && pkgManager !== void 0 ? pkgManager : (pkgManager = getPkgManager(process.cwd()));
     if (!pkgManager)
         throw new Error('Failed to find package manager');
+    if (Array.isArray(packageToInstall)) {
+        packageToInstall = packageToInstall.join(' ');
+    }
     try {
         execa_1.default.sync(pkgManager, ['add', packageToInstall], { stdio: 'inherit' });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next/codemod",
-  "version": "15.0.0-canary.165",
+  "version": "15.0.0-canary.166",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -8,14 +8,17 @@
     "directory": "packages/next-codemod"
   },
   "dependencies": {
+    "chalk": "4.1.2",
     "cheerio": "1.0.0-rc.9",
+    "compare-versions": "6.1.1",
     "execa": "4.0.3",
     "globby": "11.0.1",
     "inquirer": "7.3.3",
     "is-git-clean": "1.1.0",
     "jscodeshift": "17.0.0",
     "meow": "7.0.1",
-    "picocolors": "1.0.0"
+    "picocolors": "1.0.0",
+    "prompts": "2.4.2"
   },
   "files": [
     "transforms/*.js",