|
| 1 | +# Lychee link checker configuration |
| 2 | +# https://lychee.cli.rs/#/usage/config |
| 3 | +# |
| 4 | +# Run locally with: |
| 5 | +# lychee './**/*.md' './**/*.rst' './maxminddb/**/*.py' './pyproject.toml' |
| 6 | + |
| 7 | +# Include URL fragments in checks |
| 8 | +include_fragments = true |
| 9 | + |
| 10 | +# Don't allow any redirects, so links that have moved are surfaced and can be |
| 11 | +# updated to their canonical destination. |
| 12 | +max_redirects = 0 |
| 13 | + |
| 14 | +# Accept these HTTP status codes |
| 15 | +# 100-103: Informational responses |
| 16 | +# 200-299: Success responses |
| 17 | +# 403: Forbidden (some sites use this for rate limiting) |
| 18 | +# 429: Too Many Requests |
| 19 | +# 500-599: Server errors (temporary issues shouldn't fail CI) |
| 20 | +# 999: LinkedIn's custom status code |
| 21 | +accept = ["100..=103", "200..=299", "403", "429", "500..=599", "999"] |
| 22 | + |
| 23 | +# Exclude URL patterns from checking (treated as regular expressions) |
| 24 | +exclude = [ |
| 25 | + # GitHub blob URLs with line-number fragments (not parseable as page anchors) |
| 26 | + '^https://github\.com/[^/]+/[^/]+/blob/[0-9a-fA-F]+/.+#L\d+$', |
| 27 | + # Live / auth-gated MaxMind endpoints: appear as code string literals or |
| 28 | + # require login, so they can't be verified by an anonymous request. |
| 29 | + '^https://geoip\.maxmind\.com', |
| 30 | + '^https://geolite\.info', |
| 31 | + '^https://minfraud\.maxmind\.com', |
| 32 | + '^https://sandbox\.maxmind\.com', |
| 33 | + '^https://updates\.maxmind\.com', |
| 34 | + '^https://www\.maxmind\.com/en/accounts/', |
| 35 | + '^https://www\.maxmind\.com/en/account/login', |
| 36 | + # Local / placeholder URLs (e.g. the proxy example in docstrings) |
| 37 | + '^file://', |
| 38 | + '^https?://example\.(com|org|net)', |
| 39 | + '^http://localhost', |
| 40 | + '127\.0\.0\.1', |
| 41 | +] |
| 42 | + |
| 43 | +# Exclude file paths from getting checked (regular expressions, matched against |
| 44 | +# the path relative to the working directory). Patterns are segment-anchored |
| 45 | +# with (^|/) so short names like "build" don't match unintended paths. |
| 46 | +exclude_path = [ |
| 47 | + '(^|/)node_modules/', |
| 48 | + '(^|/)\.venv/', |
| 49 | + '(^|/)venv/', |
| 50 | + '(^|/)build/', |
| 51 | + '(^|/)dist/', |
| 52 | + '(^|/)\.eggs/', |
| 53 | + '(^|/)[^/]*\.egg-info/', |
| 54 | + '(^|/)docs/_build/', |
| 55 | + # Vendored git submodules (upstream C library and shared test fixtures) |
| 56 | + '(^|/)extension/libmaxminddb/', |
| 57 | + '(^|/)tests/data/', |
| 58 | + # Changelog: historical entries are preserved as-is, not rewritten |
| 59 | + '(^|/)HISTORY\.rst$', |
| 60 | +] |
| 61 | + |
| 62 | +# Cache results for 1 day to speed up repeated checks |
| 63 | +cache = true |
| 64 | +max_cache_age = "1d" |
| 65 | + |
| 66 | +# Skip missing input files instead of erroring |
| 67 | +skip_missing = true |
0 commit comments