lychee.toml

# https://lychee.cli.rs/
# Lychee link checker configuration
# Run with: lychee -q '**/*.md' '**/*.ts'

# Accept 429 (Too Many Requests) - GitHub rate-limits crawlers, it doesn't
# mean the link is broken
# 429 = GitHub rate-limits crawlers
# 403 = npm returns 403 to automated clients
# 406 = some servers (e.g. bugzilla.mozilla.org) reject crawlers via content negotiation
accept = [200, 429, 403, 406]

cache = true
max_cache_age = "1d"

format = "compact"

# URL patterns to skip (regex)
exclude = [
  # Protocol-relative URLs like //npmjs.com/package/... in markdown tables
  # //github.com/... badge URLs cannot be resolved by lychee
  "^//",

  "mailto://",

  # Localhost and LAN addresses used in test fixtures and example code
  "^http://localhost",
  "^http://127\\.0\\.0\\.1",
  "^https?://192\\.168\\.",

  # Specific example IPs used in test code
  "^https?://154\\.38\\.162\\.255",

  # pubsub package moved out of this repo
  "github\\.com/libp2p/js-libp2p/tree/main/packages/pubsub",
]

# File paths/globs to exclude from scanning
exclude_path = [
  # CHANGELOG files are auto-generated and contain GitHub comparison URLs
  # (e.g. .../compare/libp2p-v3.1.3...libp2p-v3.1.4) that frequently 404
  # as old tags get cleaned up - not worth maintaining
  "CHANGELOG\\.md",

  # Migration guides document historical API changes and intentionally
  # reference archived/superseded repositories (js-libp2p-interfaces etc.)
  "doc/migrations",

  "node_modules",
]