Nuxt Link Checker v5.0.0 · Nuxt Link Checker · Nuxt SEO

[NuxtSEO](https://nuxtseo.com/ "Home")

- [Modules](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Tools](https://nuxtseo.com/tools)
- [Pro](https://nuxtseo.com/pro)
- [Learn SEO](https://nuxtseo.com/learn-seo/nuxt) [Releases](https://nuxtseo.com/releases)

[1.4K](https://github.com/harlan-zw/nuxt-seo)

[Nuxt SEO on GitHub](https://github.com/harlan-zw/nuxt-seo)

[User Guides](https://nuxtseo.com/docs/link-checker/getting-started/introduction)

[API](https://nuxtseo.com/docs/link-checker/api/config)

[Releases](https://nuxtseo.com/docs/link-checker/releases/v5)

Link Checker

- [Switch to Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [Switch to Nuxt SEO](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Switch to Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Switch to Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [Switch to OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Switch to Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Switch to SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Switch to Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Switch to Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [Switch to AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

Search…```k`` /`

v5.0.9

- Playgrounds
- [Discord Support](https://discord.com/invite/275MBUBvgP)

### Changelog

### Releases

- [v5.0.0](https://nuxtseo.com/docs/link-checker/releases/v5)
- [v4.0.0](https://nuxtseo.com/docs/link-checker/releases/v4)
- [v3.0.0](https://nuxtseo.com/docs/link-checker/releases/v3)
- [v2.0.0](https://nuxtseo.com/docs/link-checker/releases/v2)

Releases

# Nuxt Link Checker v5.0.0

[Copy for LLMs](https://nuxtseo.com/docs/link-checker/releases/v5.md)

## [Introduction](#introduction)

The v5 release adds [ESLint](https://eslint.org) integration for instant broken link feedback in your editor, migrates DevTools to a shared layer, and bumps internal dependencies.

## [⚠️ Breaking Changes](#️-breaking-changes)

### [Site Config v4](#site-config-v4)

Nuxt Site Config is a module used internally by Nuxt Link Checker.

The major update to v4.0.0 shouldn't have any direct effect on your site, however, you may want to double-check the [breaking changes](https://github.com/harlan-zw/nuxt-site-config/releases/tag/v4.0.0).

### [DevTools Migration](#devtools-migration)

The DevTools client has been migrated to `nuxtseo-layer-devtools`, a shared layer used across all Nuxt SEO modules. This means the DevTools panel is now consistent across modules and maintained in one place. No action is needed unless you were importing DevTools internals directly.

## [🔗 ESLint Integration](#eslint-integration)

Broken links are typically only caught at build time or during development server navigation. The new ESLint integration gives you instant feedback directly in your editor by validating relative URLs against your app's known routes and sitemap data.

### [`link-checker/valid-route`](#link-checkervalid-route)

Checks that relative URLs match a known vue-router route pattern. Uses radix3 for dynamic route matching and fuse.js for "did you mean?" typo suggestions.

**Severity:** `error`

```
<!-- ✅ /about exists as a page -->
<NuxtLink to="/about" />

<!-- ✅ matches /blog/:slug dynamic route -->
<NuxtLink to="/blog/my-post" />

<!-- ❌ no route matches /abot -->
<NuxtLink to="/abot" />
```

### [`link-checker/valid-sitemap-link`](#link-checkervalid-sitemap-link)

Checks that relative URLs exist in the sitemap. For dynamic routes, warns when sibling URLs exist in the sitemap but the linked URL does not.

**Severity:** `warn`

```
<!-- ✅ /blog/hello-world is in the sitemap -->
<NuxtLink to="/blog/hello-world" />

<!-- ⚠️ /blog/typo matches /blog/:slug but isn't in sitemap -->
<NuxtLink to="/blog/typo" />
```

### [What Gets Checked](#what-gets-checked)

Both rules scan for relative URLs in:

- **Vue templates:** `<NuxtLink to="...">`, `<RouterLink to="...">`, `<a href="...">`
- **TypeScript/JavaScript:** `navigateTo('...')`, `router.push('...')`, `router.replace('...')`
- **Markdown:** `[text](/url)` link syntax (via processor)

External URLs, anchors, mailto/tel links, and dynamic bindings are automatically skipped.

### [Zero Config with `@nuxt/eslint`](#zero-config-with-nuxteslint)

If you're using `@nuxt/eslint`, both rules are automatically registered via the `eslint:config:addons` hook. Zero-config.

For manual setup, import the standalone export:

```
import linkCheckerPlugin from 'nuxt-link-checker/eslint'

export default [
  {
    files: ['**/*.vue', '**/*.ts'],
    plugins: {
      'link-checker': linkCheckerPlugin,
    },
    rules: {
      'link-checker/valid-route': 'error',
      'link-checker/valid-sitemap-link': 'warn',
    },
  },
]
```

See the [ESLint Integration guide](https://nuxtseo.com/guides/eslint) for full details including markdown support, skipping links, and configuration options.

[Edit this page](https://github.com/harlan-zw/nuxt-link-checker/edit/main/docs/content/4.releases/3.v5.md)

[Markdown For LLMs](https://nuxtseo.com/docs/link-checker/releases/v5.md)

Did this page help you?

[Config Configure the link checker module.](https://nuxtseo.com/docs/link-checker/api/config) [v4.0.0 Release notes for v4.0.0. of Nuxt Link Checker.](https://nuxtseo.com/docs/link-checker/releases/v4)

On this page

- [Introduction](#introduction)
- [⚠️ Breaking Changes](#️-breaking-changes)
- [🔗 ESLint Integration](#eslint-integration)

[GitHub](https://github.com/harlan-zw/nuxt-seo) [ Discord](https://discord.com/invite/275MBUBvgP)

### [NuxtSEO](https://nuxtseo.com/ "Home")

- [Getting Started](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [MCP](https://nuxtseo.com/docs/nuxt-seo/guides/mcp)

Modules

- [Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

### [NuxtSEO Pro](https://nuxtseo.com/pro "Nuxt SEO Pro")

- [Getting Started](https://nuxtseo.com/pro)
- [Dashboard](https://nuxtseo.com/pro/dashboard)
- [Pro MCP](https://nuxtseo.com/pro/docs/getting-started/mcp-setup)

### [Learn SEO](https://nuxtseo.com/learn-seo "Learn SEO")

Nuxt

- [Mastering Meta](https://nuxtseo.com/learn-seo/nuxt/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/nuxt/controlling-crawlers)
- [Launch & Listen](https://nuxtseo.com/learn-seo/nuxt/launch-and-listen)
- [Routes & Rendering](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering)
- [Staying Secure](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering/security)

Vue

- [Vue SEO Guide](https://nuxtseo.com/learn-seo/vue)
- [Mastering Meta](https://nuxtseo.com/learn-seo/vue/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/vue/controlling-crawlers)
- [SPA SEO](https://nuxtseo.com/learn-seo/vue/spa)
- [SSR Frameworks](https://nuxtseo.com/learn-seo/vue/ssr-frameworks)
- [SEO Checklist](https://nuxtseo.com/learn-seo/checklist)
- [Pre-Launch Warmup](https://nuxtseo.com/learn-seo/pre-launch-warmup)
- [Backlinks & Authority](https://nuxtseo.com/learn-seo/backlinks)

### [Tools](https://nuxtseo.com/tools "SEO Tools")

- [Social Share Debugger](https://nuxtseo.com/tools/social-share-debugger)
- [Robots.txt Generator](https://nuxtseo.com/tools/robots-txt-generator)
- [Meta Tag Checker](https://nuxtseo.com/tools/meta-tag-checker)
- [HTML to Markdown](https://nuxtseo.com/tools/html-to-markdown)
- [XML Sitemap Validator](https://nuxtseo.com/tools/xml-sitemap-validator)
- [Schema.org Validator](https://nuxtseo.com/tools/schema-validator)
- [Keyword Idea Generator](https://nuxtseo.com/tools/keyword-generator)
- [Keyword Research](https://nuxtseo.com/tools/keyword-research)
- [SERP Analyzer](https://nuxtseo.com/tools/serp-analyzer)
- [Domain Rankings](https://nuxtseo.com/tools/domain-rankings)

Copyright © 2023-2026 Harlan Wilton - [MIT License](https://github.com/harlan-zw/nuxt-seo/blob/main/license) · [mdream](https://mdream.dev)