archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore(docs): codemod docs should mention . for cwd (#51264)

Browse source 
These docs were wrong because `./pages` is not sufficient to run a
codemod.

Imagine a project that has `./components` and `./pages` and many
directories for example.

Also its important to run at the root of the Next.js project so that the
path has a `next.config.js` because some codemods modify that config.
This commit is contained in:
Steven 2023-06-13 17:44:53 -04:00 committed by GitHub
parent d27a4969f6
commit 0f03ef14f0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/02-app/01-building-your-application/08-upgrading/01-codemods.mdx
View file

@ -31,7 +31,7 @@ Replacing `<transform>` and `<path>` with appropriate values.
##### `built-in-next-font`
```bash filename="Terminal"
npx @next/codemod@latest built-in-next-font
npx @next/codemod@latest built-in-next-font .
```
This codemod uninstalls the `@next/font` package and transforms `@next/font` imports into the built-in `next/font`.
@ -55,7 +55,7 @@ import { Inter } from 'next/font/google'
##### `next-image-to-legacy-image`
```bash filename="Terminal"
npx @next/codemod@latest next-image-to-legacy-image ./pages
npx @next/codemod@latest next-image-to-legacy-image .
```
Safely renames `next/image` imports in existing Next.js 10, 11, or 12 applications to `next/legacy/image` in Next.js 13. Also renames `next/future/image` to `next/image`.
@ -99,7 +99,7 @@ export default function Home() {
##### `next-image-experimental`
```bash filename="Terminal"
npx @next/codemod@latest next-image-experimental ./pages
npx @next/codemod@latest next-image-experimental .
```
Dangerously migrates from `next/legacy/image` to the new `next/image` by adding inline styles and removing unused props.
@ -115,7 +115,7 @@ Dangerously migrates from `next/legacy/image` to the new `next/image` by adding
##### `new-link`
```bash filename="Terminal"
npx @next/codemod@latest new-link ./pages
npx @next/codemod@latest new-link .
```
Remove `<a>` tags inside [Link Components](/docs/app/api-reference/components/link), or add a `legacyBehavior` prop to Links that cannot be auto-fixed.