@next/codemod 15.0.0-rc.0 → 15.0.0

package/lib/cra-to-next/global-css-transform.js

@@ -4,14 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.globalCssContext = void 0;
+exports.default = transformer;
 const path_1 = __importDefault(require("path"));
+const parser_1 = require("../parser");
 exports.globalCssContext = {
     cssImports: new Set(),
     reactSvgImports: new Set(),
 };
 const globalStylesRegex = /(?<!\.module)\.(css|scss|sass)$/i;
-function transformer(file, api, options) {
-    const j = api.jscodeshift.withParser('tsx');
+function transformer(file, _api, options) {
+    const j = (0, parser_1.createParserFromPath)(file.path);
     const root = j(file.source);
     let hasModifications = false;
     root
@@ -37,8 +39,7 @@ function transformer(file, api, options) {
             }
             else if (value.endsWith('.svg')) {
                 const isComponentImport = path.node.specifiers.some((specifier) => {
-                    var _a;
-                    return ((_a = specifier.imported) === null || _a === void 0 ? void 0 : _a.name) === 'ReactComponent';
+                    return specifier.imported?.name === 'ReactComponent';
                 });
                 if (isComponentImport) {
                     exports.globalCssContext.reactSvgImports.add(file.path);
@@ -52,5 +53,4 @@ function transformer(file, api, options) {
         ? root.toSource(options)
         : null;
 }
-exports.default = transformer;
 //# sourceMappingURL=global-css-transform.js.map

package/lib/cra-to-next/index-to-component.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.indexContext = void 0;
+exports.default = transformer;
+const parser_1 = require("../parser");
 exports.indexContext = {
     multipleRenderRoots: false,
     nestedRender: false,
 };
-function transformer(file, api, options) {
-    const j = api.jscodeshift.withParser('tsx');
+function transformer(file, _api, options) {
+    const j = (0, parser_1.createParserFromPath)(file.path);
     const root = j(file.source);
     let hasModifications = false;
     let foundReactRender = 0;
@@ -28,7 +30,6 @@ function transformer(file, api, options) {
     root
         .find(j.CallExpression)
         .filter((path) => {
-        var _a, _b;
         const { node } = path;
         let found = false;
         if (defaultReactDomImport &&
@@ -43,7 +44,7 @@ function transformer(file, api, options) {
         if (found) {
             foundReactRender++;
             hasModifications = true;
-            if (!Array.isArray((_b = (_a = path.parentPath) === null || _a === void 0 ? void 0 : _a.parentPath) === null || _b === void 0 ? void 0 : _b.value)) {
+            if (!Array.isArray(path.parentPath?.parentPath?.value)) {
                 exports.indexContext.nestedRender = true;
                 return false;
             }
@@ -73,5 +74,4 @@ function transformer(file, api, options) {
     // }).remove()
     return hasModifications ? root.toSource(options) : null;
 }
-exports.default = transformer;
 //# sourceMappingURL=index-to-component.js.map

package/lib/handle-package.js

@@ -0,0 +1,110 @@
+"use strict";
+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.installPackages = installPackages;
+exports.runInstallation = runInstallation;
+exports.addPackageDependency = addPackageDependency;
+const find_up_1 = __importDefault(require("find-up"));
+const execa_1 = __importDefault(require("execa"));
+const node_path_1 = require("node:path");
+function getPkgManager(baseDir) {
+    try {
+        const lockFile = find_up_1.default.sync(['package-lock.json', 'yarn.lock', 'pnpm-lock.yaml', 'bun.lockb'], { cwd: baseDir });
+        if (lockFile) {
+            switch ((0, node_path_1.basename)(lockFile)) {
+                case 'package-lock.json':
+                    return 'npm';
+                case 'yarn.lock':
+                    return 'yarn';
+                case 'pnpm-lock.yaml':
+                    return 'pnpm';
+                case 'bun.lockb':
+                    return 'bun';
+                default:
+                    return 'npm';
+            }
+        }
+    }
+    catch {
+        return 'npm';
+    }
+}
+function uninstallPackage(packageToUninstall, pkgManager) {
+    pkgManager ??= getPkgManager(process.cwd());
+    if (!pkgManager)
+        throw new Error('Failed to find package manager');
+    let command = 'uninstall';
+    if (pkgManager === 'yarn') {
+        command = 'remove';
+    }
+    try {
+        execa_1.default.sync(pkgManager, [command, packageToUninstall], {
+            stdio: 'inherit',
+            shell: true,
+        });
+    }
+    catch (error) {
+        throw new Error(`Failed to uninstall "${packageToUninstall}". Please uninstall it manually.`, { cause: error });
+    }
+}
+const ADD_CMD_FLAG = {
+    npm: 'install',
+    yarn: 'add',
+    pnpm: 'add',
+    bun: 'add',
+};
+const DEV_DEP_FLAG = {
+    npm: '--save-dev',
+    yarn: '--dev',
+    pnpm: '--save-dev',
+    bun: '--dev',
+};
+function installPackages(packageToInstall, options = {}) {
+    if (packageToInstall.length === 0)
+        return;
+    const { packageManager = getPkgManager(process.cwd()), silent = false, dev = false, } = options;
+    if (!packageManager)
+        throw new Error('Failed to find package manager');
+    const addCmd = ADD_CMD_FLAG[packageManager];
+    const devDepFlag = dev ? DEV_DEP_FLAG[packageManager] : undefined;
+    const installFlags = [addCmd];
+    if (devDepFlag) {
+        installFlags.push(devDepFlag);
+    }
+    try {
+        execa_1.default.sync(packageManager, [...installFlags, ...packageToInstall], {
+            // Keeping stderr since it'll likely be relevant later when it fails.
+            stdio: silent ? ['ignore', 'ignore', 'inherit'] : 'inherit',
+            shell: true,
+        });
+    }
+    catch (error) {
+        throw new Error(`Failed to install "${packageToInstall}". Please install it manually.`, { cause: error });
+    }
+}
+function runInstallation(packageManager) {
+    try {
+        execa_1.default.sync(packageManager, ['install'], {
+            stdio: 'inherit',
+            shell: true,
+        });
+    }
+    catch (error) {
+        throw new Error('Failed to install dependencies', { cause: error });
+    }
+}
+function addPackageDependency(packageJson, name, version, dev) {
+    if (dev) {
+        packageJson.devDependencies = packageJson.devDependencies || {};
+    }
+    else {
+        packageJson.dependencies = packageJson.dependencies || {};
+    }
+    const deps = dev ? packageJson.devDependencies : packageJson.dependencies;
+    deps[name] = version;
+}
+//# sourceMappingURL=handle-package.js.map

package/lib/install.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.install = void 0;
+exports.install = install;
 /* eslint-disable import/no-extraneous-dependencies */
 const picocolors_1 = require("picocolors");
 const cross_spawn_1 = __importDefault(require("cross-spawn"));
@@ -84,7 +84,7 @@ function install(root, dependencies, { useYarn, isOnline, devDependencies }) {
          */
         const child = (0, cross_spawn_1.default)(command, args, {
             stdio: 'inherit',
-            env: Object.assign(Object.assign({}, process.env), { ADBLOCK: '1', DISABLE_OPENCOLLECTIVE: '1' }),
+            env: { ...process.env, ADBLOCK: '1', DISABLE_OPENCOLLECTIVE: '1' },
         });
         child.on('close', (code) => {
             if (code !== 0) {
@@ -95,5 +95,4 @@ function install(root, dependencies, { useYarn, isOnline, devDependencies }) {
         });
     });
 }
-exports.install = install;
 //# sourceMappingURL=install.js.map

package/lib/parser.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createParserFromPath = createParserFromPath;
+const jscodeshift_1 = __importDefault(require("jscodeshift"));
+const babylon_1 = __importDefault(require("jscodeshift/parser/babylon"));
+const tsOptions_1 = __importDefault(require("jscodeshift/parser/tsOptions"));
+const dtsOptions = {
+    ...tsOptions_1.default,
+    plugins: [
+        ...tsOptions_1.default.plugins.filter((plugin) => plugin !== 'typescript'),
+        ['typescript', { dts: true }],
+    ],
+};
+function createParserFromPath(filePath) {
+    const isDeclarationFile = /\.d\.(m|c)?ts$/.test(filePath);
+    if (isDeclarationFile) {
+        return jscodeshift_1.default.withParser((0, babylon_1.default)(dtsOptions));
+    }
+    // jsx is allowed in .js files, feed them into the tsx parser.
+    // tsx parser :.js, .jsx, .tsx
+    // ts parser: .ts, .mts, .cts
+    const isTsFile = /\.(m|c)?.ts$/.test(filePath);
+    return isTsFile ? jscodeshift_1.default.withParser('ts') : jscodeshift_1.default.withParser('tsx');
+}
+//# sourceMappingURL=parser.js.map

package/lib/run-jscodeshift.js

@@ -3,12 +3,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = runJscodeshift;
 // @ts-ignore internal module
 const Runner_1 = __importDefault(require("jscodeshift/src/Runner"));
 function runJscodeshift(transformerPath, flags, files) {
     // we run jscodeshift in the same process to be able to
     // share state between the main CRA transform and sub-transforms
-    return Runner_1.default.run(transformerPath, files, Object.assign({ ignorePattern: ['**/node_modules/**', '**/.next/**', '**/build/**'], extensions: 'tsx,ts,jsx,js', parser: 'tsx', verbose: 2, runInBand: true }, flags));
+    return Runner_1.default.run(transformerPath, files, {
+        ignorePattern: [
+            '**/node_modules/**',
+            '**/.next/**',
+            '**/build/**',
+            // test files
+            '**/*.test.*',
+            '**/*.spec.*',
+            '**/__tests__/**',
+            '**/__mocks__/**',
+        ],
+        extensions: 'tsx,ts,jsx,js',
+        parser: 'tsx',
+        verbose: 2,
+        runInBand: true,
+        ...flags,
+    });
 }
-exports.default = runJscodeshift;
 //# sourceMappingURL=run-jscodeshift.js.map

package/lib/utils.js

@@ -0,0 +1,115 @@
+"use strict";
+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.checkGitStatus = checkGitStatus;
+exports.onCancel = onCancel;
+const picocolors_1 = require("picocolors");
+const is_git_clean_1 = __importDefault(require("is-git-clean"));
+function checkGitStatus(force) {
+    let clean = false;
+    let errorMessage = 'Unable to determine if git directory is clean';
+    try {
+        clean = is_git_clean_1.default.sync(process.cwd());
+        errorMessage = 'Git directory is not clean';
+    }
+    catch (err) {
+        if (err && err.stderr && err.stderr.includes('Not a git repository')) {
+            clean = true;
+        }
+    }
+    if (!clean) {
+        if (force) {
+            console.log(`WARNING: ${errorMessage}. Forcibly continuing.`);
+        }
+        else {
+            console.log('Thank you for using @next/codemod!');
+            console.log((0, picocolors_1.yellow)('\nBut before we continue, please stash or commit your git changes.'));
+            console.log('\nYou may use the --force flag to override this safety check.');
+            process.exit(1);
+        }
+    }
+}
+function onCancel() {
+    process.exit(1);
+}
+exports.TRANSFORMER_INQUIRER_CHOICES = [
+    {
+        title: 'Transform the deprecated automatically injected url property on top level pages to using withRouter',
+        value: 'url-to-withrouter',
+        version: '6.0.0',
+    },
+    {
+        title: 'Transforms the withAmp HOC into Next.js 9 page configuration',
+        value: 'withamp-to-config',
+        version: '8.0.0',
+    },
+    {
+        title: 'Transforms anonymous components into named components to make sure they work with Fast Refresh',
+        value: 'name-default-component',
+        version: '9.0.0',
+    },
+    {
+        title: 'Transforms files that do not import `React` to include the import in order for the new React JSX transform',
+        value: 'add-missing-react-import',
+        version: '10.0.0',
+    },
+    {
+        title: 'Automatically migrates a Create React App project to Next.js (experimental)',
+        value: 'cra-to-next',
+        version: '11.0.0',
+    },
+    {
+        title: 'Ensures your <Link> usage is backwards compatible',
+        value: 'new-link',
+        version: '13.0.0',
+    },
+    {
+        title: 'Dangerously migrates from `next/legacy/image` to the new `next/image` by adding inline styles and removing unused props (experimental)',
+        value: 'next-image-experimental',
+        version: '13.0.0',
+    },
+    {
+        title: 'Safely migrate Next.js 10, 11, 12 applications importing `next/image` to the renamed `next/legacy/image` import in Next.js 13',
+        value: 'next-image-to-legacy-image',
+        version: '13.0.0',
+    },
+    {
+        title: 'Uninstall `@next/font` and transform imports to `next/font`',
+        value: 'built-in-next-font',
+        version: '13.2.0',
+    },
+    {
+        title: 'Migrates certain viewport related metadata from the `metadata` export to a new `viewport` export',
+        value: 'metadata-to-viewport-export',
+        version: '14.0.0',
+    },
+    {
+        title: 'Transforms imports from `next/server` to `next/og` for usage of Dynamic OG Image Generation',
+        value: 'next-og-import',
+        version: '14.0.0',
+    },
+    {
+        title: 'Transform `next/dynamic` imports accessing named exports to return an object with a `default` property',
+        value: 'next-dynamic-access-named-export',
+        version: '15.0.0-canary.44',
+    },
+    {
+        title: 'Install `@vercel/functions` to replace `geo` and `ip` properties on `NextRequest`',
+        value: 'next-request-geo-ip',
+        version: '15.0.0-canary.153',
+    },
+    {
+        title: 'Transforms usage of Next.js async Request APIs',
+        value: 'next-async-request-api',
+        version: '15.0.0-canary.171',
+    },
+    {
+        title: 'Transform App Router Route Segment Config `runtime` value from `experimental-edge` to `edge`',
+        value: 'app-dir-runtime-config-experimental-edge',
+        version: '15.0.0-canary.179',
+    },
+];
+//# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next/codemod",
-  "version": "15.0.0-rc.0",
+  "version": "15.0.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,16 +9,19 @@
   },
   "dependencies": {
     "cheerio": "1.0.0-rc.9",
+    "commander": "12.1.0",
     "execa": "4.0.3",
+    "find-up": "4.1.0",
     "globby": "11.0.1",
-    "inquirer": "7.3.3",
     "is-git-clean": "1.1.0",
-    "jscodeshift": "0.13.1",
-    "meow": "7.0.1",
-    "picocolors": "1.0.0"
+    "jscodeshift": "17.0.0",
+    "picocolors": "1.0.0",
+    "prompts": "2.4.2",
+    "semver": "7.6.3"
   },
   "files": [
     "transforms/*.js",
+    "transforms/lib/**/*.js",
     "bin/*.js",
     "lib/**/*.js",
     "lib/cra-to-next/gitignore"
@@ -27,10 +30,15 @@
     "build": "pnpm tsc -d -p tsconfig.json",
     "prepublishOnly": "cd ../../ && turbo run build",
     "dev": "pnpm tsc -d -w -p tsconfig.json",
-    "test": "jest"
+    "test": "jest",
+    "test:upgrade-fixture": "./scripts/test-upgrade-fixture.sh"
   },
   "bin": "./bin/next-codemod.js",
   "devDependencies": {
-    "@types/jscodeshift": "0.11.0"
+    "@types/find-up": "4.0.0",
+    "@types/jscodeshift": "0.11.0",
+    "@types/prompts": "2.4.2",
+    "@types/semver": "7.3.1",
+    "typescript": "5.5.3"
   }
 }

package/transforms/add-missing-react-import.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = transformer;
+const parser_1 = require("../lib/parser");
 function addReactImport(j, root) {
     // We create an import specifier, this is the value of an import, eg:
     // import React from 'react'
@@ -33,8 +35,8 @@ function addReactImport(j, root) {
         node.value.body.unshift(ReactImport);
     });
 }
-function transformer(file, api, options) {
-    const j = api.jscodeshift.withParser('tsx');
+function transformer(file, _api, options) {
+    const j = (0, parser_1.createParserFromPath)(file.path);
     const root = j(file.source);
     const hasReactImport = (r) => {
         return (r.find(j.ImportDefaultSpecifier, {
@@ -60,5 +62,4 @@ function transformer(file, api, options) {
     }
     return root.toSource(options);
 }
-exports.default = transformer;
 //# sourceMappingURL=add-missing-react-import.js.map

package/transforms/app-dir-runtime-config-experimental-edge.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = transformer;
+const parser_1 = require("../lib/parser");
+function transformer(file, _api) {
+    if (process.env.NODE_ENV !== 'test' &&
+        !/[/\\]app[/\\].*?(page|layout|route)\.[^/\\]+$/.test(file.path)) {
+        return file.source;
+    }
+    const j = (0, parser_1.createParserFromPath)(file.path);
+    const root = j(file.source);
+    const runtimeExport = root.find(j.ExportNamedDeclaration, {
+        declaration: {
+            type: 'VariableDeclaration',
+            declarations: [
+                {
+                    id: { name: 'runtime' },
+                },
+            ],
+        },
+    });
+    if (runtimeExport.size() !== 1) {
+        return file.source;
+    }
+    const runtimeValue = runtimeExport.find(j.StringLiteral, {
+        value: 'experimental-edge',
+    });
+    if (runtimeValue.size() !== 1) {
+        return file.source;
+    }
+    runtimeValue.replaceWith(j.stringLiteral('edge'));
+    return root.toSource();
+}
+//# sourceMappingURL=app-dir-runtime-config-experimental-edge.js.map

package/transforms/built-in-next-font.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-function transformer(file, api, options) {
-    const j = api.jscodeshift.withParser('tsx');
+exports.default = transformer;
+const parser_1 = require("../lib/parser");
+function transformer(file, _api, options) {
+    const j = (0, parser_1.createParserFromPath)(file.path);
     const root = j(file.source);
     let hasChanges = false;
     // Before: import { ... } from '@next/font'
@@ -36,5 +38,4 @@ function transformer(file, api, options) {
     });
     return hasChanges ? root.toSource(options) : file.source;
 }
-exports.default = transformer;
 //# sourceMappingURL=built-in-next-font.js.map