Summary

Implements clean URL resolution that automatically maps extensionless paths like /about to /about.html, mimicking modern static hosting platforms like Vercel's cleanUrls feature.

Fixes #548

Changes

• src/server.ts: Added fallback logic to try .html extension when file not found
• src/options.ts, src/config.ts: Added cleanUrls type definitions
• src/cli.ts: Added --clean-urls CLI flag and help documentation
• src/index.ts: Wired cleanUrls option to web server
• README.md: Added comprehensive documentation with examples
• test/: Added 11 new tests (9 unit tests + 2 integration tests)

Features

✅ New --clean-urls CLI flag and cleanUrls config option
✅ Automatically resolves /path to /path.html when file exists
✅ Opt-in behavior (disabled by default for backward compatibility)
✅ Maintains security with path traversal protection
✅ Full test coverage with 11 new tests

Usage Examples

CLI:

linkinator ./dist --recurse --clean-urls

Config file:

{
  "cleanUrls": true,
  "recurse": true
}

API:

await checker.check({
  path: './dist',
  recurse: true,
  cleanUrls: true
});

Test plan

• ✅ All 179 tests passing (10 test files)
• ✅ Clean URLs resolve correctly when enabled (/about → about.html)
• ✅ Returns 404 when clean URLs disabled (backward compatible)
• ✅ Security checks pass (path traversal protection maintained)
• ✅ Works with nested paths and recursive scanning
• ✅ Linting passes with no issues

🤖 Generated with Claude Code