feat(justfile): Add recipe to check for stale links

This patch also modifies the default `check` recipe to invoke the
stale link checker.

Fixes: #58


Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

.env

 # Contains project specific variables
 
 # List of packages required specifically by this project
-PACMAN_PACKAGES="cargo-deny cargo-machete clang cmake cocogitto codespell git jq just make mold openssl pkgconf podman release-plz reuse ripgrep rsop rustup rust-script sequoia-sq shellcheck tangler"
+PACMAN_PACKAGES="cargo-deny cargo-machete clang cmake cocogitto codespell git jq just lychee make mold openssl pkgconf podman release-plz reuse ripgrep rsop rustup rust-script sequoia-sq shellcheck tangler"

.gitignore

 target/
+.lycheecache

.lycheeignore

+# manually curated list of URLs that lychee should not check
+
+# an URL fragment that's used in format! macro
+# see: https://github.com/lycheeverse/lychee/issues/1492
+https://raw.githubusercontent.com/Nitrokey/nethsm-sdk-py/main/tests/%7B%7D

REUSE.toml

@@ -24,6 +24,8 @@ path = [
     ".gitlab/CODEOWNERS",
     ".shellcheckrc",
     "justfile",
+    "lychee.toml",
+    ".lycheeignore",
 ]
 precedence = "aggregate"
 SPDX-FileCopyrightText = "Signstar Contributors"

justfile

@@ -11,7 +11,7 @@ ignored := "false"
 run-pre-commit-hook: check test
 
 # Runs all check targets
-check: check-spelling check-formatting lint check-unused-deps check-dependencies check-licenses
+check: check-spelling check-formatting lint check-unused-deps check-dependencies check-licenses check-links
 
 # Faster checks need to be executed first for better UX.  For example
 # codespell is very fast. cargo fmt does not need to download crates etc.
@@ -229,6 +229,10 @@ add-hooks:
     echo just run-pre-push-hook > .git/hooks/pre-push
     chmod +x .git/hooks/pre-push
 
+# Check for stale links in documentation
+check-links:
+    lychee -- '**/*.md' '**/*.rs'
+
 # Fixes common issues. Files need to be git add'ed
 fix:
     #!/usr/bin/env bash

lychee.toml

+# for a list of excluded URLs see `.lycheeignore`
+
+# suggested setting for non-interactive environments such as CIs
+no_progress = true
+
+# we use localhost links extensively in end-to-end tests
+exclude_loopback = true
+
+# enable cache since the check will be performed frequently
+cache = true
+
+# discard all cached requests older than this duration.
+max_cache_age = "2d"