Add lychee local link checker - #4
Merged
josecelano merged 5 commits intoSep 8, 2026
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The new lychee runner and verification docs have a couple of reproducible, user-visible rough edges (noisy .github glob warnings and a non-reproducible verification invocation) that should be addressed before approval.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds a new lychee subcommand to the torrust-linting CLI to perform deterministic, offline validation of local Markdown links/fragments, and wires it into the standard linter all workflow while updating docs to reflect the new capability.
Changes:
- Introduces a new Lychee linter runner (
run_lychee_linter) with auto-install via Cargo and offline execution over Markdown files. - Adds
linter lycheesubcommand and includes it inrun_all_linters(). - Updates README and internal issue/feature documentation (including link repairs and verification notes).
File summaries
| File | Description |
|---|---|
| src/linters/mod.rs | Registers and re-exports the new lychee linter module. |
| src/linters/lychee.rs | Implements Lychee install + offline link/fragment checking runner. |
| src/cli.rs | Adds Lychee subcommand and runs it as part of all. |
| README.md | Documents the new linter, command usage, tool install, and lychee.toml discovery. |
| project-words.txt | Adds mktemp to spell-check allowlist for new docs content. |
| docs/issues/3-add-lychee-local-markdown-link-checker/verification.md | Adds manual verification evidence for offline failure behavior. |
| docs/issues/3-add-lychee-local-markdown-link-checker/questions.md | Records design decisions for the Lychee linter integration. |
| docs/issues/3-add-lychee-local-markdown-link-checker/ISSUE.md | Adds the issue spec/plan/acceptance criteria for the Lychee feature. |
| docs/features/linter-parallel-execution/specification.md | Updates related-doc links and reorganizes resource references. |
| docs/features/linter-parallel-execution/questions.md | Updates related-doc links and reorganizes resource references. |
| docs/features/linter-auto-fix/specification.md | Updates related-doc links and reorganizes resource references. |
| docs/features/linter-auto-fix/README.md | Cleans up headings and updates related-doc/resource links. |
Review details
- Files reviewed: 12/12 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
Author
|
ACK 5da34af |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add deterministic local Markdown link and fragment validation to the shared
linterCLI.linter lycheeand includes it inlinter all.--offline, discoverslychee.toml, and checks**/*.mdplus.github/**/*.mdwhile excluding generatedtarget/content.cargo install lychee.Validation
cargo runCloses #3