test(docs): validate nested TOC anchors, and fix the slugify that hid one (#3039)
**Stacked on #3036** (its commit is the parent). That PR fixes a guard that had been red on `main`; this closes the gap it leaves and, in doing so, turned up a second defect in the helper. ## 1. Nested anchors were accepted but never resolved #3036 makes the parser recognise sub-entries — correct, and it fixes the red. But it validates only their link *shape*. Measured on that branch: | corruption | result | |---|---| | **nested** entry → `#kb-nonexistent-anchor` | **passes** | | **top-level** entry → `#kb-nonexistent-anchor` | fails | A TOC guard exists so links resolve. Checking that for one class of entry and not the other leaves a dead sub-link to be found by a reader clicking it. ## 2. Resolving them exposed the slugify bug Adding the check failed immediately — on the **real document**, against a heading that exists: ``` Nested TOC anchor #theming--overlay-layering-for-dashboard-views matches no heading ``` The document is right; the helper was wrong. `slugifyHeading` collapsed whitespace **runs**: ```js .replace(/\s+/g, "-") // theming-overlay-layering-... .replace(/\s/g, "-") // theming--overlay-layering-... ← GitHub, and the doc's own link ``` GitHub emits one hyphen **per space**. `### Theming & Overlay Layering for Dashboard Views` loses the `&` and keeps both spaces, so the true anchor carries a double hyphen. **This was latent, not dormant-and-harmless:** the two spellings differ only when punctuation is stripped from *between* words, and all eighteen numbered section titles are punctuation-free — so every existing use of the helper agreed. The first heading with an `&` in it would have produced a false failure against a correct document, which is the shape most likely to get a guard edited rather than believed. ## Mutations (all four) | mutation | result | |---|---| | clean | 4/4 pass | | nested anchor broken | **fails** ← was green before this PR | | top-level anchor broken | fails | | malformed top-level line | fails | | `slugify` reverted to collapsing | **fails** — the helper fix is load-bearing | Lint clean, FNXC gate exit 0. Test-only. ## Note This is the fifth guard in this batch to ship with a hole found by mutating it rather than reading it, and the second where fixing one class of input revealed the checker had been quietly wrong about another. The pattern is consistent enough to be worth expecting: **when a guard starts examining something it previously skipped, the first thing it finds is usually its own bug.** If #3036 lands first this rebases to a single commit; if taken together the stack applies as-is. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Bug Fixes** * Improved heading links to match GitHub-style anchors when punctuation separates words. * Enhanced nested table-of-contents validation to confirm links point to headings in the document. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -30,12 +30,25 @@ const expectedSections = [
|
||||
"Plugin Binary Setup Hooks",
|
||||
];
|
||||
|
||||
/*
|
||||
FNXC:PluginAuthoringDocs 2026-07-31-04:30:
|
||||
ONE HYPHEN PER SPACE, not one per RUN — GitHub does not collapse whitespace when it builds an anchor.
|
||||
|
||||
`\s+ -> "-"` agrees with GitHub for every title whose words are single-spaced, which is why it went
|
||||
unnoticed: the two differ only once punctuation is stripped from BETWEEN words, leaving a gap.
|
||||
`### Theming & Overlay Layering for Dashboard Views` is the live case — GitHub emits
|
||||
`theming--overlay-...` (the `&` is removed, both spaces survive) and the document's own link uses it,
|
||||
while this helper produced the single-hyphen form.
|
||||
|
||||
Latent until the nested-anchor check below started resolving sub-entries against real headings: the
|
||||
numbered top-level titles contain no punctuation, so the two spellings agreed on all eighteen.
|
||||
*/
|
||||
function slugifyHeading(text) {
|
||||
return text
|
||||
.trim()
|
||||
.toLowerCase()
|
||||
.replace(/[^a-z0-9\s-]/g, "")
|
||||
.replace(/\s+/g, "-");
|
||||
.replace(/\s/g, "-");
|
||||
}
|
||||
|
||||
test("PLUGIN_AUTHORING headings are sequentially numbered 1..18 with expected titles", () => {
|
||||
@@ -69,9 +82,32 @@ test("PLUGIN_AUTHORING TOC includes top-level dashboard views and anchors align
|
||||
this test exists to be.
|
||||
*/
|
||||
const rawTocLines = tocMatch[1].split("\n").filter((line) => line.trim());
|
||||
|
||||
/*
|
||||
FNXC:PluginAuthoringDocs 2026-07-31-04:20:
|
||||
A NESTED ENTRY'S ANCHOR IS CHECKED TOO, not merely its shape.
|
||||
|
||||
Accepting sub-entries fixed the false rejection above, but left them validated only for link SHAPE:
|
||||
MEASURED on that fix, pointing this sub-entry at `#kb-nonexistent-anchor` kept the suite green,
|
||||
while the identical corruption in a top-level entry failed. A TOC guard whose whole purpose is that
|
||||
links resolve cannot check that for one class of entry and not the other — a dead sub-link is found
|
||||
by a reader clicking it, which is the outcome this file exists to prevent.
|
||||
|
||||
Resolved against the document's own headings via the same `slugifyHeading` the top-level check uses,
|
||||
so both classes answer to one definition of "this anchor exists".
|
||||
*/
|
||||
const headingAnchors = new Set(
|
||||
[...doc.matchAll(/^#{2,6}\s+(.+)$/gm)].map((m) => slugifyHeading(m[1])),
|
||||
);
|
||||
const subEntries = rawTocLines.filter((line) => /^\s+/.test(line));
|
||||
for (const line of subEntries) {
|
||||
assert.ok(/^\s+-\s+\[.+\]\(#.+\)$/.test(line.replace(/\s+$/, "")), `Invalid nested TOC line: ${line}`);
|
||||
const trimmed = line.replace(/\s+$/, "");
|
||||
const shape = trimmed.match(/^\s+-\s+\[(.+)\]\(#(.+)\)$/);
|
||||
assert.ok(shape, `Invalid nested TOC line: ${line}`);
|
||||
assert.ok(
|
||||
headingAnchors.has(shape[2]),
|
||||
`Nested TOC anchor #${shape[2]} matches no heading in PLUGIN_AUTHORING.md (entry: ${shape[1]})`,
|
||||
);
|
||||
}
|
||||
|
||||
const tocLines = rawTocLines.filter((line) => !/^\s/.test(line)).map((line) => line.trim());
|
||||
|
||||
Reference in New Issue
Block a user