Codemods

Codemods 是以编程方式在你的代码库上运行的转换工具。这允许以编程方式应用大量更改，而无需手动检查每个文件。

Next.js 提供 Codemod 转换工具来帮助你在 API 更新或弃用时升级 Next.js 代码库。

使用方法

在终端中，导航（cd）到项目文件夹，然后运行：

Terminal

npx @next/codemod <transform> <path>

将 <transform> 和 <path> 替换为适当的值。

transform - 转换工具的名称
path - 要转换的文件或目录
--dry 执行演习，不会编辑代码
--print 打印更改后的输出以供比较

Codemods

16.0

从 App Router 页面和布局中移除 `experimental_ppr` Route Segment Config

`remove-experimental-ppr`

Terminal

npx @next/codemod@latest remove-experimental-ppr .

此 codemod 从 App Router 页面和布局中移除 experimental_ppr Route Segment Config。

app/page.tsx

- export const experimental_ppr = true;

从稳定的 API 中移除 `unstable_` 前缀

`remove-unstable-prefix`

Terminal

npx @next/codemod@latest remove-unstable-prefix .

此 codemod 从稳定的 API 中移除 unstable_ 前缀。

例如：

import { unstable_cacheTag as cacheTag } from 'next/cache'
 
cacheTag()

转换为：

import { cacheTag } from 'next/cache'
 
cacheTag()

从已弃用的 `middleware` 约定迁移到 `proxy`

`middleware-to-proxy`

Terminal

npx @next/codemod@latest middleware-to-proxy .

此 codemod 将项目从使用已弃用的 middleware 约定迁移到使用 proxy 约定。它会：

将 middleware.<extension> 重命名为 proxy.<extension>（例如 middleware.ts 重命名为 proxy.ts）
将命名导出 middleware 重命名为 proxy
将 Next.js 配置属性 experimental.middlewarePrefetch 重命名为 experimental.proxyPrefetch
将 Next.js 配置属性 experimental.middlewareClientMaxBodySize 重命名为 experimental.proxyClientMaxBodySize
将 Next.js 配置属性 experimental.externalMiddlewareRewritesResolve 重命名为 experimental.externalProxyRewritesResolve
将 Next.js 配置属性 skipMiddlewareUrlNormalize 重命名为 skipProxyUrlNormalize

例如：

middleware.ts

import { NextResponse } from 'next/server'
 
export function middleware() {
  return NextResponse.next()
}

转换为：

proxy.ts

import { NextResponse } from 'next/server'
 
export function proxy() {
  return NextResponse.next()
}

从 `next lint` 迁移到 ESLint CLI

`next-lint-to-eslint-cli`

Terminal

npx @next/codemod@canary next-lint-to-eslint-cli .

此 codemod 将项目从使用 next lint 迁移到使用带有本地 ESLint 配置的 ESLint CLI。它会：

创建一个带有 Next.js 推荐配置的 eslint.config.mjs 文件
更新 package.json 脚本以使用 eslint . 而不是 next lint
向 package.json 添加必要的 ESLint 依赖项
在发现现有 ESLint 配置时保留它们

例如：

package.json

{
  "scripts": {
    "lint": "next lint"
  }
}

变为：

package.json

{
  "scripts": {
    "lint": "eslint ."
  }
}

并创建：

eslint.config.mjs

import { dirname } from 'path'
import { fileURLToPath } from 'url'
import { FlatCompat } from '@eslint/eslintrc'
 
const __filename = fileURLToPath(import.meta.url)
const __dirname = dirname(__filename)
 
const compat = new FlatCompat({
  baseDirectory: __dirname,
})
 
const eslintConfig = [
  ...compat.extends('next/core-web-vitals', 'next/typescript'),
  {
    ignores: [
      'node_modules/**',
      '.next/**',
      'out/**',
      'build/**',
      'next-env.d.ts',
    ],
  },
]
 
export default eslintConfig

15.0

将 App Router Route Segment Config `runtime` 值从 `experimental-edge` 转换为 `edge`

`app-dir-runtime-config-experimental-edge`

注意：此 codemod 专用于 App Router。

Terminal

npx @next/codemod@latest app-dir-runtime-config-experimental-edge .

此 codemod 将 Route Segment Config runtime 值 experimental-edge 转换为 edge。

例如：

export const runtime = 'experimental-edge'

转换为：

export const runtime = 'edge'

迁移到异步 Dynamic APIs

之前支持同步访问并选择动态渲染的 API 现在是异步的。你可以在升级指南中阅读更多关于此重大更改的信息。

`next-async-request-api`

Terminal

npx @next/codemod@latest next-async-request-api .

此 codemod 将现在是异步的 dynamic APIs（来自 next/headers 的 cookies()、headers() 和 draftMode()）转换为正确地等待（await）或在适用时用 React.use() 包装。当无法自动迁移时，codemod 将添加类型转换（如果是 TypeScript 文件）或添加注释以告知用户需要手动审查和更新。

例如：

import { cookies, headers } from 'next/headers'
const token = cookies().get('token')
 
function useToken() {
  const token = cookies().get('token')
  return token
}
 
export default function Page() {
  const name = cookies().get('name')
}
 
function getHeader() {
  return headers().get('x-foo')
}

转换为：

import { use } from 'react'
import {
  cookies,
  headers,
  type UnsafeUnwrappedCookies,
  type UnsafeUnwrappedHeaders,
} from 'next/headers'
const token = (cookies() as unknown as UnsafeUnwrappedCookies).get('token')
 
function useToken() {
  const token = use(cookies()).get('token')
  return token
}
 
export default async function Page() {
  const name = (await cookies()).get('name')
}
 
function getHeader() {
  return (headers() as unknown as UnsafeUnwrappedHeaders).get('x-foo')
}

当我们在页面/路由入口（page.js、layout.js、route.js 或 default.js）或 generateMetadata / generateViewport APIs 中检测到对 params 或 searchParams props 的属性访问时，它将尝试将调用点从同步函数转换为异步函数，并等待属性访问。如果无法使其异步（例如在 Client Component 中），它将使用 React.use 来解包 promise。

例如：

// page.tsx
export default function Page({
  params,
  searchParams,
}: {
  params: { slug: string }
  searchParams: { [key: string]: string | string[] | undefined }
}) {
  const { value } = searchParams
  if (value === 'foo') {
    // ...
  }
}
 
export function generateMetadata({ params }: { params: { slug: string } }) {
  const { slug } = params
  return {
    title: `My Page - ${slug}`,
  }
}

转换为：

// page.tsx
export default async function Page(props: {
  params: Promise<{ slug: string }>
  searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}) {
  const searchParams = await props.searchParams
  const { value } = searchParams
  if (value === 'foo') {
    // ...
  }
}
 
export async function generateMetadata(props: {
  params: Promise<{ slug: string }>
}) {
  const params = await props.params
  const { slug } = params
  return {
    title: `My Page - ${slug}`,
  }
}

值得注意的是：当此 codemod 识别出可能需要手动干预的地方，但我们无法确定确切的修复方法时，它将向代码添加注释或类型转换以告知用户需要手动更新。这些注释以 @next/codemod 为前缀，类型转换以 UnsafeUnwrapped 为前缀。在明确删除这些注释之前，你的构建将报错。阅读更多。

用 `@vercel/functions` 替换 `NextRequest` 的 `geo` 和 `ip` 属性

`next-request-geo-ip`

Terminal

npx @next/codemod@latest next-request-geo-ip .

此 codemod 安装 @vercel/functions 并将 NextRequest 的 geo 和 ip 属性转换为相应的 @vercel/functions 功能。

例如：

import type { NextRequest } from 'next/server'
 
export function GET(req: NextRequest) {
  const { geo, ip } = req
}

转换为：

import type { NextRequest } from 'next/server'
import { geolocation, ipAddress } from '@vercel/functions'
 
export function GET(req: NextRequest) {
  const geo = geolocation(req)
  const ip = ipAddress(req)
}

14.0

迁移 `ImageResponse` 导入

`next-og-import`

Terminal

npx @next/codemod@latest next-og-import .

此 codemod 将导入从 next/server 转换为 next/og，以便使用动态 OG 图像生成。

例如：

import { ImageResponse } from 'next/server'

转换为：

import { ImageResponse } from 'next/og'

使用 `viewport` 导出

`metadata-to-viewport-export`

Terminal

npx @next/codemod@latest metadata-to-viewport-export .

此 codemod 将某些 viewport metadata 迁移到 viewport 导出。

例如：

export const metadata = {
  title: 'My App',
  themeColor: 'dark',
  viewport: {
    width: 1,
  },
}

转换为：

export const metadata = {
  title: 'My App',
}
 
export const viewport = {
  width: 1,
  themeColor: 'dark',
}

13.2

使用内置字体

`built-in-next-font`

Terminal

npx @next/codemod@latest built-in-next-font .

此 codemod 卸载 @next/font 包并将 @next/font 导入转换为内置的 next/font。

例如：

import { Inter } from '@next/font/google'

转换为：

import { Inter } from 'next/font/google'

13.0

重命名 Next Image 导入

`next-image-to-legacy-image`

Terminal

npx @next/codemod@latest next-image-to-legacy-image .

在现有的 Next.js 10、11 或 12 应用程序中，安全地将 next/image 导入重命名为 Next.js 13 中的 next/legacy/image。同时将 next/future/image 重命名为 next/image。

例如：

pages/index.js

import Image1 from 'next/image'
import Image2 from 'next/future/image'
 
export default function Home() {
  return (
    <div>
      <Image1 src="/test.jpg" width="200" height="300" />
      <Image2 src="/test.png" width="500" height="400" />
    </div>
  )
}

转换为：

pages/index.js

// 'next/image' 变为 'next/legacy/image'
import Image1 from 'next/legacy/image'
// 'next/future/image' 变为 'next/image'
import Image2 from 'next/image'
 
export default function Home() {
  return (
    <div>
      <Image1 src="/test.jpg" width="200" height="300" />
      <Image2 src="/test.png" width="500" height="400" />
    </div>
  )
}

迁移到新的 Image 组件

`next-image-experimental`

Terminal

npx @next/codemod@latest next-image-experimental .

通过添加内联样式和删除未使用的 props，危险地从 next/legacy/image 迁移到新的 next/image。

移除 layout prop 并添加 style。
移除 objectFit prop 并添加 style。
移除 objectPosition prop 并添加 style。
移除 lazyBoundary prop。
移除 lazyRoot prop。

从 Link 组件中移除 `<a>` 标签

`new-link`

Terminal

npx @next/codemod@latest new-link .

移除 Link 组件内的 <a> 标签。

例如：

<Link href="/about">
  <a>About</a>
</Link>
// 转换为
<Link href="/about">
  About
</Link>
 
<Link href="/about">
  <a onClick={() => console.log('clicked')}>About</a>
</Link>
// 转换为
<Link href="/about" onClick={() => console.log('clicked')}>
  About
</Link>

11

从 CRA 迁移

`cra-to-next`

Terminal

npx @next/codemod cra-to-next

将 Create React App 项目迁移到 Next.js；创建 Pages Router 和必要的配置以匹配行为。最初利用仅客户端渲染以防止由于 SSR 期间使用 window 而破坏兼容性，并且可以无缝启用以允许逐步采用 Next.js 特定功能。

请在此讨论中分享与此转换相关的任何反馈。

npx @next/codemod add-missing-react-import

转换未导入 React 的文件以包含导入，以便新的 React JSX 转换能够工作。

例如：

my-component.js

export default class Home extends React.Component {
  render() {
    return <div>Hello World</div>
  }
}

转换为：

my-component.js

import React from 'react'
export default class Home extends React.Component {
  render() {
    return <div>Hello World</div>
  }
}

npx @next/codemod name-default-component

版本 9 及以上。

将匿名组件转换为命名组件，以确保它们与 Fast Refresh 一起工作。

例如：

my-component.js

export default function () {
  return <div>Hello World</div>
}

转换为：

my-component.js

export default function MyComponent() {
  return <div>Hello World</div>
}

组件将根据文件名获得一个驼峰式命名，它也适用于箭头函数。

8

注意：内置 AMP 支持和此 codemod 已在 Next.js 16 中移除。

将 AMP HOC 转换为页面配置

`withamp-to-config`

Terminal

npx @next/codemod withamp-to-config

将 withAmp HOC 转换为 Next.js 9 页面配置。

例如：

// 之前
import { withAmp } from 'next/amp'
 
function Home() {
  return <h1>My AMP Page</h1>
}
 
export default withAmp(Home)

// 之后
export default function Home() {
  return <h1>My AMP Page</h1>
}
 
export const config = {
  amp: true,
}

npx @next/codemod url-to-withrouter

将顶层页面上已弃用的自动注入的 url 属性转换为使用 withRouter 及其注入的 router 属性。在此处阅读更多：https://nextjs.org/docs/messages/url-deprecated

例如：

从

import React from 'react'
export default class extends React.Component {
  render() {
    const { pathname } = this.props.url
    return <div>Current pathname: {pathname}</div>
  }
}

到

import React from 'react'
import { withRouter } from 'next/router'
export default withRouter(
  class extends React.Component {
    render() {
      const { pathname } = this.props.router
      return <div>Current pathname: {pathname}</div>
    }
  }
)

这是一个案例。所有被转换（和测试）的案例可以在 __testfixtures__ 目录中找到。