跳到内容
构建你的应用升级代码转换 (Codemods)

代码转换 (Codemods)

Codemod 是一种以编程方式在你的代码库上运行的转换。这允许以编程方式应用大量更改，而无需手动浏览每个文件。

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

用法

在你的终端中，导航 (cd) 到你的项目文件夹中，然后运行

终端
npx @next/codemod <transform> <path>

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

  • transform - 转换的名称
  • path - 要转换的文件或目录
  • --dry 执行空运行，不会编辑任何代码
  • --print 打印更改后的输出以进行比较

Codemods

15.0

转换 App Router 路由段配置 runtime 值，从 experimental-edge 到 edge

app-dir-runtime-config-experimental-edge

注意：此代码转换 (codemod) 仅适用于 App Router。

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

此代码转换 (codemod) 将 路由段配置 runtime 值 experimental-edge 转换为 edge。

例如

export const runtime = 'experimental-edge'

转换为

export const runtime = 'edge'

迁移到异步动态 API

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

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

此代码转换 (codemod) 将转换动态 API (来自 next/headers 的 cookies()、headers() 和 draftMode())，这些 API 现在是异步的，以便正确地被 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 API 中访问 params 或 searchParams props 的属性时，它将尝试将调用点从同步函数转换为异步函数，并等待属性访问。如果无法使其异步（例如使用客户端组件），它将使用 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 为前缀。在显式删除这些注释之前，你的构建将报错。阅读更多。

将 NextRequest 的 geo 和 ip 属性替换为 @vercel/functions

next-request-geo-ip
终端
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
终端
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
终端
npx @next/codemod@latest metadata-to-viewport-export .

此代码转换 (codemod) 将某些 viewport 元数据迁移到 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
终端
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
终端
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' becomes 'next/legacy/image'
import Image1 from 'next/legacy/image'
// 'next/future/image' becomes '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
终端
npx @next/codemod@latest next-image-experimental .

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

  • 移除 layout prop 并添加 style。
  • 移除 objectFit prop 并添加 style。
  • 移除 objectPosition prop 并添加 style。
  • 移除 lazyBoundary prop。
  • 移除 lazyRoot prop。
终端
npx @next/codemod@latest new-link .

移除 Link 组件 内的 <a> 标签，或者为无法自动修复的 Link 添加 legacyBehavior prop。

例如

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

在无法应用自动修复的情况下，将添加 legacyBehavior prop。这允许你的应用继续使用该特定链接的旧行为。

const Component = () => <a>About</a>
 
<Link href="/about">
  <Component />
</Link>
// becomes
<Link href="/about" legacyBehavior>
  <Component />
</Link>

11

从 CRA 迁移

cra-to-next
终端
npx @next/codemod cra-to-next

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

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

10

添加 React 导入

add-missing-react-import
终端
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>
  }
}

9

将匿名组件转换为命名组件

name-default-component
终端
npx @next/codemod name-default-component

版本 9 及更高版本。

将匿名组件转换为命名组件，以确保它们与快速刷新 一起工作。

例如

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 HOC 转换为页面配置

withamp-to-config
终端
npx @next/codemod withamp-to-config

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

例如

// Before
import { withAmp } from 'next/amp'
 
function Home() {
  return <h1>My AMP Page</h1>
}
 
export default withAmp(Home)
// After
export default function Home() {
  return <h1>My AMP Page</h1>
}
 
export const config = {
  amp: true,
}

6

使用 withRouter

url-to-withrouter
终端
npx @next/codemod url-to-withrouter

将已弃用的自动注入的 url 属性在顶层页面上转换为使用 withRouter 及其注入的 router 属性。在此处阅读更多信息： https://nextjs.net.cn/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__ 目录中找到。