@icebreakers/monorepo-templates 2.0.7 → 2.2.0

package/templates/react-lib/tsconfig.node.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "types": ["node"],
+    "verbatimModuleSyntax": true
+  },
+  "include": ["vite.config.ts", "vitest.config.ts"]
+}

package/templates/react-lib/vite.config.ts

@@ -0,0 +1,22 @@
+import path from 'node:path'
+import react from '@vitejs/plugin-react'
+import { defineConfig } from 'vite'
+import dts from 'vite-plugin-dts'
+
+export default defineConfig({
+  plugins: [react(), dts({ tsconfigPath: './tsconfig.build.json', entryRoot: './src', clearPureImport: true })],
+  build: {
+    lib: {
+      entry: path.resolve(import.meta.dirname, 'src/index.ts'),
+      formats: ['es'],
+      fileName: 'index',
+      cssFileName: 'style',
+    },
+    rolldownOptions: {
+      // Include JSX runtimes and every peer subpath in the external boundary.
+      external: id => /^(?:react|react-dom)(?:\/|$)/u.test(id),
+      // Counter is a client component; preserve its boundary in bundled RSC consumers.
+      output: { banner: '\'use client\';' },
+    },
+  },
+})

package/templates/react-lib/vitest.config.ts

@@ -0,0 +1,5 @@
+import { defineVitestProjectConfig } from 'repoctl/tooling'
+
+export default await defineVitestProjectConfig({
+  options: { environment: 'jsdom' },
+})

package/templates/react-vite/README.md

@@ -0,0 +1,27 @@
+# React application
+
+A small React and TypeScript SPA built with Vite. It includes an accessible counter, a Vitest interaction test, and the workspace's shared ESLint and Stylelint configuration.
+
+From the workspace root, enable the declared package manager and install dependencies:
+
+```sh
+corepack enable
+pnpm install
+```
+
+Run these commands from this application directory:
+
+```sh
+pnpm dev
+pnpm build
+pnpm lint
+pnpm typecheck
+pnpm test
+pnpm preview
+```
+
+`build` creates `dist/`; `preview` serves that production output locally. `lint` checks both code and CSS. `typecheck` uses TypeScript project references for the app, tests, and Vite configuration.
+
+To consume another workspace package, add it as a `workspace:*` dependency, import its package name, and build its public output first. Running `pnpm build` at the workspace root lets Turbo order dependency builds. Do not import another package's `src/` directory.
+
+Router, state management, backend, and CSS framework choices are left to your application.

package/templates/react-vite/eslint.config.js

@@ -0,0 +1,5 @@
+import { defineEslintConfig } from 'repoctl/tooling'
+
+export default await defineEslintConfig({
+  options: { react: true, typescript: true },
+})

package/templates/react-vite/gitignore

@@ -0,0 +1,6 @@
+node_modules
+dist
+coverage
+*.tsbuildinfo
+.env.local
+.env.*.local

package/templates/react-vite/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta name="description" content="A small React application, ready to make your own." />
+    <title>React workspace</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/templates/react-vite/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@icebreakers/react-vite-template",
+  "type": "module",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Internal React, Vite and TypeScript application template shipped with repoctl",
+  "license": "MIT",
+  "engines": {
+    "node": ">=22.13.0"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "lint": "eslint . && stylelint \"src/**/*.css\"",
+    "lint:fix": "eslint . --fix && stylelint \"src/**/*.css\" --fix",
+    "typecheck": "tsc -b",
+    "test": "vitest run",
+    "test:dev": "vitest"
+  },
+  "dependencies": {
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0"
+  },
+  "devDependencies": {
+    "@testing-library/dom": "^10.4.2",
+    "@testing-library/react": "^16.3.3",
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "@vitejs/plugin-react": "^6.1.1",
+    "jsdom": "^30.1.1",
+    "typescript": "~6.0.3",
+    "vite": "^8.3.2",
+    "vitest": "~5.0.3"
+  }
+}

package/templates/react-vite/src/app.tsx

@@ -0,0 +1,22 @@
+import { useState } from 'react'
+
+export default function App() {
+  const [count, setCount] = useState(0)
+
+  return (
+    <main>
+      <p className="eyebrow">Your next idea starts here</p>
+      <h1>Make something useful.</h1>
+      <p className="intro">A small React workspace with room to grow.</p>
+      <section className="counter" aria-labelledby="counter-title">
+        <h2 id="counter-title">Try an interaction</h2>
+        <output aria-label="Count" aria-live="polite">{count}</output>
+        <div className="actions">
+          <button type="button" onClick={() => setCount(value => value + 1)}>Add one</button>
+          <button type="button" className="secondary" disabled={count === 0} onClick={() => setCount(0)}>Reset</button>
+        </div>
+      </section>
+      <p className="footnote">Built with React, TypeScript, and Vite.</p>
+    </main>
+  )
+}

package/templates/react-vite/src/main.tsx

@@ -0,0 +1,15 @@
+import { StrictMode } from 'react'
+import { createRoot } from 'react-dom/client'
+import App from './app'
+import './style.css'
+
+const container = document.getElementById('root')
+if (!container) {
+  throw new Error('The application root element is missing.')
+}
+
+createRoot(container).render(
+  <StrictMode>
+    <App />
+  </StrictMode>,
+)

package/templates/react-vite/src/style.css

@@ -0,0 +1,95 @@
+:root {
+  font-family: system-ui, sans-serif;
+  font-synthesis: none;
+  color: #203834;
+  background: #f5f4ee;
+  text-rendering: optimizelegibility;
+  -webkit-font-smoothing: antialiased;
+}
+
+* {
+  box-sizing: border-box;
+}
+
+body {
+  min-width: 320px;
+  margin: 0;
+}
+
+main {
+  max-width: 760px;
+  padding: clamp(32px, 10vw, 96px) 24px;
+  margin: 0 auto;
+}
+
+.eyebrow,
+.footnote {
+  font-size: 14px;
+  color: #53655f;
+}
+
+h1 {
+  max-width: 600px;
+  margin: 24px 0;
+  font-size: clamp(40px, 8vw, 72px);
+  line-height: 1.05;
+  letter-spacing: -0.045em;
+}
+
+.intro {
+  font-size: 18px;
+  line-height: 1.6;
+}
+
+.counter {
+  padding: 28px;
+  margin: 40px 0 28px;
+  background: #fffefa;
+  border: 1px solid #c9d3ca;
+  border-radius: 12px;
+}
+
+h2 {
+  margin: 0;
+  font-size: 18px;
+  font-weight: 500;
+}
+
+output {
+  display: block;
+  margin: 16px 0;
+  font-size: 64px;
+  font-variant-numeric: tabular-nums;
+}
+
+.actions {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 12px;
+}
+
+button {
+  min-height: 44px;
+  padding: 10px 20px;
+  font: inherit;
+  color: #fff;
+  cursor: pointer;
+  background: #245e50;
+  border: 1px solid #245e50;
+  border-radius: 6px;
+}
+
+button.secondary {
+  color: #245e50;
+  background: transparent;
+}
+
+button:focus-visible {
+  outline: 3px solid #ba5a20;
+  outline-offset: 4px;
+}
+
+button:disabled {
+  cursor: default;
+  opacity: 0.5;
+}

package/templates/react-vite/stylelint.config.js

@@ -0,0 +1,3 @@
+import { defineStylelintConfig } from 'repoctl/tooling'
+
+export default await defineStylelintConfig()

package/templates/react-vite/test/app.test.tsx

@@ -0,0 +1,22 @@
+import { cleanup, fireEvent, render, screen } from '@testing-library/react'
+import { afterEach, expect, it } from 'vitest'
+import App from '../src/app'
+
+afterEach(cleanup)
+
+it('increments the count and resets it to zero', () => {
+  render(<App />)
+  const count = screen.getByLabelText('Count')
+  const reset = screen.getByRole('button', { name: 'Reset' })
+  expect(count.textContent).toBe('0')
+  expect(reset.hasAttribute('disabled')).toBe(true)
+
+  fireEvent.click(screen.getByRole('button', { name: 'Add one' }))
+  fireEvent.click(screen.getByRole('button', { name: 'Add one' }))
+  expect(count.textContent).toBe('2')
+  expect(reset.hasAttribute('disabled')).toBe(false)
+
+  fireEvent.click(reset)
+  expect(count.textContent).toBe('0')
+  expect(reset.hasAttribute('disabled')).toBe(true)
+})

package/templates/react-vite/tsconfig.app.json

@@ -0,0 +1,26 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "target": "ES2022",
+    "jsx": "react-jsx",
+    "lib": [
+      "ES2022",
+      "DOM",
+      "DOM.Iterable"
+    ],
+    "types": [
+      "vite/client"
+    ],
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "verbatimModuleSyntax": true,
+    "erasableSyntaxOnly": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": [
+    "src",
+    "test"
+  ]
+}

package/templates/react-vite/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "references": [
+    {
+      "path": "./tsconfig.app.json"
+    },
+    {
+      "path": "./tsconfig.node.json"
+    }
+  ],
+  "files": []
+}

package/templates/react-vite/tsconfig.node.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "target": "ES2023",
+    "lib": [
+      "ES2023"
+    ],
+    "types": [
+      "node"
+    ],
+    "verbatimModuleSyntax": true
+  },
+  "include": [
+    "vite.config.ts",
+    "vitest.config.ts"
+  ]
+}

package/templates/react-vite/vite.config.ts

@@ -0,0 +1,6 @@
+import react from '@vitejs/plugin-react'
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  plugins: [react()],
+})

package/templates/react-vite/vitest.config.ts

@@ -0,0 +1,9 @@
+import react from '@vitejs/plugin-react'
+import { defineVitestProjectConfig } from 'repoctl/tooling'
+import { mergeConfig } from 'vitest/config'
+
+export default mergeConfig(await defineVitestProjectConfig({
+  options: { environment: 'jsdom' },
+}), {
+  plugins: [react()],
+})

package/templates/server/package.json

@@ -66,7 +66,7 @@
   "devDependencies": {
     "@hono/node-server": "^2.1.3",
     "consola": "^3.4.2",
-    "hono": "^4.13.11",
+    "hono": "^4.13.12",
     "tsdown": "0.23.0",
     "wrangler": "^4.135.0",
     "zod": "^4.6.5"

package/templates/vitepress/.vitepress/config.ts

@@ -1,11 +1,11 @@
 import Tailwindcss from '@tailwindcss/vite'
 import { defineConfig } from 'vitepress'
 import llmstxt from 'vitepress-plugin-llms'
-import { withMermaid } from 'vitepress-plugin-mermaid'
+import { mermaidMarkdown } from './mermaid/markdown'
 import { createNav, createSidebars } from './navigation/routes'
 import { createPageHead, siteOrigin } from './seo'
 
-export default withMermaid(defineConfig({
+export default defineConfig({
   outDir: '.vitepress/dist',
   srcExclude: ['CHANGELOG.md', 'learn/packages/examples/**', 'zh/learn/packages/examples/**'],
   title: 'repoctl',
@@ -69,7 +69,6 @@ export default withMermaid(defineConfig({
   },
   vite: {
     plugins: [
-      // @ts-ignore vitepress-plugin-llms currently exposes Vite 6 plugin types.
       Tailwindcss(),
       llmstxt({
         title: 'repoctl',
@@ -89,5 +88,5 @@ export default withMermaid(defineConfig({
       }),
     ],
   },
-  mermaid: {},
-}))
+  markdown: { config: mermaidMarkdown },
+})

package/templates/vitepress/.vitepress/home/content.ts

@@ -32,7 +32,7 @@ const english = {
   evidence: {
     title: 'See the plan before the repository changes',
     description: 'Preview work, redact local paths, and keep the exact command sequence with the report.',
-    code: 'pnpm exec repo new docs --template vitepress --dry-run\npnpm exec repo check --dry-run\npnpm exec repo doctor --markdown --redact',
+    code: 'pnpm exec repo new docs --template nimbus --dry-run\npnpm exec repo check --dry-run\npnpm exec repo doctor --markdown --redact',
     link: { label: 'See how diagnosis works', href: '/start/diagnose' },
   },
   layers: {
@@ -77,7 +77,7 @@ const chinese = {
   evidence: {
     title: '仓库变化前，先看清执行计划',
     description: '预览操作、脱敏本地路径，并让报告保留准确的命令顺序。',
-    code: 'pnpm exec repo new docs --template vitepress --dry-run\npnpm exec repo check --dry-run\npnpm exec repo doctor --markdown --redact',
+    code: 'pnpm exec repo new docs --template nimbus --dry-run\npnpm exec repo check --dry-run\npnpm exec repo doctor --markdown --redact',
     link: { label: '了解诊断流程', href: '/zh/start/diagnose' },
   },
   layers: {

package/templates/vitepress/.vitepress/home/faq.ts

@@ -0,0 +1,16 @@
+import type { DocsLocale } from '../navigation/routes'
+
+export const faqContent = {
+  zh: [
+    ['repoctl 是什么？', 'repoctl 是面向 pnpm 与 Turborepo monorepo 的任务型 CLI，用于初始化、诊断、创建、校验和发布工作区。'],
+    ['如何安装 repoctl？', '在项目中运行 pnpm add -D repoctl，然后使用 pnpm exec repo init 和 pnpm exec repo doctor。'],
+    ['repoctl 与 pnpm、Turborepo 是什么关系？', 'pnpm 和 Turborepo 负责包管理与任务编排，repoctl 负责把团队约定、检查和日常操作组织成可复用任务。'],
+    ['repo doctor 与 repo check 有什么区别？', 'repo doctor 诊断仓库健康状况，repo check 规划并执行 lint、类型、构建和测试校验。'],
+  ],
+  en: [
+    ['What is repoctl?', 'repoctl is a task-first CLI for initializing, diagnosing, creating, checking, and releasing pnpm and Turborepo monorepos.'],
+    ['How do I install repoctl?', 'Run pnpm add -D repoctl, then use pnpm exec repo init and pnpm exec repo doctor.'],
+    ['How does repoctl relate to pnpm and Turborepo?', 'pnpm and Turborepo provide package management and task orchestration; repoctl turns repository conventions and checks into reusable tasks.'],
+    ['What is the difference between repo doctor and repo check?', 'repo doctor diagnoses repository health, while repo check plans and runs lint, type, build, and test checks.'],
+  ],
+} satisfies Record<DocsLocale, [string, string][]>

package/templates/vitepress/.vitepress/mermaid/markdown.ts

@@ -0,0 +1,18 @@
+import type { MarkdownRenderer } from 'vitepress'
+
+export function mermaidMarkdown(md: MarkdownRenderer) {
+  const fence = md.renderer.rules.fence!
+  md.renderer.rules.fence = (tokens, index, options, env, renderer) => {
+    const token = tokens[index]!
+    const language = token.info.trim()
+    if (language === 'mermaid') {
+      const graph = md.utils.escapeHtml(encodeURIComponent(token.content))
+      return `<Mermaid graph="${graph}" />\n`
+    }
+    // Keep the old plugin's escape hatch for displaying Mermaid source code.
+    if (language === 'mmd') {
+      token.info = 'mermaid'
+    }
+    return fence(tokens, index, options, env, renderer)
+  }
+}

package/templates/vitepress/.vitepress/mermaid/mermaid.vue

@@ -0,0 +1,66 @@
+<script setup lang="ts">
+import { useData } from 'vitepress'
+import { computed, onMounted, ref, watch } from 'vue'
+import { renderMermaid, resolveMermaidTheme } from './render'
+
+const props = defineProps<{ graph: string }>()
+const { frontmatter, isDark, lang } = useData()
+const mounted = ref(false)
+const diagram = ref<HTMLElement>()
+const error = ref('')
+const loading = ref(true)
+const theme = computed(() => resolveMermaidTheme(isDark.value, frontmatter.value.mermaidTheme))
+
+onMounted(() => {
+  mounted.value = true
+})
+
+watch([mounted, () => props.graph, theme], async ([ready, graph, selectedTheme], _, onCleanup) => {
+  if (!ready || !diagram.value) {
+    return
+  }
+  let active = true
+  onCleanup(() => {
+    active = false
+  })
+  error.value = ''
+  loading.value = true
+  diagram.value.replaceChildren()
+  try {
+    const result = await renderMermaid(decodeURIComponent(graph), selectedTheme)
+    if (active && diagram.value) {
+      // Mermaid sanitizes SVG using its strict security mode.
+      diagram.value.innerHTML = result.svg
+      result.bindFunctions?.(diagram.value)
+    }
+  }
+  catch (cause) {
+    if (active) {
+      error.value = cause instanceof Error ? cause.message : String(cause)
+    }
+  }
+  finally {
+    if (active) {
+      loading.value = false
+    }
+  }
+}, { flush: 'post' })
+</script>
+
+<template>
+  <div class="mermaid" :aria-busy="loading">
+    <p v-if="loading" role="status">
+      {{ lang === 'zh-CN' ? '正在绘制图表…' : 'Rendering diagram…' }}
+    </p>
+    <p v-if="error" role="alert">
+      {{ lang === 'zh-CN' ? '图表绘制失败：' : 'Unable to render diagram: ' }}{{ error }}
+    </p>
+    <div ref="diagram" class="mermaid__diagram" />
+  </div>
+</template>
+
+<style scoped>
+.mermaid__diagram {
+  overflow-x: auto;
+}
+</style>

package/templates/vitepress/.vitepress/mermaid/render.ts

@@ -0,0 +1,37 @@
+import type { MermaidConfig, RenderResult } from 'mermaid'
+
+let pending: Promise<unknown> = Promise.resolve()
+let sequence = 0
+
+export type MermaidTheme = NonNullable<MermaidConfig['theme']>
+const themes: readonly MermaidTheme[] = ['base', 'dark', 'default', 'forest', 'neutral', 'neo', 'neo-dark', 'redux', 'redux-dark', 'redux-color', 'redux-dark-color', 'null']
+
+export function resolveMermaidTheme(dark: boolean, theme: unknown): MermaidTheme {
+  if (dark) {
+    return 'dark'
+  }
+  return typeof theme === 'string' && themes.includes(theme as MermaidTheme)
+    ? theme as MermaidTheme
+    : 'default'
+}
+
+export function renderMermaid(source: string, theme: MermaidTheme): Promise<RenderResult> {
+  // initialize() changes global state, so it must share the render queue.
+  const result = pending.then(async () => {
+    const { default: mermaid } = await import('mermaid')
+    const container = document.createElement('div')
+    container.setAttribute('aria-hidden', 'true')
+    container.style.cssText = 'position:absolute;left:-10000px;top:0;'
+    document.body.append(container)
+    try {
+      mermaid.initialize({ startOnLoad: false, securityLevel: 'strict', suppressErrorRendering: true, theme })
+      return await mermaid.render(`repoctl-mermaid-${++sequence}`, source, container)
+    }
+    finally {
+      container.remove()
+    }
+  })
+  // A malformed diagram must not block later diagrams.
+  pending = result.catch(() => {})
+  return result
+}

package/templates/vitepress/.vitepress/navigation/routes.ts

@@ -52,7 +52,14 @@ export const routeSections = [
     items: [
       item('', 'Reference overview', '参考总览'),
       item('commands', 'Command reference', '命令参考'),
+      item('devcontainer', 'Dev Container preset', 'Dev Container 预设'),
       item('config', 'Configuration', '配置文件'),
+      item('organization-presets', 'Organization presets', '组织工程预设'),
+      item('dependencies', 'Dependency consistency', '依赖版本一致性'),
+      item('knip', 'Unused code and dependencies', '闲置代码与依赖检查'),
+      item('artifacts', 'Build and production artifacts', '构建与生产产物'),
+      item('move', 'Move or rename a workspace', '移动或重命名工作区'),
+      item('removal', 'Remove a workspace safely', '安全移除工作区'),
       item('execution-model', 'Execution model', '执行模型'),
       item('output', 'Output formats', '输出格式'),
       item('aliases', 'Command aliases', '命令别名'),

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

@@ -1,4 +1,5 @@
 import type { HeadConfig, TransformContext } from 'vitepress'
+import { faqContent } from './home/faq'
 
 export const siteOrigin = 'https://repoctl.icebreaker.top'
 
@@ -35,6 +36,16 @@ export function createPageHead({ page, title, description }: TransformContext):
       { '@type': 'Organization', 'name': 'repoctl', 'url': siteOrigin, 'logo': `${siteOrigin}/brand/repoctl-mark.svg`, 'sameAs': ['https://github.com/icelib/repoctl', 'https://www.npmjs.com/package/repoctl'] },
       { '@type': 'SoftwareApplication', 'name': 'repoctl', 'applicationCategory': 'DeveloperApplication', 'operatingSystem': 'macOS, Linux, Windows', 'url': siteOrigin, description, 'sameAs': ['https://github.com/icelib/repoctl', 'https://www.npmjs.com/package/repoctl'], 'offers': { '@type': 'Offer', 'price': '0', 'priceCurrency': 'USD' } },
       { '@type': 'WebSite', 'name': 'repoctl', 'url': siteOrigin, 'potentialAction': { '@type': 'SearchAction', 'target': `${siteOrigin}/reference/commands?q={search_term_string}`, 'query-input': 'required name=search_term_string' } },
+      ...(page === 'index.md' || page === 'zh/index.md'
+        ? [{
+            '@type': 'FAQPage',
+            'mainEntity': faqContent[isChinese ? 'zh' : 'en'].map(([name, text]) => ({
+              '@type': 'Question',
+              name,
+              'acceptedAnswer': { '@type': 'Answer', text },
+            })),
+          }]
+        : []),
     ],
   }
 
@@ -61,6 +72,6 @@ export function createPageHead({ page, title, description }: TransformContext):
     ['meta', { name: 'twitter:description', content: description }],
     ['meta', { name: 'twitter:image', content: socialImage }],
     ['meta', { name: 'twitter:image:alt', content: socialImageAlt }],
-    ['script', { type: 'application/ld+json' }, JSON.stringify(jsonLd)],
+    ['script', { type: 'application/ld+json' }, JSON.stringify(jsonLd).replace(/</g, '\\u003c')],
   ]
 }