メインコンテンツまでスキップ

Codemods

Codemodsは、コードベースに対してプログラム的に実行される変換です。これにより、多くの変更を手動でファイルを確認することなくプログラム的に適用できます。

Next.jsは、APIが更新または非推奨になったときに、Next.jsのコードベースをアップグレードするのを助けるためのCodemod変換を提供します。

使用法​

ターミナルで、プロジェクトのフォルダに移動（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​

Note: この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は、現在非同期になった動的API（cookies()、headers()、およびdraftMode() from next/headers）を適切に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のプロパティアクセスを検出した場合、 同期から非同期関数への変換を試み、プロパティアクセスをawaitします。非同期にできない場合（client componentなど）、React.useを使用してプロミスをアンラップします。

例えば：

// 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}`,
  }
}

Good to know: このcodemodが手動での介入が必要な箇所を特定したが、正確な修正を決定できない場合、コードにコメントまたは型キャストを追加して、手動で更新する必要があることをユーザーに通知します。これらのコメントは**@next/codemod**で始まり、型キャストはUnsafeUnwrappedで始まります。 これらのコメントが明示的に削除されるまで、ビルドはエラーになります。詳しく読む。

NextRequestのgeoおよびipプロパティを@vercel/functionsに置き換える​

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は、Dynamic OG Image Generationの使用のために、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 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​
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を削除します
Terminal
npx @next/codemod@latest new-link .

Link Components内の<a>タグを削除するか、自動修正できないリンクに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​
Terminal
npx @next/codemod cra-to-next

Create React AppプロジェクトをNext.jsに移行し、Pages Routerと必要な設定を作成して動作を一致させます。クライアントサイドのみのレンダリングが最初に利用され、SSR中のwindow使用による互換性の破損を防ぎ、Next.js固有の機能の段階的な採用を可能にします。

この変換に関するフィードバックをこのディスカッションで共有してください。

10​

Reactインポートの追加​

add-missing-react-import​
Terminal
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​
Terminal
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 HOCをページ設定に変換する​

withamp-to-config​
Terminal
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​
Terminal
npx @next/codemod url-to-withrouter

トップレベルページで自動的に注入される非推奨のurlプロパティをwithRouterとそれが注入するrouterプロパティを使用するように変換します。詳しくはこちらをお読みください：https://nextjs.org/docs/messages/url-deprecated

例えば：

From
import React from 'react'
export default class extends React.Component {
  render() {
    const { pathname } = this.props.url
    return <div>Current pathname: {pathname}</div>
  }
}
To
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__ディレクトリにあります。