@levino/shipyard-base 0.8.5 → 0.9.0

package/README.md

@@ -10,10 +10,10 @@ npm install @levino/shipyard-base
 
 ## Peer Dependencies
 
-- `astro` ^5.7
-- `tailwindcss` ^3
-- `daisyui` ^4
-- `@tailwindcss/typography` ^0.5.10
+- `astro` ^7.2.4
+- `tailwindcss` ^4
+- `daisyui` ^5
+- `@tailwindcss/typography` ^0.5.20
 
 ## Basic Usage
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@levino/shipyard-base",
-  "version": "0.8.5",
+  "version": "0.9.0",
   "description": "Core layouts, components, and configuration for shipyard - a composable page builder for Astro",
   "keywords": [
     "astro",
@@ -38,8 +38,8 @@
     "./styles/components.css": "./src/styles/components.css"
   },
   "peerDependencies": {
-    "@tailwindcss/typography": "^0.5.10",
-    "astro": "^6.1.6",
+    "@tailwindcss/typography": "^0.5.20",
+    "astro": "^7.2.4",
     "daisyui": "^5",
     "tailwindcss": "^4"
   },
@@ -53,21 +53,22 @@
     "url": "https://github.com/levino/shipyard"
   },
   "devDependencies": {
-    "@tailwindcss/typography": "^0.5.10",
-    "@types/ramda": "^0.31",
+    "@tailwindcss/typography": "^0.5.20",
+    "@types/ramda": "^0.32",
     "daisyui": "^5",
     "remark": "^15.0.1",
     "remark-html": "^16.0.1",
     "tailwindcss": "^4",
-    "typescript": "^5.2.2",
-    "vite": "^7.3.2",
-    "vitest": "^4.1.0"
+    "typescript": "^7.0.2",
+    "vite": "^8.2.2",
+    "vitest": "^4.1.11"
   },
   "dependencies": {
+    "@astrojs/markdown-remark": "^7.2.4",
     "clsx": "^2.1.0",
     "mdast-util-directive": "^3.0.0",
     "micromark-extension-directive": "^3.0.0",
-    "ramda": "^0.31",
+    "ramda": "^0.32.0",
     "remark-directive": "^3.0.0",
     "tailwind-merge": "^2.2.0",
     "unified": "^11.0.0",

package/src/index.ts

@@ -1,4 +1,5 @@
 import { fileURLToPath } from 'node:url'
+import { isUnifiedProcessor, unified } from '@astrojs/markdown-remark'
 import type { AstroIntegration } from 'astro'
 import { remarkAdmonitions } from './remark/remarkAdmonitions'
 import { remarkBlockDirective } from './remark/remarkBlockDirective'
@@ -28,7 +29,7 @@ export default (config: Config): AstroIntegration => {
   return {
     name: 'shipyard',
     hooks: {
-      'astro:config:setup': ({ updateConfig, config: astroConfig }) => {
+      'astro:config:setup': ({ updateConfig, config: astroConfig, logger }) => {
         // Detect server mode (output: 'server' or 'hybrid')
         isServerMode = astroConfig.output === 'server'
 
@@ -45,13 +46,37 @@ export default (config: Config): AstroIntegration => {
           [shipyardCssId]: config.css ? `import '${config.css}';` : '',
         } as Record<string, string | undefined>
 
+        // Astro 7 renders Markdown with Sätteri by default, which does not run
+        // unified plugins. shipyard's admonitions, npm2yarn tabs and block
+        // directives are all remark plugins, so we pin the unified processor
+        // from @astrojs/markdown-remark. Any plugins the user already put on
+        // their own `unified()` processor are carried over so both sets run;
+        // plugins they pass via the deprecated `markdown.remarkPlugins` option
+        // are appended by Astro afterwards.
+        const userProcessor = astroConfig.markdown?.processor
+        const inherited =
+          userProcessor && isUnifiedProcessor(userProcessor)
+            ? userProcessor.options
+            : undefined
+
+        if (userProcessor && !inherited) {
+          logger.warn(
+            `\`markdown.processor\` is set to \`${userProcessor.name}\`, which does not run remark plugins. ` +
+              'Overriding it with `unified()` so shipyard admonitions, npm2yarn tabs and block directives keep working.',
+          )
+        }
+
         updateConfig({
           markdown: {
-            remarkPlugins: [
-              remarkBlockDirective,
-              remarkAdmonitions,
-              remarkNpm2Yarn,
-            ],
+            processor: unified({
+              ...inherited,
+              remarkPlugins: [
+                ...(inherited?.remarkPlugins ?? []),
+                remarkBlockDirective,
+                remarkAdmonitions,
+                remarkNpm2Yarn,
+              ],
+            }),
           },
           vite: {
             plugins: [

package/src/markdownProcessor.test.ts

@@ -0,0 +1,92 @@
+import type { UnifiedResolvedOptions } from '@astrojs/markdown-remark'
+import { unified } from '@astrojs/markdown-remark'
+import { describe, expect, test, vi } from 'vitest'
+import shipyard from './index'
+import type { Config } from './schemas/config'
+
+const SHIPYARD_PLUGIN_COUNT = 3
+
+interface ConfigUpdate {
+  markdown?: {
+    remarkPlugins?: unknown
+    processor?: { name: string; options: UnifiedResolvedOptions }
+  }
+}
+
+const baseConfig: Config = {
+  title: 'Test',
+  brand: 'Test',
+  navigation: {},
+}
+
+/**
+ * Runs the integration's `astro:config:setup` hook against a fake Astro config
+ * and returns whatever it passed to `updateConfig`, plus the logger it used.
+ */
+const runConfigSetup = (astroConfig: Record<string, unknown> = {}) => {
+  const updates: ConfigUpdate[] = []
+  const logger = { warn: vi.fn(), info: vi.fn(), error: vi.fn() }
+
+  const integration = shipyard(baseConfig)
+  const hook = integration.hooks['astro:config:setup']
+  if (!hook) throw new Error('astro:config:setup hook missing')
+
+  hook({
+    updateConfig: (update: ConfigUpdate) => updates.push(update),
+    config: astroConfig,
+    logger,
+  } as never)
+
+  return { update: updates[0], logger }
+}
+
+describe('markdown processor', () => {
+  test('pins the unified processor so remark plugins run under Astro 7', () => {
+    const { update } = runConfigSetup()
+
+    expect(update?.markdown?.processor?.name).toBe(unified().name)
+    expect(update?.markdown?.processor?.options.remarkPlugins).toHaveLength(
+      SHIPYARD_PLUGIN_COUNT,
+    )
+  })
+
+  test('does not use the deprecated markdown.remarkPlugins option', () => {
+    const { update } = runConfigSetup()
+
+    expect(update?.markdown).not.toHaveProperty('remarkPlugins')
+  })
+
+  test("keeps the user's own plugins on an existing unified processor", () => {
+    const userPlugin = () => undefined
+    const { update, logger } = runConfigSetup({
+      markdown: { processor: unified({ remarkPlugins: [userPlugin] }) },
+    })
+
+    const plugins = update?.markdown?.processor?.options.remarkPlugins
+    expect(plugins).toHaveLength(SHIPYARD_PLUGIN_COUNT + 1)
+    expect(plugins?.[0]).toBe(userPlugin)
+    expect(logger.warn).not.toHaveBeenCalled()
+  })
+
+  test("carries over the user's other unified options", () => {
+    const { update } = runConfigSetup({
+      markdown: { processor: unified({ gfm: false, smartypants: false }) },
+    })
+
+    expect(update?.markdown?.processor?.options.gfm).toBe(false)
+    expect(update?.markdown?.processor?.options.smartypants).toBe(false)
+  })
+
+  test('warns and overrides when a non-unified processor is configured', () => {
+    const { update, logger } = runConfigSetup({
+      markdown: { processor: { name: 'satteri', options: {} } },
+    })
+
+    expect(logger.warn).toHaveBeenCalledOnce()
+    expect(logger.warn.mock.calls[0][0]).toContain('satteri')
+    expect(update?.markdown?.processor?.name).toBe(unified().name)
+    expect(update?.markdown?.processor?.options.remarkPlugins).toHaveLength(
+      SHIPYARD_PLUGIN_COUNT,
+    )
+  })
+})