@icebreakers/monorepo-templates 2.0.7 → 2.1.0

package/templates/vitepress/test/render.test.ts

@@ -0,0 +1,48 @@
+import { afterEach, describe, expect, it, vi } from 'vitest'
+
+const engine = vi.hoisted(() => ({ initialize: vi.fn(), render: vi.fn() }))
+vi.mock('mermaid', () => ({ default: engine }))
+
+afterEach(() => {
+  vi.unstubAllGlobals()
+  vi.resetAllMocks()
+})
+
+describe('Mermaid rendering queue', () => {
+  it('serializes theme configuration with rendering and cleans up failed diagrams', async () => {
+    const containers: { remove: ReturnType<typeof vi.fn> }[] = []
+    vi.stubGlobal('document', {
+      createElement: () => {
+        const container = { style: {}, setAttribute: vi.fn(), remove: vi.fn() }
+        containers.push(container)
+        return container
+      },
+      body: { append: vi.fn() },
+    })
+    const { renderMermaid } = await import('../.vitepress/mermaid/render')
+    const first = Promise.withResolvers<{ svg: string }>()
+    const started = Promise.withResolvers<void>()
+    engine.render.mockImplementationOnce(() => {
+      started.resolve()
+      return first.promise
+    }).mockRejectedValueOnce(new Error('Invalid diagram')).mockResolvedValueOnce({ svg: '<svg />' })
+
+    const one = renderMermaid('flowchart LR; A-->B', 'forest')
+    const two = renderMermaid('invalid', 'dark')
+    const failure = expect(two).rejects.toThrow('Invalid diagram')
+    const three = renderMermaid('flowchart LR; B-->C', 'neutral')
+    await started.promise
+    expect(engine.initialize).toHaveBeenCalledTimes(1)
+    expect(engine.initialize).toHaveBeenLastCalledWith(expect.objectContaining({ theme: 'forest' }))
+    first.resolve({ svg: '<svg />' })
+    await one
+    await failure
+    await expect(three).resolves.toEqual({ svg: '<svg />' })
+    expect(engine.initialize.mock.calls.map(([config]) => config.theme)).toEqual(['forest', 'dark', 'neutral'])
+    expect(new Set(engine.render.mock.calls.map(([id]) => id)).size).toBe(3)
+    expect(containers).toHaveLength(3)
+    for (const container of containers) {
+      expect(container.remove).toHaveBeenCalledOnce()
+    }
+  })
+})

package/templates/vitepress/test/seo.test.ts

@@ -0,0 +1,19 @@
+import type { TransformContext } from 'vitepress'
+import { expect, it } from 'vitest'
+import { faqContent } from '../.vitepress/home/faq'
+import { createPageHead } from '../.vitepress/seo'
+
+it.each([['index.md', 'en'], ['zh/index.md', 'zh']] as const)('renders valid FAQ structured data for %s', (page, locale) => {
+  const head = createPageHead({ page, title: 'repoctl', description: 'A </script> description' } as TransformContext)
+  const script = head.find(([tag, attrs]) => tag === 'script' && attrs.type === 'application/ld+json')!
+  const content = script[2]!
+  expect(content).not.toContain('</script>')
+  const schema = JSON.parse(content)
+  const faq = schema['@graph'].find((item: { '@type': string }) => item['@type'] === 'FAQPage')
+  expect(faq.mainEntity.map((item: { name: string, acceptedAnswer: { text: string } }) => [item.name, item.acceptedAnswer.text])).toEqual(faqContent[locale])
+})
+
+it('keeps homepage FAQ data off documentation pages', () => {
+  const head = createPageHead({ page: 'reference/commands.md', title: 'Commands', description: 'Commands' } as TransformContext)
+  expect(head.find(([tag]) => tag === 'script')![2]).not.toContain('FAQPage')
+})

package/templates/vitepress/tsconfig.json

@@ -10,14 +10,14 @@
     "skipLibCheck": true
   },
   "include": [
-    ".vitepress/home/**/*.ts",
-    ".vitepress/navigation/**/*.ts",
-    ".vitepress/seo.ts",
-    ".vitepress/theme/**/*.ts",
-    ".vitepress/theme/**/*.vue",
-    ".vitepress/env.d.ts",
+    ".vitepress/**/*.ts",
+    ".vitepress/**/*.vue",
     "scripts/**/*.ts",
-    "why/examples/2.npm-basic-package/src/**/*.ts",
-    "why/examples/3.npm-basic-package/src/**/*.ts"
+    "test/**/*.ts",
+    "vitest.config.ts"
+  ],
+  "exclude": [
+    ".vitepress/dist",
+    ".vitepress/cache"
   ]
 }

package/templates/vitepress/vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    name: 'website',
+    include: ['test/*.test.ts'],
+  },
+})

package/templates/vitepress/zh/ai/create.md

@@ -34,7 +34,7 @@ pnpm exec repo doctor
 | API / Hono 服务     | `hono-server`                         |
 | TypeScript 库 / SDK | `tsdown`                              |
 | Vue 组件库          | `vue-lib`                             |
-| 文档站              | `vitepress`                           |
+| 文档站              | `nimbus`                              |
 | CLI                 | `cli`                                 |
 
 意图不清时省略 `--templates`。初始化后再：

package/templates/vitepress/zh/learn/monorepo/manage.md

@@ -169,7 +169,7 @@ pnpm run repo:new
 ### 直接指定模板
 
 ```bash
-pnpm exec repo new docs --template vitepress
+pnpm exec repo new docs --template nimbus
 pnpm exec repo new sdk --template tsdown
 ```
 

package/templates/vitepress/zh/reference/commands.md

@@ -79,9 +79,9 @@ repo templates --markdown --out docs/templates.md
 ```bash
 repo new
 repo new sdk --template tsdown
-repo new docs --template vitepress
-repo new docs --template vitepress --dry-run
-repo new docs --template vitepress --json --out plans/docs.json
+repo new docs --template nimbus
+repo new docs --template nimbus --dry-run
+repo new docs --template nimbus --json --out plans/docs.json
 ```
 
 用途：

package/templates/vitepress/zh/reference/execution-model.md

@@ -61,7 +61,7 @@ repoctl 的失败状态遵循阻塞优先：
 如果只是想知道会发生什么，先加 `--dry-run` 或输出计划：
 
 ```bash
-repo new docs --template vitepress --json --out plans/docs.json
+repo new docs --template nimbus --json --out plans/docs.json
 repo check --markdown --out reports/check-plan.md
 ```
 

package/templates/vitepress/zh/reference/template-assets.md

@@ -15,6 +15,7 @@ repoctl 的模板能力不只是复制目录。它会把模板元数据、默认
 | `hono-server` | `templates/server`    | `apps/server`      | Hono service          |
 | `vue-hono`    | `templates/client`    | `apps/client`      | Vue + Hono app        |
 | `vitepress`   | `templates/vitepress` | `apps/website`     | docs site             |
+| `nimbus`      | `templates/nimbus`    | `apps/docs`        | default docs site     |
 | `cli`         | `templates/cli`       | `apps/cli`         | command line tool     |
 
 查看实际可用模板：
@@ -42,8 +43,8 @@ repo templates --markdown --out docs/templates.md
 预览创建：
 
 ```bash
-repo new docs --template vitepress --dry-run
-repo new docs --template vitepress --json --out plans/docs.json
+repo new docs --template nimbus --dry-run
+repo new docs --template nimbus --json --out plans/docs.json
 ```
 
 `--json` 和 `--out` 都隐含 `--dry-run`，不会写入文件。

package/templates/vitepress/zh/reference/templates.md

@@ -6,14 +6,17 @@ repoctl 的模板由 `@icebreakers/monorepo-templates` 维护。CLI、脚手架
 
 ## 内置模板
 
-| Key           | Category | 默认目录           | 适合场景                    |
-| ------------- | -------- | ------------------ | --------------------------- |
-| `tsdown`      | library  | `packages/tsdown`  | TypeScript 库包             |
-| `vue-lib`     | library  | `packages/vue-lib` | Vue 3 组件库                |
-| `vue-hono`    | app      | `apps/client`      | Vue 3 + Hono 前后端一体应用 |
-| `hono-server` | service  | `apps/server`      | Hono API 服务               |
-| `vitepress`   | docs     | `apps/website`     | VitePress 文档站            |
-| `cli`         | tool     | `apps/cli`         | TypeScript 命令行工具       |
+| Key           | Category | 默认目录           | 适合场景                         |
+| ------------- | -------- | ------------------ | -------------------------------- |
+| `tsdown`      | library  | `packages/tsdown`  | TypeScript 库包                  |
+| `vue-lib`     | library  | `packages/vue-lib` | Vue 3 组件库                     |
+| `vue-hono`    | app      | `apps/client`      | Vue 3 + Hono 前后端一体应用      |
+| `hono-server` | service  | `apps/server`      | Hono API 服务                    |
+| `vitepress`   | docs     | `apps/website`     | VitePress 文档站                 |
+| `nimbus`      | docs     | `apps/docs`        | Nimbus + Astro，默认中英双语文档 |
+| `cli`         | tool     | `apps/cli`         | TypeScript 命令行工具            |
+
+Nimbus 是新建文档站点（`Docs Site`）的默认模板，提供英文 `/`、中文 `/zh/`、搜索和 AI 文档入口。VitePress 仍可显式选择，两者分别生成到 `apps/docs` 和 `apps/website`，可以同时使用。通用创建命令仍默认使用 `tsdown`；项目名称 `docs` 不会隐式改变模板。非交互调用请显式指定 `--template nimbus`。
 
 ## 查看模板
 
@@ -31,6 +34,7 @@ repo templates --markdown --out docs/templates.md
 repo new sdk --template tsdown
 repo new ui --template vue-lib
 repo new api --template hono-server
+repo new docs --template nimbus
 repo new website --template vitepress
 repo new toolbox --template cli
 ```
@@ -87,7 +91,7 @@ repo new api --template hono-server
 ### 要创建文档站
 
 ```bash
-repo new docs --template vitepress
+repo new docs --template nimbus
 ```
 
 生成后先检查：

package/templates/vitepress/zh/tasks/index.md

@@ -36,7 +36,7 @@ pnpm exec repo doctor --markdown --redact --out reports/doctor-after.md
 ```bash
 pnpm exec repo templates
 pnpm exec repo new sdk --template tsdown
-pnpm exec repo new docs --template vitepress --dry-run
+pnpm exec repo new docs --template nimbus --dry-run
 ```
 
 如果只是日常开发，根脚本也可以：

package/templates/vitepress/zh/tasks/reports.md

@@ -94,7 +94,7 @@ JSON 适合机器判断，不适合人工长时间阅读：
 ```bash
 repo doctor --json --out reports/doctor.json
 repo templates --check --json --out reports/templates.json
-repo new docs --template vitepress --json --out plans/docs.json
+repo new docs --template nimbus --json --out plans/docs.json
 ```
 
 常见消费方式：