nuxt-link-checker 0.1.5 → 0.2.0

package/README.md

@@ -10,7 +10,7 @@
 
 
 <p align="center">
-Improve your sites SEO by identifying and fixing link issues in your Nuxt v3 app.
+Improve your sites SEO by identifying and fixing link issues in your Nuxt 3 app.
 </p>
 
 <p align="center">
@@ -27,6 +27,8 @@ Improve your sites SEO by identifying and fixing link issues in your Nuxt v3 app
 </table>
 </p>
 
+ℹ️ Looking for a complete SEO solution? Check out [nuxt-seo-kit](https://github.com/harlan-zw/nuxt-seo-kit).
+
 ## Features
 
 - ✅ Discover broken links - 404s and internal redirects
@@ -102,7 +104,7 @@ If set to `true`, the build will fail if any broken links are found.
 ### `host`
 
 - Type: `string`
-- Default: `runtimeConfig.public.siteUrl`
+- Default: `runtimeConfig.public.siteUrl || localhost`
 - Required: `false`
 
 The host of your site. This is required to validate absolute URLs which may be internal.

package/dist/module.d.ts

@@ -10,7 +10,7 @@ interface ModuleOptions {
     /**
      * Your site hostname. Used to determine if absolute links are internal.
      */
-    host?: string;
+    host: string;
     /**
      * Whether the build should fail when a 404 is encountered.
      */

package/dist/module.json

@@ -5,5 +5,5 @@
     "bridge": false
   },
   "configKey": "linkChecker",
-  "version": "0.1.5"
+  "version": "0.2.0"
 }

package/dist/module.mjs

@@ -1,6 +1,6 @@
 import { defineNuxtModule } from '@nuxt/kit';
 import chalk from 'chalk';
-import { isRelative, parseURL } from 'ufo';
+import { parseURL, hasProtocol } from 'ufo';
 import { load } from 'cheerio';
 
 const linkMap = {};
@@ -11,36 +11,25 @@ function getExtension(path) {
 }
 function extractLinks(html, from, { host, trailingSlash }) {
   const links = [];
-  const _links = [];
+  const hostname = parseURL(host).host;
   const $ = load(html);
   $("[href]").each((i, el) => {
     const href = $(el).attr("href");
     if (!href)
       return;
-    if (host && !isRelative(href) && href.startsWith(host))
+    const url = parseURL(href);
+    if (hasProtocol(href) && !href.startsWith("/") && url.host !== hostname)
       return;
     if (!allowedExtensions.has(getExtension(href)))
       return;
-    _links.push({
-      href,
-      badTrailingSlash: href !== "/" && (trailingSlash && !href.endsWith("/") || !trailingSlash && href.endsWith("/")),
+    links.push({
+      pathname: url.pathname || "/",
+      url,
+      badAbsolute: Boolean(hostname) && hostname === url.host,
+      badTrailingSlash: url.pathname !== "/" && (trailingSlash && !url.pathname.endsWith("/") || !trailingSlash && url.pathname.endsWith("/")),
       element: $.html(el) || ""
     });
   });
-  for (const link of _links.filter(Boolean)) {
-    const parsed = parseURL(link.href);
-    if (parsed.protocol)
-      continue;
-    let { pathname } = parsed;
-    if (!pathname.startsWith("/")) {
-      const fromURL = new URL(from, "http://localhost");
-      pathname = new URL(pathname, fromURL).pathname;
-    }
-    links.push({
-      ...link,
-      href: pathname
-    });
-  }
   return links;
 }
 
@@ -56,12 +45,14 @@ const module = defineNuxtModule({
   },
   defaults(nuxt) {
     return {
-      host: nuxt.options.runtimeConfig.public?.siteUrl,
+      host: nuxt.options.runtimeConfig.public?.siteUrl || "localhost",
       trailingSlash: nuxt.options.runtimeConfig.public?.trailingSlash || false,
       failOn404: true
     };
   },
   setup(config, nuxt) {
+    if (nuxt.options.dev)
+      return;
     nuxt.hooks.hook("nitro:init", async (nitro) => {
       const invalidRoutes = {};
       nitro.hooks.hook("prerender:generate", async (ctx) => {
@@ -71,15 +62,17 @@ const module = defineNuxtModule({
           invalidRoutes[ctx.route] = ctx.error.statusCode;
       });
       nitro.hooks.hook("close", async () => {
-        nitro.logger.info("Scanning routes for broken links...");
         const links = Object.entries(linkMap);
+        if (!links.length)
+          return;
+        nitro.logger.info(`Scanning routes for broken links... ${chalk.gray(`trailingSlashes: ${config.trailingSlash ? "`true`" : "`false`"}`)}`);
         let routeCount = 0;
         let badLinkCount = 0;
         links.forEach(([route, routes]) => {
           const brokenLinks = routes.map((r) => {
             return {
               ...r,
-              statusCode: invalidRoutes[r.href] || 200
+              statusCode: invalidRoutes[r.pathname] || 200
             };
           }).filter((r) => r.statusCode !== 200 || r.badTrailingSlash);
           if (brokenLinks.length) {
@@ -93,9 +86,13 @@ const module = defineNuxtModule({
                 nitro.logger.log(chalk.red(
                   `   ${link.statusCode} ${link.statusCode === 404 ? "Not Found" : "Redirect"}`
                 ));
+              } else if (link.badAbsolute) {
+                nitro.logger.log(chalk.yellow(
+                  "   Absolute link, should be relative"
+                ));
               } else if (link.badTrailingSlash) {
                 nitro.logger.log(chalk.yellow(
-                  `   ${config.trailingSlash ? "Missing" : "Has added"} trailing slash`
+                  "   Incorrect trailing slash"
                 ));
               }
               nitro.logger.log(`   ${chalk.gray(link.element)}`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-link-checker",
   "type": "module",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "packageManager": "pnpm@7.18.0",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
@@ -38,11 +38,11 @@
     "@nuxt/test-utils": "3.0.0",
     "@nuxtjs/eslint-config-typescript": "^12.0.0",
     "bumpp": "^8.2.1",
-    "eslint": "8.30.0",
+    "eslint": "8.31.0",
     "execa": "^6.1.0",
     "nuxt": "^3.0.0",
     "pathe": "^1.0.0",
-    "vitest": "^0.25.8"
+    "vitest": "^0.26.3"
   },
   "scripts": {
     "lint": "eslint \"**/*.{ts,vue,json,yml}\" --fix",