Skip to content

plugin-nextjs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

plugin-nextjs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
lib
lib
 
 
test
test
 
 
.madrun.js
.madrun.js
 
 
.npmignore
.npmignore
 
 
.nycrc.json
.nycrc.json
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
eslint.config.js
eslint.config.js
 
 
package.json
package.json
 
 

README.md

@putout/plugin-nextjs NPM version

🐊Putout plugin adds ability to migrate to latest version of Next.js. Not Bundled.

Install

npm i putout @putout/plugin-nextjs -D

Add .putout.json with:

{
    "plugins": ["nextjs"]
}

Rules

Here is list of rules:

{
    "rules": {
        "nextjs/create-app-directory": "on",
        "nextjs/remove-a-from-link": "on",
        "nextjs/convert-page-to-head": "on",
        "nextjs/move-404-to-not-found": "on",
        "nextjs/update-tsconfig": "off",
        "nextjs/update-tsconfig-file": "on"
    }
}

remove-a-from-link

Next.js 12: <a> has to be nested otherwise it's excluded, Next.js 13: <Link> always renders <a> under the hood.

Check out in 🐊Putout Editor.

❌ Example of incorrect code

import Link from 'next/link';

export default function Nav() {
    <Link href="/about">
        <a>
            About
        </a>
    </Link>;
}

✅ Example of correct code

import Link from 'next/link';

export default function Nav() {
    <Link href="/about">
        About
    </Link>;
}

convert-page-to-head

In the pages directory, the next/head React component is used to manage <head> HTML elements such as title and meta . In the app directory, next/head is replaced with a new head.js special file.

Check out in 🐊Putout Editor.

❌ Example of incorrect code

import Head from 'next/head';

export default function Page() {
    return (
        <>
            <Head>
                <title>
                    My page title
                </title>
            </Head>
        </>
    );
}

✅ Example of correct code

export default function Head() {
    return (
        <>
            <title>
                My page title
            </title>
        </>
    );
}

create-app-directory

For new applications, we recommend using the App Router. This router allows you to use React's latest features and is an evolution of the Pages Router based on community feedback.

(c) nextjs.org

Check out in 🐊Putout Editor.

+app/

move-404-to-not-found

pages/404.js has been replaced with the not-found.js file.

(c) nextjs.org

Check out in 🐊Putout Editor.

-app/pages/404.js
+app/not-found.js

update-tsconfig

If you're using TypeScript, you need to update your tsconfig.json file with the following changes to make it compatible with Next.js.

(c) nextjs.org

Add ./dist/types/**/*.ts and ./next-env.d.ts to the include array.

Check out in 🐊Putout Editor.

tsconfig.json:

{
-    "includes": []
+    "includes": ["./dist/types/**/*.ts", "./next-env.d.ts"]
}

The rule disabled by default. To enable use update-tsconfig-file or update .putout.json with:

{
    "match": {
        "tsconfig.json": {
            "nexts/update-ts-config": "on"
        }
    },
    "plugins": ["nextjs"]
}

update-tsconfig-file

Enables update-tsconfig for tsconfig.json without using match.

Run redlint to generate .filesystem.json and then lint. Check out in 🐊Putout Editor.

License

MIT