Merged
Conversation
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## main #349 +/- ##
==========================================
- Coverage 72.17% 72.12% -0.05%
==========================================
Files 117 117
Lines 9936 9984 +48
Branches 597 597
==========================================
+ Hits 7171 7201 +30
- Misses 2762 2780 +18
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for transforming Unix manual page references (e.g., chmod(1)) into links to the Man7 documentation.
- Imported and wired up a new
transformUnixManualToLinktransformer in both the parser and query layers - Added a
DOC_MAN_BASE_URLconstant and corresponding regex/query for Unix manuals - Updated the metadata generator to visit and transform manual-page references
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/utils/queries/index.mjs | Added unixManualPage regex, updateUnixManualReference, and isTextWithUnixManual |
| src/utils/parser/constants.mjs | Defined DOC_MAN_BASE_URL for Man7 manual links |
| src/utils/parser/index.mjs | Exported transformUnixManualToLink transformer |
| src/generators/metadata/utils/parse.mjs | Added AST visitor for Unix manual references |
Comments suppressed due to low confidence (1)
src/generators/metadata/utils/parse.mjs:132
- [nitpick] No test coverage appears to be added for the new Unix manual transformer. Consider writing unit tests to validate
transformUnixManualToLinkoutput and thevisitbehavior.
visit(
ovflowd
approved these changes
Jul 10, 2025
Member
ovflowd
left a comment
There was a problem hiding this comment.
LGTM!! tysm for fixing this <3
6 tasks
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.
Fixes #346 by adding a transformer for Unix Manual syntax. That way, when
chmod(1)(or similar) is put the documentation, it'll link to the https://man7.org/linux/man-pages/ reference.