feat: Add repository-aware link checking #497
Open
Conversation
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
This change introduces a new feature that allows `markdown-link-check` to validate relative links against a manifest of project files, rather than treating them as broken web links. This is particularly useful in CI environments for checking links to new files in a pull request that do not exist publicly yet. Key changes: - Adds a `--file-manifest <path>` command-line option to provide a newline-separated list of all files in the project. - The core logic in `index.js` now checks if a relative link points to a file in the manifest. If it does, the link is considered 'alive' and the external HTTP check is bypassed. - Adds a `sourceFile` option to track the origin of the markdown file for accurate relative path resolution. - Includes new tests to validate the functionality. - Adds a sample GitHub Actions workflow (`.github/workflows/pr-link-check.yml`) to demonstrate usage in a PR checking context.
joefernandez
requested review from
BaseMax,
WillGibson,
smainil and
tcort
as code owners
|
Hey @joefernandez can you explain more about your changes? Why we should merge and apply it and why it's important to have it in next version? Cheers. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This change introduces a new feature that allows
markdown-link-checkto validate relative links against a manifest of project files, rather than treating them as broken web links. This is particularly useful in CI environments for checking links to new files in a pull request that do not exist publicly yet.Key changes:
--file-manifest <path>command-line option to provide a newline-separated list of all files in the project.index.jsnow checks if a relative link points to a file in the manifest. If it does, the link is considered 'alive' and the external HTTP check is bypassed.sourceFileoption to track the origin of the markdown file for accurate relative path resolution..github/workflows/pr-link-check.yml) to demonstrate usage in a PR checking context.