starlight-heading-badges 0.4.1 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # starlight-heading-badges
 
+## 0.6.0
+
+### Minor Changes
+
+- [#18](https://github.com/HiDeoo/starlight-heading-badges/pull/18) [`261fda4`](https://github.com/HiDeoo/starlight-heading-badges/commit/261fda465d560146c55a2f148f36a28de384fdc8) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for rendering multiple badges to the same heading.
+
+### Patch Changes
+
+- [#16](https://github.com/HiDeoo/starlight-heading-badges/pull/16) [`3a590c7`](https://github.com/HiDeoo/starlight-heading-badges/commit/3a590c7332c0bdaacd6109b5597b84cd5a415daf) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes an issue for heading badges with multiple spaces.
+
+## 0.5.0
+
+### Minor Changes
+
+- [#12](https://github.com/HiDeoo/starlight-heading-badges/pull/12) [`508982f`](https://github.com/HiDeoo/starlight-heading-badges/commit/508982fc5050e700669382f195aaa420a4b59748) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now version `0.32.0`.
+
+  Please use the `@astrojs/upgrade` command to upgrade your project:
+
+  ```sh
+  npx @astrojs/upgrade
+  ```
+
 ## 0.4.1
 
 ### Patch Changes

package/components/HeadingBadgesMobileTableOfContents.astro

@@ -5,11 +5,10 @@
  */
 
 import { Icon } from '@astrojs/starlight/components'
-import type { Props } from '@astrojs/starlight/props'
 
 import TableOfContentsList from './TableOfContentsList.astro'
 
-const { toc } = Astro.props
+const { toc } = Astro.locals.starlightRoute
 ---
 
 {
@@ -114,7 +113,7 @@ const { toc } = Astro.props
 </style>
 
 <script>
-  import { deserializeBadge } from '../libs/badge'
+  import { deserializeBadges } from '../libs/badge'
   import { StarlightTOC } from '../libs/starlight-toc'
 
   class MobileStarlightTOC extends StarlightTOC {
@@ -124,15 +123,18 @@ const { toc } = Astro.props
       if (display) {
         const heading = link.dataset['shbHeading']
         if (heading) {
-          const badge = deserializeBadge(heading)
-          if (badge) {
+          const badges = deserializeBadges(heading)
+          if (badges.length > 0) {
             display.textContent = ''
-            display.append(document.createTextNode(`${badge.heading} `))
-            const span = document.createElement('span')
-            span.textContent = badge.text
-            span.dataset['shbBadge'] = ''
-            span.dataset['shbBadgeVariant'] = badge.variant
-            display.append(span)
+            display.append(document.createTextNode(`${badges[0]?.heading} `))
+
+            for (const badge of badges) {
+              const span = document.createElement('span')
+              span.textContent = badge.text
+              span.dataset['shbBadge'] = ''
+              span.dataset['shbBadgeVariant'] = badge.variant
+              display.append(span)
+            }
 
             return
           }

package/components/HeadingBadgesTableOfContents.astro

@@ -4,11 +4,9 @@
  * @see https://github.com/withastro/starlight/blob/1d32c8b0cec0ea5f66351b21b91748dfa78b404b/packages/starlight/components/TableOfContents.astro
  */
 
-import type { Props } from '@astrojs/starlight/props'
-
 import TableOfContentsList from './TableOfContentsList.astro'
 
-const { toc } = Astro.props
+const { toc } = Astro.locals.starlightRoute
 ---
 
 {

package/components/TableOfContentHeading.astro

@@ -1,7 +1,7 @@
 ---
 import { Badge } from '@astrojs/starlight/components'
 
-import { deserializeBadge } from '../libs/badge'
+import { deserializeBadges } from '../libs/badge'
 
 interface Props {
   text: string
@@ -9,14 +9,16 @@ interface Props {
 
 const { text } = Astro.props
 
-const badge = deserializeBadge(text)
+const badges = deserializeBadges(text)
 ---
 
 {
-  badge ? (
+  badges.length > 0 ? (
     <span class="shb-heading">
-      {badge.heading.trim()}&nbsp;
-      <Badge size="small" text={badge.text} variant={badge.variant} />
+      {badges[0]?.heading.trim()}&nbsp;
+      {badges.map((badge) => (
+        <Badge size="small" text={badge.text} variant={badge.variant} />
+      ))}
     </span>
   ) : (
     <span>{text}</span>

package/index.ts

@@ -7,7 +7,7 @@ export default function starlightHeadingBadgesPlugin(): StarlightPlugin {
   return {
     name: 'starlight-heading-badges-plugin',
     hooks: {
-      setup({ addIntegration, config: starlightConfig, logger, updateConfig }) {
+      'config:setup'({ addIntegration, config: starlightConfig, logger, updateConfig }) {
         addIntegration(starlightHeadingBadgesIntegration())
 
         updateConfig({

package/libs/badge.ts

@@ -14,23 +14,34 @@ export function serializeBadge(variant: Variant, text: string) {
     serializedBadgeDelimiter,
     variant,
     serializedBadgeDelimiter,
-    text.replace(' ', serializedBadgeSpaceDelimiter),
+    text.replaceAll(' ', serializedBadgeSpaceDelimiter),
     serializedBadgeDelimiter,
   ].join('')
 }
 
-export function deserializeBadge(value: string): Badge | undefined {
-  const serializeBadge = value.split(' ').pop()
-  if (!serializeBadge) return
+export function deserializeBadges(value: string): Badge[] {
+  const badges: Badge[] = []
 
-  const parts = serializeBadge.split(serializedBadgeDelimiter)
+  const parts = value.split(' ').reverse()
+
+  for (const part of parts) {
+    const badge = deserializeBadge(value, part)
+    if (!badge) break
+    badges.unshift(badge)
+  }
+
+  return badges
+}
+
+function deserializeBadge(heading: string, value: string): Badge | undefined {
+  const parts = value.split(serializedBadgeDelimiter)
   const [, variant, text] = parts
 
   if (!variant || !isBadgeVariant(variant) || !text) return undefined
 
   return {
-    heading: value.replace(new RegExp(`${serializedBadgeDelimiter}.*${serializedBadgeDelimiter}`), ''),
-    text: text.replace(serializedBadgeSpaceDelimiter, ' '),
+    heading: heading.replace(new RegExp(`${serializedBadgeDelimiter}.*${serializedBadgeDelimiter}`), ''),
+    text: text.replaceAll(serializedBadgeSpaceDelimiter, ' '),
     variant,
   }
 }

package/libs/plugin.ts

@@ -1,4 +1,4 @@
-import type { StarlightPlugin } from '@astrojs/starlight/types'
+import type { HookParameters } from '@astrojs/starlight/types'
 import type { AstroIntegrationLogger } from 'astro'
 
 export function overrideComponents(
@@ -27,4 +27,4 @@ interface ComponentOverride {
   fallback: string
 }
 
-type StarlightUserConfig = Parameters<StarlightPlugin['hooks']['setup']>['0']['config']
+type StarlightUserConfig = HookParameters<'config:setup'>['config']

package/libs/rehype.ts

@@ -3,7 +3,7 @@ import 'mdast-util-directive'
 import type { ElementContent, Root } from 'hast'
 import { CONTINUE, SKIP, visit } from 'unist-util-visit'
 
-import { deserializeBadge, type Badge } from './badge'
+import { deserializeBadges, type Badge } from './badge'
 
 export function rehypeStarlightHeadingBadges() {
   return function transformer(tree: Root) {
@@ -11,14 +11,16 @@ export function rehypeStarlightHeadingBadges() {
       if (node.type === 'text') {
         if (index === undefined || !parent) return CONTINUE
 
-        const badge = deserializeBadge(node.value)
-        if (!badge) return SKIP
+        const badges = deserializeBadges(node.value)
+        if (badges.length === 0) return SKIP
 
-        if (badge.heading) {
-          node.value = badge.heading
-          parent.children.splice(index + 1, 0, createBadgeNode(badge))
-        } else {
-          parent.children.splice(index, 1, createBadgeNode(badge))
+        for (const badge of badges.reverse()) {
+          if (badge.heading) {
+            node.value = badge.heading
+            parent.children.splice(index + 1, 0, ...createBadgeNode(badge))
+          } else {
+            parent.children.splice(index, 1, ...createBadgeNode(badge))
+          }
         }
 
         return SKIP
@@ -29,14 +31,20 @@ export function rehypeStarlightHeadingBadges() {
   }
 }
 
-function createBadgeNode(badge: Badge): ElementContent {
-  return {
-    type: 'element',
-    tagName: 'span',
-    properties: {
-      'data-shb-badge': '',
-      'data-shb-badge-variant': badge.variant,
+function createBadgeNode(badge: Badge): ElementContent[] {
+  return [
+    {
+      type: 'element',
+      tagName: 'span',
+      properties: {
+        'data-shb-badge': '',
+        'data-shb-badge-variant': badge.variant,
+      },
+      children: [{ type: 'text', value: badge.text }],
     },
-    children: [{ type: 'text', value: badge.text }],
-  }
+    {
+      type: 'text',
+      value: ' ',
+    },
+  ]
 }

package/overrides/MobileTableOfContents.astro

@@ -1,7 +1,5 @@
 ---
-import type { Props } from '@astrojs/starlight/props'
-
 import HeadingBadgesMobileTableOfContents from '../components/HeadingBadgesMobileTableOfContents.astro'
 ---
 
-<HeadingBadgesMobileTableOfContents {...Astro.props} />
+<HeadingBadgesMobileTableOfContents />

package/overrides/TableOfContents.astro

@@ -1,7 +1,5 @@
 ---
-import type { Props } from '@astrojs/starlight/props'
-
 import HeadingBadgesTableOfContents from '../components/HeadingBadgesTableOfContents.astro'
 ---
 
-<HeadingBadgesTableOfContents {...Astro.props} />
+<HeadingBadgesTableOfContents />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-heading-badges",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "license": "MIT",
   "description": "Starlight plugin to add badges to your Markdown and MDX headings.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",
@@ -26,7 +26,7 @@
     "@types/mdast": "^4.0.4"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.30.0"
+    "@astrojs/starlight": ">=0.32.0"
   },
   "engines": {
     "node": ">=18"