Repository navigation
docs: link one tracked agent orchestration reference and test relative links #176
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| import assert from "node:assert/strict"; | ||
| import fs from "node:fs"; | ||
| import path from "node:path"; | ||
| import { execFileSync } from "node:child_process"; | ||
| import test from "node:test"; | ||
| import { fileURLToPath } from "node:url"; | ||
|
|
||
| const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), ".."); | ||
|
|
||
| function trackedFiles() { | ||
| return execFileSync("git", ["ls-files", "-z"], { cwd: root, encoding: "utf8", shell: false }) | ||
| .split("\0") | ||
| .filter(Boolean); | ||
| } | ||
|
|
||
| function localLinks(markdown) { | ||
| const links = []; | ||
| let inFence = false; | ||
| for (const [index, line] of markdown.split(/\r?\n/u).entries()) { | ||
| if (line.startsWith("```")) inFence = !inFence; | ||
| if (inFence) continue; | ||
| for (const match of line.matchAll(/\[[^\]]+\]\((?<target>[^)]+)\)/gu)) { | ||
| const target = match.groups.target.trim(); | ||
| if (/^(?:https?:|mailto:|#)/iu.test(target)) continue; | ||
| links.push({ line: index + 1, target }); | ||
| } | ||
| } | ||
| return links; | ||
| } | ||
|
|
||
| function targetExists(target, file, tracked) { | ||
| const clean = target.split("#", 1)[0].split("?", 1)[0]; | ||
| if (!clean) return true; | ||
| const resolved = path.posix.normalize(path.posix.join(path.posix.dirname(file), clean)); | ||
| return tracked.has(resolved) || [...tracked].some((entry) => entry.startsWith(`${resolved}/`)); | ||
| } | ||
|
|
||
| test("every relative Markdown link in tracked files resolves", (t) => { | ||
| let tracked; | ||
| try { | ||
| tracked = new Set(trackedFiles()); | ||
| } catch (error) { | ||
| t.skip(`git unavailable or not a work tree: ${error.message}`); | ||
| return; | ||
| } | ||
|
|
||
| const broken = []; | ||
| for (const file of [...tracked].filter((entry) => entry.endsWith(".md"))) { | ||
| const markdown = fs.readFileSync(path.join(root, file), "utf8"); | ||
| for (const { line, target } of localLinks(markdown)) { | ||
| if (!targetExists(target, file, tracked)) broken.push(`${file}:${line} -> ${target}`); | ||
| } | ||
| } | ||
| assert.deepEqual(broken, [], `broken relative Markdown links:\n${broken.join("\n")}`); | ||
| }); | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The matcher only recognizes inline links of the form
[text](target), so a standard reference-style link such as[guide][docs]with[docs]: missing.mdis ignored and the test still passes. A broken relative link can therefore be introduced without triggering the repository-wide safeguard this test claims to provide; parse reference definitions as well or use a Markdown parser.Useful? React with 👍 / 👎.