@life-and-dev/mdsite 0.5.1 → 0.5.2

package/mdsite-nuxt/app/composables/useSiteConfig.test.ts

@@ -0,0 +1,117 @@
+/**
+ * Unit tests for the pure `mapSiteConfig` helper extracted from
+ * `useSiteConfig`. The `sourceEdit` Edit-on-GitHub link in `AppBar` and
+ * `AppFooter` is only rendered when `getEditUrl()` produces a URL, which
+ * in turn requires `contentGitRepo` to be populated from `server.repo`.
+ * These tests pin that mapping down so a future refactor cannot regress
+ * it back to the empty-string default.
+ */
+
+import { describe, expect, it } from 'vitest'
+import { mapSiteConfig } from './useSiteConfig'
+
+describe('mapSiteConfig', () => {
+  it('returns safe defaults when siteConfig is undefined', () => {
+    const result = mapSiteConfig(undefined, undefined)
+
+    expect(result).toEqual({
+      siteName: '',
+      siteCanonical: '',
+      contentGitRepo: '',
+      contentGitBranch: 'main',
+      contentGitPath: '.',
+      contentPath: '.',
+      features: {
+        bibleTooltips: false,
+        sourceEdit: false
+      },
+      themeColorLight: '#000000',
+      themeColorDark: '#ffffff'
+    })
+  })
+
+  it('reads site metadata from site.name and site.canonical', () => {
+    const result = mapSiteConfig({
+      site: { name: 'My Site', canonical: 'https://example.test' }
+    }, undefined)
+
+    expect(result.siteName).toBe('My Site')
+    expect(result.siteCanonical).toBe('https://example.test')
+  })
+
+  describe('contentGitRepo (Edit on GitHub source)', () => {
+    it('reads server.repo into contentGitRepo', () => {
+      const result = mapSiteConfig({
+        server: { repo: 'https://github.com/life-and-dev/mdsite' }
+      }, undefined)
+
+      expect(result.contentGitRepo).toBe('https://github.com/life-and-dev/mdsite')
+    })
+
+    it('defaults to empty string when server.repo is missing', () => {
+      const result = mapSiteConfig({ server: {} }, undefined)
+
+      expect(result.contentGitRepo).toBe('')
+    })
+
+    it('defaults to empty string when server is missing entirely', () => {
+      const result = mapSiteConfig({}, undefined)
+
+      expect(result.contentGitRepo).toBe('')
+    })
+  })
+
+  describe('features', () => {
+    it('defaults both feature flags to false when features is missing', () => {
+      const result = mapSiteConfig({}, undefined)
+
+      expect(result.features.bibleTooltips).toBe(false)
+      expect(result.features.sourceEdit).toBe(false)
+    })
+
+    it('reads sourceEdit from features.sourceEdit', () => {
+      const result = mapSiteConfig({
+        features: { sourceEdit: true, bibleTooltips: false }
+      }, undefined)
+
+      expect(result.features.sourceEdit).toBe(true)
+      expect(result.features.bibleTooltips).toBe(false)
+    })
+
+    it('reads bibleTooltips from features.bibleTooltips', () => {
+      const result = mapSiteConfig({
+        features: { sourceEdit: false, bibleTooltips: true }
+      }, undefined)
+
+      expect(result.features.sourceEdit).toBe(false)
+      expect(result.features.bibleTooltips).toBe(true)
+    })
+  })
+
+  describe('theme colors', () => {
+    it('uses the configured light/dark primary colors when present', () => {
+      const result = mapSiteConfig({
+        themes: {
+          light: { colors: { primary: '#111111' } },
+          dark: { colors: { primary: '#eeeeee' } }
+        }
+      }, undefined)
+
+      expect(result.themeColorLight).toBe('#111111')
+      expect(result.themeColorDark).toBe('#eeeeee')
+    })
+
+    it('falls back to defaults when theme colors are missing', () => {
+      const result = mapSiteConfig({ themes: { light: {}, dark: {} } }, undefined)
+
+      expect(result.themeColorLight).toBe('#000000')
+      expect(result.themeColorDark).toBe('#ffffff')
+    })
+  })
+
+  it('passes through the contentPath argument with a dot default', () => {
+    expect(mapSiteConfig({}, '/abs/docs').contentPath).toBe('/abs/docs')
+    expect(mapSiteConfig({}, undefined).contentPath).toBe('.')
+    expect(mapSiteConfig({}, '').contentPath).toBe('.')
+  })
+})

package/mdsite-nuxt/app/composables/useSiteConfig.ts

@@ -1,4 +1,28 @@
-interface SiteConfig {
+/**
+ * Subset of the runtime `mdsite.yml` config shape that `useSiteConfig`
+ * consumes. The runtime value is the full `MdsiteConfig`, but we type only
+ * the fields this composable reads so the pure mapper below can be unit
+ * tested without pulling in the entire config schema.
+ */
+export interface RawSiteConfig {
+  site?: {
+    name?: string
+    canonical?: string
+  }
+  server?: {
+    repo?: string
+  }
+  features?: {
+    bibleTooltips?: boolean
+    sourceEdit?: boolean
+  }
+  themes?: {
+    light?: { colors?: { primary?: string } }
+    dark?: { colors?: { primary?: string } }
+  }
+}
+
+export interface SiteConfig {
   siteName: string
   siteCanonical: string
   contentGitRepo: string
@@ -14,19 +38,23 @@ interface SiteConfig {
 }
 
 /**
- * Get site configuration based on runtime config
+ * Pure helper that maps the raw runtime `siteConfig` object into the shape
+ * the renderer actually consumes. Extracted from `useSiteConfig` so the
+ * field mapping (notably `contentGitRepo` ← `server.repo`, which is what
+ * powers the Edit on GitHub link in `AppBar` and `AppFooter`) can be unit
+ * tested independently of the Nuxt runtime.
  */
-export function useSiteConfig(): SiteConfig {
-  const config = useRuntimeConfig()
-  const siteConfig = config.public.siteConfig as any
-
+export function mapSiteConfig(
+  siteConfig: RawSiteConfig | undefined,
+  contentPath: string | undefined,
+): SiteConfig {
   return {
     siteName: siteConfig?.site?.name || '',
     siteCanonical: siteConfig?.site?.canonical || '',
-    contentGitRepo: '',
+    contentGitRepo: siteConfig?.server?.repo || '',
     contentGitBranch: 'main',
     contentGitPath: '.',
-    contentPath: config.public.contentPath || '.',
+    contentPath: contentPath || '.',
     features: {
       bibleTooltips: siteConfig?.features?.bibleTooltips ?? false,
       sourceEdit: siteConfig?.features?.sourceEdit ?? false
@@ -35,3 +63,13 @@ export function useSiteConfig(): SiteConfig {
     themeColorDark: siteConfig?.themes?.dark?.colors?.primary || '#ffffff'
   }
 }
+
+/**
+ * Get site configuration based on runtime config
+ */
+export function useSiteConfig(): SiteConfig {
+  const config = useRuntimeConfig()
+  const siteConfig = config.public.siteConfig as RawSiteConfig | undefined
+
+  return mapSiteConfig(siteConfig, config.public.contentPath)
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@life-and-dev/mdsite",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "type": "module",
   "private": false,
   "description": "Local-first CLI that orchestrates mdsite-nuxt",