nuxt-link-checker 0.1.0

package/README.md

@@ -0,0 +1,121 @@
+<h1 align='center'>nuxt-link-checker</h1>
+
+<p align="center">
+<a href='https://github.com/harlan-zw/nuxt-link-checker/actions/workflows/test.yml'>
+</a>
+<a href="https://www.npmjs.com/package/nuxt-link-checker" target="__blank"><img src="https://img.shields.io/npm/v/nuxt-link-checker?style=flat&colorA=002438&colorB=28CF8D" alt="NPM version"></a>
+<a href="https://www.npmjs.com/package/nuxt-link-checker" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/nuxt-link-checker?flat&colorA=002438&colorB=28CF8D"></a>
+<a href="https://github.com/harlan-zw/nuxt-link-checker" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/harlan-zw/nuxt-link-checker?flat&colorA=002438&colorB=28CF8D"></a>
+</p>
+
+
+<p align="center">
+Improve your sites SEO by identifying and fixing link issues in your Nuxt v3 app.
+</p>
+
+<p align="center">
+<table>
+<tbody>
+<td align="center">
+<img width="800" height="0" /><br>
+<i>Status:</i> Early Access</b> <br>
+<sup> Please report any issues 🐛</sup><br>
+<sub>Made possible by my <a href="https://github.com/sponsors/harlan-zw">Sponsor Program 💖</a><br> Follow me <a href="https://twitter.com/harlan_zw">@harlan_zw</a> 🐦 • Join <a href="https://discord.gg/275MBUBvgP">Discord</a> for help</sub><br>
+<img width="800" height="0" />
+</td>
+</tbody>
+</table>
+</p>
+
+## Features
+
+- ⛰️ Discover broken links - 404s and internal redirects
+- ❌ Fail on build if broken links are found (optional)
+
+## Install
+
+⚠️ The module is in early access and only works when pre-rendering.
+
+```bash
+npm install --save-dev nuxt-link-checker
+
+# Using yarn
+yarn add --dev nuxt-link-checker
+```
+
+## Setup
+
+_nuxt.config.ts_
+
+```ts
+export default defineNuxtConfig({
+  modules: [
+    'nuxt-link-checker',
+  ],
+})
+```
+
+To have routes scanned for broken links automatically, they need to be pre-rendered by Nitro.
+
+```ts
+export default defineNuxtConfig({
+  nitro: {
+    prerender: {
+      crawlLinks: true,
+      routes: [
+        '/',
+        // any URLs that can't be discovered by crawler
+        '/my-hidden-url'
+      ]
+    }
+  }
+})
+```  
+
+
+### Set host (optional)
+
+You'll need to provide the host of your site so that the crawler can resolve absolute URLs that may be internal.
+
+```ts
+export default defineNuxtConfig({
+  // Recommended 
+  runtimeConfig: {
+    siteUrl: 'https://example.com',
+  },
+  // OR 
+  sitemap: {
+    host: 'https://example.com',
+  },
+})
+```
+
+## Module Config
+
+### `host`
+
+- Type: `string`
+- Default: `runtimeConfig.public.siteUrl`
+- Required: `false`
+
+The host of your site. This is required to validate absolute URLs which may be internal.
+
+### `trailingSlash`
+
+- Type: `boolean`
+- Default: `false`
+
+Whether internal links should have a trailing slash or not.
+
+## Sponsors
+
+<p align="center">
+  <a href="https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg">
+    <img src='https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg'/>
+  </a>
+</p>
+
+
+## License
+
+MIT License © 2022-PRESENT [Harlan Wilton](https://github.com/harlan-zw)

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.ts

@@ -0,0 +1,23 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    /**
+     * Should the URLs be inserted with a trailing slash.
+     *
+     * @default false
+     */
+    trailingSlash: boolean;
+    /**
+     * Your site hostname. Used to determine if absolute links are internal.
+     */
+    host?: string;
+    /**
+     * Whether the build should fail when a 404 is encountered.
+     */
+    failOn404: boolean;
+}
+interface ModuleHooks {
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { ModuleHooks, ModuleOptions, _default as default };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "nuxt-link-checker",
+  "compatibility": {
+    "nuxt": "^3.0.0",
+    "bridge": false
+  },
+  "configKey": "linkChecker",
+  "version": "0.1.0"
+}

package/dist/module.mjs

@@ -0,0 +1,117 @@
+import { defineNuxtModule } from '@nuxt/kit';
+import chalk from 'chalk';
+import { isRelative, parseURL } from 'ufo';
+import { load } from 'cheerio';
+
+const linkMap = {};
+const EXT_REGEX = /\.[\da-z]+$/;
+const allowedExtensions = /* @__PURE__ */ new Set(["", ".json"]);
+function getExtension(path) {
+  return (path.match(EXT_REGEX) || [])[0] || "";
+}
+function extractLinks(html, from, { host, trailingSlash }) {
+  const links = [];
+  const _links = [];
+  const $ = load(html);
+  $("[href]").each((i, el) => {
+    const href = $(el).attr("href");
+    if (!href)
+      return;
+    if (host && !isRelative(href) && href.startsWith(host))
+      return;
+    if (!allowedExtensions.has(getExtension(href)))
+      return;
+    _links.push({
+      href,
+      badTrailingSlash: href !== "/" && (trailingSlash && !href.endsWith("/") || !trailingSlash && href.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;
+}
+
+const invalidStatusCodes = [404, 302, 301, 307, 303];
+const module = defineNuxtModule({
+  meta: {
+    name: "nuxt-link-checker",
+    compatibility: {
+      nuxt: "^3.0.0",
+      bridge: false
+    },
+    configKey: "linkChecker"
+  },
+  defaults(nuxt) {
+    return {
+      host: nuxt.options.runtimeConfig.public?.siteUrl,
+      trailingSlash: nuxt.options.runtimeConfig.public?.trailingSlash || false,
+      failOn404: true
+    };
+  },
+  setup(config, nuxt) {
+    nuxt.hooks.hook("nitro:init", async (nitro) => {
+      const invalidRoutes = {};
+      nitro.hooks.hook("prerender:generate", async (ctx) => {
+        if (ctx.contents && ctx.fileName?.endsWith(".html"))
+          linkMap[ctx.route] = extractLinks(ctx.contents, ctx.route, config);
+        if (ctx.error?.statusCode && invalidStatusCodes.includes(Number(ctx.error?.statusCode)))
+          invalidRoutes[ctx.route] = ctx.error.statusCode;
+      });
+      nitro.hooks.hook("close", async () => {
+        nitro.logger.info("Scanning for broken links...");
+        const links = Object.entries(linkMap);
+        const hasBrokenLinks = Object.keys(invalidRoutes).length;
+        let routeCount = 0;
+        let badLinkCount = 0;
+        links.forEach(([route, routes]) => {
+          const brokenLinks = routes.map((r) => {
+            return {
+              ...r,
+              statusCode: invalidRoutes[r.href] || 200
+            };
+          }).filter((r) => r.statusCode !== 200 || r.badTrailingSlash);
+          if (brokenLinks.length) {
+            nitro.logger.log(chalk.gray(
+              `  ${Number(++routeCount) === links.length - 1 ? "\u2514\u2500" : "\u251C\u2500"} ${route}`
+            ));
+            brokenLinks.forEach((link) => {
+              badLinkCount++;
+              if (link.statusCode !== 200) {
+                nitro.logger.log(chalk.red(
+                  `   ${link.href} ${link.statusCode}`
+                ));
+              } else if (link.badTrailingSlash) {
+                nitro.logger.log(chalk.yellow(
+                  `   ${link.href} Wrong trailing slash`
+                ));
+              }
+              nitro.logger.log(`   ${chalk.gray(link.element)}`);
+            });
+          }
+        });
+        if (hasBrokenLinks) {
+          nitro.logger[config.failOn404 ? "error" : "warn"](`Found ${badLinkCount} broken links.`);
+          if (config.failOn404) {
+            nitro.logger.log(chalk.gray('You can disable this by setting "linkChecker: { failOn404: false }" in your nuxt.config.ts.'));
+            process.exit(1);
+          }
+        }
+      });
+    });
+  }
+});
+
+export { module as default };

package/dist/types.d.ts

@@ -0,0 +1,11 @@
+
+import { ModuleOptions, ModuleHooks } from './module'
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['linkChecker']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['linkChecker']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+
+export { ModuleHooks, ModuleOptions, default } from './module'

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "nuxt-link-checker",
+  "type": "module",
+  "version": "0.1.0",
+  "packageManager": "pnpm@7.18.0",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/harlan-zw",
+  "homepage": "https://github.com/harlan-zw/nuxt-link-checker#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harlan-zw/nuxt-link-checker.git"
+  },
+  "bugs": {
+    "url": "https://github.com/harlan-zw/nuxt-link-checker/issues"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "require": "./dist/module.cjs",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@nuxt/kit": "3.0.0",
+    "chalk": "^5.2.0",
+    "cheerio": "1.0.0-rc.12",
+    "defu": "^6.1.1",
+    "radix3": "^1.0.0",
+    "sitemap": "^7.1.1",
+    "ufo": "^1.0.1"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^0.34.0",
+    "@nuxt/kit": "3.0.0",
+    "@nuxt/module-builder": "^0.2.1",
+    "@nuxt/test-utils": "3.0.0",
+    "@nuxtjs/eslint-config-typescript": "^12.0.0",
+    "bumpp": "^8.2.1",
+    "eslint": "8.30.0",
+    "execa": "^6.1.0",
+    "nuxt": "^3.0.0",
+    "pathe": "^1.0.0",
+    "vitest": "^0.25.8"
+  },
+  "scripts": {
+    "lint": "eslint \"**/*.{ts,vue,json,yml}\" --fix",
+    "build": "nuxi prepare .playground && nuxt-module-build",
+    "dev": "nuxi dev .playground",
+    "dev:build": "nuxi build .playground",
+    "dev:prepare": "nuxt-module-build --stub && nuxi prepare .playground",
+    "release": "bumpp package.json --commit --push --tag",
+    "test": "pnpm lint"
+  }
+}