fix: validate reference-style links

HiDeoo · Nov 6, 2023 · 9a9f2fb · 9a9f2fb
1 parent ba1be29
commit 9a9f2fb
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 2 deletions.
diff --git a/packages/starlight-links-validator/libs/remark.ts b/packages/starlight-links-validator/libs/remark.ts
@@ -24,8 +24,13 @@ export const remarkStarlightLinksValidator: Plugin<[], Root> = function () {
 
     const fileHeadings: string[] = []
     const fileLinks: string[] = []
+    const fileDefinitions = new Map<string, string>()
 
-    visit(tree, ['heading', 'html', 'link', 'mdxJsxFlowElement', 'mdxJsxTextElement'], (node) => {
+    visit(tree, 'definition', (node) => {
+      fileDefinitions.set(node.identifier, node.url)
+    })
+
+    visit(tree, ['heading', 'html', 'link', 'linkReference', 'mdxJsxFlowElement', 'mdxJsxTextElement'], (node) => {
       // https://github.com/syntax-tree/mdast#nodes
       // https://github.com/syntax-tree/mdast-util-mdx-jsx#nodes
       switch (node.type) {
@@ -47,6 +52,15 @@ export const remarkStarlightLinksValidator: Plugin<[], Root> = function () {
 
           break
         }
+        case 'linkReference': {
+          const definition = fileDefinitions.get(node.identifier)
+
+          if (definition && isInternalLink(definition)) {
+            fileLinks.push(definition)
+          }
+
+          break
+        }
         case 'mdxJsxFlowElement': {
           for (const attribute of node.attributes) {
             if (isMdxIdAttribute(attribute)) {

diff --git a/...ight-links-validator/tests/fixtures/with-invalid-links/src/content/docs/test.md b/...ight-links-validator/tests/fixtures/with-invalid-links/src/content/docs/test.md
@@ -23,6 +23,14 @@ title: Test
 - [Link to invalid asset](/icon.svg)
 - [Link to another invalid asset](/guidelines/ui.pdf)
 
+## Links with references
+
+- [Link reference to unknwon page][ref-unknown-page]
+- [Link reference to invalid anchor][ref-invalid-anchor]
+
+[ref-unknown-page]: /unknown-ref
+[ref-invalid-anchor]: #unknown-ref
+
 <div id="aDiv">
 some content
 

diff --git a/...light-links-validator/tests/fixtures/with-valid-links/src/content/docs/index.md b/...light-links-validator/tests/fixtures/with-valid-links/src/content/docs/index.md
@@ -29,3 +29,14 @@ title: Index
 ## A more `complex` heading
 
 - [Link to more complex anchor](#a-more-complex-heading)
+
+## Links with references
+
+- [ref]
+- [Link reference][ref]
+- [Link reference with anchor in this page][ref-with-anchor-internal]
+- [Link reference with anchor in another page][ref-with-anchor-external]
+
+[ref]: /test
+[ref-with-anchor-internal]: #some-links
+[ref-with-anchor-external]: /test#title
diff --git a/packages/starlight-links-validator/tests/validation.test.ts b/packages/starlight-links-validator/tests/validation.test.ts
@@ -16,7 +16,7 @@ test('should not build with invalid links', async () => {
   try {
     await loadFixture('with-invalid-links')
   } catch (error) {
-    expect(error).toMatch(/Found 18 invalid links in 3 files./)
+    expect(error).toMatch(/Found 20 invalid links in 3 files./)
 
     expect(error).toMatch(
       new RegExp(`▶ test/
@@ -29,6 +29,8 @@ test('should not build with invalid links', async () => {
   ├─ /guides/example/#links
   ├─ /icon.svg
   ├─ /guidelines/ui.pdf
+  ├─ /unknown-ref
+  ├─ #unknown-ref
   └─ #anotherDiv`),
     )