fix: Ignores links in draft pages

HiDeoo · Oct 30, 2024 · da925d5 · da925d5
1 parent b7563c8
commit da925d5
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 751 deletions.
diff --git a/example/package.json b/example/package.json
@@ -13,8 +13,8 @@
     "lint": "prettier -c --cache . && eslint . --cache --max-warnings=0"
   },
   "dependencies": {
-    "@astrojs/starlight": "0.15.0",
-    "astro": "4.0.4",
+    "@astrojs/starlight": "0.24.4",
+    "astro": "4.11.0",
     "sharp": "0.32.6",
     "starlight-links-validator": "workspace:*"
   },

diff --git a/packages/starlight-links-validator/libs/remark.ts b/packages/starlight-links-validator/libs/remark.ts
@@ -26,6 +26,8 @@ export const remarkStarlightLinksValidator: Plugin<[{ base: string; srcDir: URL
   srcDir,
 }) {
   return (tree, file) => {
+    if (file.data.astro?.frontmatter?.draft) return
+
     const slugger = new GitHubSlugger()
     const filePath = normalizeFilePath(base, srcDir, file.history[0])
     const slug = file.data.astro?.frontmatter?.slug
@@ -193,6 +195,7 @@ declare module 'vfile' {
   interface DataMap {
     astro?: {
       frontmatter?: {
+        draft?: boolean
         slug?: string
       }
     }

diff --git a/packages/starlight-links-validator/tests/basics.test.ts b/packages/starlight-links-validator/tests/basics.test.ts
@@ -21,7 +21,7 @@ test('does not build with invalid links', async () => {
 
   expect(status).toBe('error')
 
-  expectValidationErrorCount(output, 59, 4)
+  expectValidationErrorCount(output, 61, 4)
 
   expectValidationErrors(output, 'test/', [
     ['/https://starlight.astro.build/', ValidationErrorType.InvalidLink],
@@ -30,6 +30,8 @@ test('does not build with invalid links', async () => {
     ['/unknown/', ValidationErrorType.InvalidLink],
     ['/unknown#title', ValidationErrorType.InvalidLink],
     ['/unknown/#title', ValidationErrorType.InvalidLink],
+    ['/draft', ValidationErrorType.InvalidLink],
+    ['/draft/', ValidationErrorType.InvalidLink],
     ['#links', ValidationErrorType.InvalidHash],
     ['/guides/example/#links', ValidationErrorType.InvalidHash],
     ['/icon.svg', ValidationErrorType.InvalidLink],

diff --git a/...tarlight-links-validator/tests/fixtures/invalid-links/src/content/docs/draft.md b/...tarlight-links-validator/tests/fixtures/invalid-links/src/content/docs/draft.md
@@ -0,0 +1,6 @@
+---
+title: Draft
+draft: true
+---
+
+This is a draft page.
diff --git a/...starlight-links-validator/tests/fixtures/invalid-links/src/content/docs/test.md b/...starlight-links-validator/tests/fixtures/invalid-links/src/content/docs/test.md
@@ -16,6 +16,9 @@ title: Test
 - [Unknown page with hash](/unknown#title)
 - [Unknown page with hash](/unknown/#title)
 
+- [Draft page](/draft)
+- [Draft page](/draft/)
+
 # More links
 
 - [Link to valid hash in this page](#some-links)

diff --git a/.../starlight-links-validator/tests/fixtures/valid-links/src/content/docs/draft.md b/.../starlight-links-validator/tests/fixtures/valid-links/src/content/docs/draft.md
@@ -0,0 +1,8 @@
+---
+title: Draft
+draft: true
+---
+
+This is a draft page.
+
+[Invalid link](/unknown/)