Codemods

Codemods 是一种可以对你的代码库进行程序化转换的工具。它允许在不需要手动修改每个文件的情况下，以编程方式批量应用大量更改。

Next.js 提供了 Codemod 转换工具，可以帮助你在 API 更新或废弃时升级 Next.js 代码库。

使用方法

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

Terminal

npx @next/codemod <transform> <path>

将 <transform> 和 <path> 替换为相应的值。

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

Codemods

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'

迁移到异步动态 API

之前支持同步访问的动态渲染 API 现在变为异步。你可以在升级指南中了解更多关于这个重大变更的信息。

`next-async-request-api`

Terminal

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

此 codemod 将现在变为异步的动态 API (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 } from 'next/headers'
 
const token = (await cookies()).get('token')
 
function useToken() {
  const token = use(cookies()).get('token')
  return token
}
 
export default function Page() {
  const name = (await cookies()).get('name')
}
 
function getHeader() {
  return (headers() as UnsafeUnwrappedCookies).get('x-foo')
}

当我们在页面/路由入口文件 (page.js、layout.js、route.js 或 default.js) 或 generateMetadata/generateViewport API 中检测到对 params 或 searchParams 属性的访问时，它会尝试将调用点从同步函数转换为异步函数，并 await 属性访问。如果无法转为异步 (比如在客户端组件中)，它将使用 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 } }) {
  return {
    title: `My Page - ${slug}`,
  }
}

转换为：

// page.tsx
export default function Page(props: {
  params: { slug: string }
  searchParams: { [key: string]: string | string[] | undefined }
}) {
  const { value } = await props.searchParams
  if (value === 'foo') {
    // ...
  }
}
 
export function generateMetadata(props: { params: { slug: string } }) {
  const { slug } = await props.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 将用于动态 OG 图片生成的导入从 next/server 转移到 next/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 导出。

例如：

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 13 中，安全地将现有 Next.js 10、11 或 12 应用程序中的 next/image 导入重命名为 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 .

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

移除 layout 属性并添加 style
移除 objectFit 属性并添加 style
移除 objectPosition 属性并添加 style
移除 lazyBoundary 属性
移除 lazyRoot 属性

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

`new-link`

Terminal

npx @next/codemod@latest new-link .

从 Link 组件中移除 <a> 标签，或为无法自动修复的 Link 添加 legacyBehavior 属性。

例如：

<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>

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

const Component = () => <a>About</a>
 
<Link href="/about">
  <Component />
</Link>
// 变为
<Link href="/about" legacyBehavior>
  <Component />
</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 transform 能够工作。

例如：

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>
}

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

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__ 目录中找到。

Codemods

使用方法

Codemods

15.0

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

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

迁移到异步动态 API

`next-async-request-api`

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

`next-request-geo-ip`

14.0

迁移 `ImageResponse` 导入

`next-og-import`

使用 `viewport` 导出

`metadata-to-viewport-export`

13.2

使用内置字体

`built-in-next-font`

13.0

重命名 Next Image 导入

`next-image-to-legacy-image`

迁移到新的 Image 组件

`next-image-experimental`

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

`new-link`

11

从 CRA 迁移

`cra-to-next`

10

添加 React 导入

`add-missing-react-import`

9

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

`name-default-component`

8

将 AMP HOC 转换为页面配置

`withamp-to-config`

6

使用 `withRouter`

`url-to-withrouter`