Link validation (#66)

* Create check-links.js

* Update package.json

* Update README.md

* Update README.md

Author: evanorti

README.md

@@ -11,6 +11,22 @@ npm i
 npm run dev
 ```
 
+## Link Checking
+
+To check for broken links in the documentation:
+
+```
+npm run check-links
+```
+
+This command will:
+1. Kill any existing server on port 3000
+2. Start a new dev server
+3. Check all internal links
+4. Kill the server when done
+
+The link checker is also integrated into the build process (`npm run build`), ensuring no broken links make it to production.
+
 These docs were created using [Fumadocs](https://fumadocs.vercel.app/docs/ui).
 
 ## Updating the theme
@@ -48,13 +64,13 @@ import {Layers, Microscope } from 'lucide-react';
     icon={<Layers />}
     href="/about"
     title="About"
-    description="Learn about Layer"
+    description="Learn about WAVS"
   />
     <Card
     icon={<Microscope />}
     href="/how-it-works"
     title="How it works"
-    description="Discover how Layer works"
+    description="Discover how WAVS works"
   />
 </Cards>
 

package.json

@@ -3,9 +3,10 @@
   "version": "0.0.0",
   "private": true,
   "scripts": {
-    "build": "next build",
+    "build": "rm -rf dsource-wavs-foundry-template || true; next build",
     "postbuild": "next-sitemap",
     "dev": "next dev",
+    "check-links": "lsof -ti:3000 | xargs kill -9 || true; next dev -p 3000 & sleep 5 && node scripts/check-links.js && kill $!",
     "start": "next start"
   },
   "dependencies": {
@@ -33,6 +34,8 @@
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "autoprefixer": "^10.4.19",
+    "broken-link-checker": "^0.7.8",
+    "chalk": "^4.1.2",
     "postcss": "^8.4.38",
     "tailwindcss": "^3.4.4",
     "typescript": "^5.4.5"

scripts/check-links.js

@@ -0,0 +1,42 @@
+const { SiteChecker } = require('broken-link-checker');
+const chalk = require('chalk');
+
+let hasBrokenLinks = false;
+
+const siteChecker = new SiteChecker(
+  {
+    excludeExternalLinks: true,
+    excludeInternalLinks: false,
+    excludeLinksToSamePage: true,
+    filterLevel: 0,
+    acceptedSchemes: ['http', 'https'],
+    maxSockets: 1,
+    maxSocketsPerHost: 1,
+    rateLimit: 100,
+    userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36',
+  },
+  {
+    link: (result) => {
+      if (result.broken) {
+        hasBrokenLinks = true;
+        console.error(
+          chalk.red(`❌ BROKEN LINK: ${result.url.original}`),
+          chalk.yellow(`\n   Found in: ${result.base.original}`),
+          chalk.gray(`\n   Status: ${result.http.response ? result.http.response.statusCode : 'No response'}`)
+        );
+      }
+    },
+    end: () => {
+      if (hasBrokenLinks) {
+        console.error(chalk.red('\n❌ Broken links found! Please fix them before continuing.'));
+        process.exit(1);
+      } else {
+        console.log(chalk.green('\n✅ No broken links found!'));
+      }
+    }
+  }
+);
+
+const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || 'http://localhost:3000';
+console.log(chalk.blue(`\n🔍 Checking links on ${baseUrl}...\n`));
+siteChecker.enqueue(baseUrl);