Add docs for ESLint plugin settings and rule options (#28059 )

This PR adds documentation for the new `rootDir` setting (#27918), and for `next/no-html-link-for-pages`.

## Documentation / Examples

- [x] Make sure the linting passes

2021-08-19 09:07:30 +00:00

1.4 KiB

Raw Blame History

No HTML link for pages

Why This Error Occurred

An HTML anchor element, <a>, was used to navigate to a page route without using the Link component.

The Link component is required in order to enable client-side route transitions between pages and provide a single-page app experience.

Possible Ways to Fix It

Make sure to import the Link component and wrap anchor elements that route to different page routes.

Before:

function Home() {
  return (
    <div>
      <a href="/about">About Us</a>
    </div>
  )
}

After:

import Link from 'next/link'

function Home() {
  return (
    <div>
      <Link href="/about">
        <a>About Us</a>
      </Link>
    </div>
  )
}

export default Home

Options

`pagesDir`

This rule can normally locate your pages directory automatically.

If you're working in a monorepo, we recommend configuring the rootDir setting in eslint-plugin-next, which pagesDir will use to locate your pages directory.

In some cases, you may also need to configure this rule directly by providing a pages directory. This can be a path or an array of paths.

{
  "rules": {
    "@next/next/no-html-link-for-pages": ["error", "/my-app/pages/"]
  }
}

Useful Links

next/link API Reference

1.4 KiB Raw Blame History