starlight-links-validator 0.18.0 → 0.19.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # starlight-links-validator
 
+## 0.19.0
+
+### Minor Changes
+
+- [#123](https://github.com/HiDeoo/starlight-links-validator/pull/123) [`e9cc59d`](https://github.com/HiDeoo/starlight-links-validator/commit/e9cc59de376c7602f70e9310e320fdd6d44a17d3) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds validation of [hero action links](https://starlight.astro.build/reference/frontmatter/#hero) in frontmatter.
+
+- [#123](https://github.com/HiDeoo/starlight-links-validator/pull/123) [`e9cc59d`](https://github.com/HiDeoo/starlight-links-validator/commit/e9cc59de376c7602f70e9310e320fdd6d44a17d3) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds validation of [previous](https://starlight.astro.build/reference/frontmatter/#prev) and [next](https://starlight.astro.build/reference/frontmatter/#next) page links in frontmatter.
+
+## 0.18.1
+
+### Patch Changes
+
+- [#121](https://github.com/HiDeoo/starlight-links-validator/pull/121) [`242bc28`](https://github.com/HiDeoo/starlight-links-validator/commit/242bc2862aa7d911d5de0301e5caa29342e92ffd) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Setups trusted publishing using OpenID Connect (OIDC) authentication — no code changes.
+
 ## 0.18.0
 
 ### Minor Changes

package/libs/remark.ts

@@ -14,6 +14,7 @@ import type { MdxJsxAttribute, MdxJsxExpressionAttribute } from 'mdast-util-mdx-
 import { toString } from 'mdast-util-to-string'
 import type { Plugin } from 'unified'
 import { visit } from 'unist-util-visit'
+import type { DataMap } from 'vfile'
 
 import type { StarlightLinksValidatorOptions } from '..'
 
@@ -53,6 +54,8 @@ export const remarkStarlightLinksValidator: Plugin<[RemarkStarlightLinksValidato
     const fileLinks: Link[] = []
     const fileDefinitions = new Map<string, string>()
 
+    extractFrontmatterLinks(file.data.astro?.frontmatter, fileLinks, config)
+
     visit(tree, 'definition', (node) => {
       fileDefinitions.set(node.identifier, node.url)
     })
@@ -230,6 +233,54 @@ function isMdxIdAttribute(attribute: MdxJsxAttribute | MdxJsxExpressionAttribute
   return attribute.type === 'mdxJsxAttribute' && attribute.name === 'id' && typeof attribute.value === 'string'
 }
 
+function extractFrontmatterLinks(
+  frontmatter: Frontmatter,
+  fileLinks: Link[],
+  config: RemarkStarlightLinksValidatorConfig,
+) {
+  if (!frontmatter) return
+
+  if (isFrontmatterWithHeroActions(frontmatter)) {
+    for (const action of frontmatter.hero.actions) {
+      const link = getLinkToValidate(action.link, config)
+      if (link) fileLinks.push(link)
+    }
+  }
+
+  if (isFrontmatterPrevNextLink(frontmatter, 'prev')) {
+    const link = getLinkToValidate(frontmatter.prev.link, config)
+    if (link) fileLinks.push(link)
+  }
+
+  if (isFrontmatterPrevNextLink(frontmatter, 'next')) {
+    const link = getLinkToValidate(frontmatter.next.link, config)
+    if (link) fileLinks.push(link)
+  }
+}
+
+function isFrontmatterWithHeroActions(
+  frontmatter: Frontmatter,
+): frontmatter is Frontmatter & { hero: FrontmatterHeroActions } {
+  return (
+    frontmatter !== undefined &&
+    'hero' in frontmatter &&
+    typeof frontmatter['hero'] === 'object' &&
+    'actions' in frontmatter['hero']
+  )
+}
+
+function isFrontmatterPrevNextLink<T extends 'prev' | 'next'>(
+  frontmatter: Frontmatter,
+  type: T,
+): frontmatter is Frontmatter & Record<T, FrontmatterPrevNextLink> {
+  return (
+    frontmatter !== undefined &&
+    type in frontmatter &&
+    typeof frontmatter[type] === 'object' &&
+    'link' in frontmatter[type]
+  )
+}
+
 export interface RemarkStarlightLinksValidatorConfig {
   base: string
   options: StarlightLinksValidatorOptions
@@ -260,3 +311,13 @@ interface MdxIdAttribute {
   type: 'mdxJsxAttribute'
   value: string
 }
+
+type Frontmatter = DataMap['astro']['frontmatter']
+
+interface FrontmatterHeroActions {
+  actions: { link: string }[]
+}
+
+interface FrontmatterPrevNextLink {
+  link: string
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-links-validator",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "license": "MIT",
   "description": "Starlight plugin to validate internal links.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -41,8 +41,7 @@
   },
   "packageManager": "pnpm@8.6.3",
   "publishConfig": {
-    "access": "public",
-    "provenance": true
+    "access": "public"
   },
   "sideEffects": false,
   "keywords": [