@icebreakers/monorepo-templates 1.0.2 → 1.0.3

package/dist/prepare-CtCifHGT.mjs

@@ -0,0 +1,306 @@
+import * as path$1 from "node:path";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import fs from "node:fs/promises";
+//#region assets-data.mjs
+const coreAssetTargets = [
+	".changeset",
+	".husky",
+	".vscode",
+	".editorconfig",
+	".gitattributes",
+	".gitignore",
+	".npmrc",
+	"commitlint.config.ts",
+	"eslint.config.js",
+	"lint-staged.config.js",
+	"stylelint.config.js",
+	"repoctl.config.ts",
+	"package.json",
+	"AGENTS.md",
+	"pnpm-workspace.yaml",
+	"tsconfig.json",
+	"turbo.json",
+	"vitest.config.ts",
+	"Dockerfile",
+	".dockerignore"
+];
+const extraAssetTargets = [
+	".github",
+	"LICENSE",
+	"renovate.json",
+	"SECURITY.md",
+	"CODE_OF_CONDUCT.md",
+	"CONTRIBUTING.md",
+	"netlify.toml"
+];
+const assetTargets = [...coreAssetTargets, ...extraAssetTargets];
+function getAssetTargets(core = false) {
+	return core ? [...coreAssetTargets] : [...assetTargets];
+}
+//#endregion
+//#region src/paths.ts
+const packageDir = path$1.resolve(fileURLToPath(new URL("../", import.meta.url)));
+const templatesDir = path$1.join(packageDir, "templates");
+const assetsDir = path$1.join(packageDir, "assets");
+const skeletonDir = assetsDir;
+//#endregion
+//#region template-data.mjs
+const templateChoices = [
+	{
+		key: "tsdown",
+		label: "tsdown 打包",
+		source: "tsdown",
+		target: "packages/tsdown",
+		category: "library",
+		description: "使用 tsdown 构建的 TypeScript 库包"
+	},
+	{
+		key: "vue-lib",
+		label: "vue 组件",
+		source: "vue-lib",
+		target: "packages/vue-lib",
+		category: "library",
+		description: "Vue 3 组件库模板，适合沉淀可复用 UI"
+	},
+	{
+		key: "vue-hono",
+		label: "vue hono 全栈",
+		source: "client",
+		target: "apps/client",
+		category: "app",
+		description: "Vue 3 + Hono 的前后端一体应用模板"
+	},
+	{
+		key: "hono-server",
+		label: "hono 模板",
+		source: "server",
+		target: "apps/server",
+		category: "service",
+		description: "Hono API 服务模板"
+	},
+	{
+		key: "vitepress",
+		label: "vitepress 文档",
+		source: "vitepress",
+		target: "apps/website",
+		category: "docs",
+		description: "VitePress 文档站模板"
+	},
+	{
+		key: "cli",
+		label: "cli 模板",
+		source: "cli",
+		target: "apps/cli",
+		category: "tool",
+		description: "TypeScript 命令行工具模板"
+	}
+];
+//#endregion
+//#region src/utils/gitignore.ts
+const publishBasename = "gitignore";
+const workspaceBasename = ".gitignore";
+const normalizedPathPattern = /[\\/]/;
+function detectSeparator(input) {
+	if (input.includes("\\") && !input.includes("/")) return "\\";
+	return "/";
+}
+function replaceBasename(input, from, to) {
+	if (!input) return input;
+	const separator = detectSeparator(input);
+	const normalized = input.replace(normalizedPathPattern, separator);
+	const hasTrailingSeparator = normalized.endsWith(separator);
+	const segments = normalized.split(separator);
+	if (hasTrailingSeparator && segments.at(-1) === "") segments.pop();
+	const lastIndex = segments.length - 1;
+	if (lastIndex >= 0 && segments[lastIndex] === from) {
+		segments[lastIndex] = to;
+		const rebuilt = segments.join(separator);
+		return hasTrailingSeparator ? `${rebuilt}${separator}` : rebuilt;
+	}
+	return input;
+}
+function toPublishGitignorePath(input) {
+	return replaceBasename(input, workspaceBasename, publishBasename);
+}
+function toWorkspaceGitignorePath(input) {
+	return replaceBasename(input, publishBasename, workspaceBasename);
+}
+function isGitignoreFile(name) {
+	return toPublishGitignorePath(name) !== name || toWorkspaceGitignorePath(name) !== name;
+}
+//#endregion
+//#region src/utils/template-filter.ts
+const skipDirs = new Set([
+	"node_modules",
+	"dist",
+	".turbo",
+	".cache",
+	".vite",
+	".tmp",
+	".vue-global-types",
+	".wrangler"
+]);
+const skipFiles = new Set([
+	".DS_Store",
+	"CHANGELOG.md",
+	"route-map.d.ts"
+]);
+function shouldSkipTemplatePath(rootDir, targetPath) {
+	const basename = path.basename(targetPath);
+	if (skipFiles.has(basename)) return true;
+	if (basename.endsWith(".tsbuildinfo")) return true;
+	if (/\.timestamp-\d+-[a-z0-9]+\.mjs$/i.test(basename)) return true;
+	const relative = path.relative(rootDir, targetPath);
+	if (!relative || relative.startsWith("..")) return false;
+	const segments = relative.split(path.sep);
+	if (segments.some((segment) => skipDirs.has(segment))) return true;
+	for (let i = 0; i < segments.length - 1; i += 1) if (segments[i] === ".vitepress" && segments[i + 1] === "cache") return true;
+	return false;
+}
+function createTemplateCopyFilter(rootDir) {
+	return (src) => !shouldSkipTemplatePath(rootDir, src);
+}
+//#endregion
+//#region src/prepare.ts
+const huskySkippedEntryPattern = /[\\/]_$/;
+const publishedToolingConfigs = {
+	"commitlint.config.ts": [
+		`import { defineCommitlintConfig } from 'repoctl/tooling'`,
+		"",
+		"export default await defineCommitlintConfig()",
+		""
+	].join("\n"),
+	"eslint.config.js": [
+		`import { defineEslintConfig } from 'repoctl/tooling'`,
+		"",
+		"export default await defineEslintConfig()",
+		""
+	].join("\n"),
+	"lint-staged.config.js": [
+		`import { defineLintStagedConfig } from 'repoctl/tooling'`,
+		"",
+		"export default await defineLintStagedConfig()",
+		""
+	].join("\n"),
+	"stylelint.config.js": [
+		`import { defineStylelintConfig } from 'repoctl/tooling'`,
+		"",
+		"export default await defineStylelintConfig()",
+		""
+	].join("\n"),
+	"vitest.config.ts": [
+		`import { defineConfig } from 'vitest/config'`,
+		`import { defineVitestConfig } from 'repoctl/tooling'`,
+		"",
+		"export default defineConfig(async () => await defineVitestConfig())",
+		""
+	].join("\n")
+};
+async function pathExists(targetPath) {
+	try {
+		await fs.access(targetPath);
+		return true;
+	} catch {
+		return false;
+	}
+}
+async function renameGitignoreFiles(targetDir) {
+	let entries;
+	try {
+		entries = await fs.readdir(targetDir, { withFileTypes: true });
+	} catch (error) {
+		if (error.code === "ENOENT") return;
+		throw error;
+	}
+	await Promise.all(entries.map(async (entry) => {
+		const current = path$1.join(targetDir, entry.name);
+		if (entry.isDirectory()) {
+			await renameGitignoreFiles(current);
+			return;
+		}
+		const renamed = toPublishGitignorePath(entry.name);
+		if (renamed !== entry.name) await fs.rename(current, path$1.join(targetDir, renamed));
+	}));
+}
+async function resetDir(targetDir, overwriteExisting) {
+	if (!overwriteExisting && await pathExists(targetDir)) return;
+	try {
+		await fs.rm(targetDir, {
+			recursive: true,
+			force: true
+		});
+	} catch (error) {
+		const err = error;
+		if (err?.code !== "ENOTEMPTY" && err?.code !== "EBUSY" && err?.code !== "EPERM") throw error;
+	}
+	await fs.mkdir(targetDir, { recursive: true });
+}
+async function copyEntry(from, to, overwriteExisting, filter) {
+	if (!overwriteExisting && await pathExists(to)) {
+		const [fromStats, toStats] = await Promise.all([fs.stat(from), fs.stat(to)]);
+		if (fromStats.isDirectory() && toStats.isDirectory()) await fs.cp(from, to, {
+			recursive: true,
+			force: false,
+			errorOnExist: false,
+			filter
+		});
+		return;
+	}
+	try {
+		await fs.cp(from, to, {
+			recursive: true,
+			force: overwriteExisting,
+			filter
+		});
+	} catch (error) {
+		const err = error;
+		if (!overwriteExisting && (err?.code === "EEXIST" || err?.code === "ENOTEMPTY")) return;
+		throw error;
+	}
+}
+async function copyAssets(repoRoot, overwriteExisting) {
+	const monorepoAssetRoot = path$1.resolve(repoRoot, "packages/monorepo/assets");
+	for (const target of assetTargets) {
+		const packageAsset = path$1.join(monorepoAssetRoot, toPublishGitignorePath(target));
+		const repoAsset = path$1.join(repoRoot, target);
+		const from = await pathExists(repoAsset) ? repoAsset : packageAsset;
+		if (!await pathExists(from)) continue;
+		const to = path$1.join(assetsDir, toPublishGitignorePath(target));
+		const stats = await fs.stat(from);
+		await copyEntry(from, to, overwriteExisting, target === ".husky" ? (src) => !huskySkippedEntryPattern.test(src) : void 0);
+		if (target === "tsconfig.json") await fs.writeFile(to, `${JSON.stringify({
+			extends: "repoctl/tsconfig.json",
+			files: []
+		}, null, 2)}\n`);
+		if (stats.isDirectory()) await renameGitignoreFiles(to);
+	}
+}
+async function writePublishedToolingConfigs() {
+	await Promise.all(Object.entries(publishedToolingConfigs).map(async ([filename, content]) => {
+		const targetPath = path$1.join(assetsDir, filename);
+		if (await pathExists(targetPath)) await fs.writeFile(targetPath, content);
+	}));
+}
+async function copyTemplates(repoRoot, overwriteExisting) {
+	for (const template of templateChoices) {
+		const from = path$1.join(repoRoot, "templates", template.source);
+		if (!await pathExists(from)) continue;
+		const to = path$1.join(templatesDir, template.source);
+		const filter = (src) => !shouldSkipTemplatePath(from, src);
+		await copyEntry(from, to, overwriteExisting, filter);
+		await renameGitignoreFiles(to);
+	}
+}
+async function prepareAssets(options = {}) {
+	const overwriteExisting = options.overwriteExisting ?? true;
+	const repoRoot = path$1.resolve(packageDir, "..", "..");
+	if (!await pathExists(path$1.join(repoRoot, "templates"))) return;
+	await resetDir(assetsDir, overwriteExisting);
+	await resetDir(templatesDir, overwriteExisting);
+	await copyAssets(repoRoot, overwriteExisting);
+	await writePublishedToolingConfigs();
+	await copyTemplates(repoRoot, overwriteExisting);
+}
+//#endregion
+export { toPublishGitignorePath as a, assetsDir as c, templatesDir as d, assetTargets as f, isGitignoreFile as i, packageDir as l, createTemplateCopyFilter as n, toWorkspaceGitignorePath as o, getAssetTargets as p, shouldSkipTemplatePath as r, templateChoices as s, prepareAssets as t, skeletonDir as u };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@icebreakers/monorepo-templates",
   "type": "module",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Template assets for icebreaker monorepo scaffolding",
   "author": "ice breaker <hi@sonofmagic.top>",
   "license": "MIT",
@@ -57,7 +57,7 @@
     "build": "tsdown",
     "typecheck": "node ../../node_modules/typescript/bin/tsc -p tsconfig.json",
     "tsd": "pnpm build && tsd --files test-d/**/*.test-d.ts",
-    "sync:assets": "pnpm run build && node scripts/sync-assets.mjs",
+    "sync:assets": "pnpm run build && node dist/cli.mjs",
     "lint": "eslint ."
   }
 }

package/templates/client/package.json

@@ -26,7 +26,7 @@
     "tailwind-merge": "^3.5.0",
     "tailwind-variants": "^3.2.2",
     "vue": "^3.5.34",
-    "vue-i18n": "^11.4.0",
+    "vue-i18n": "^11.4.2",
     "vue-router": "^5.0.6"
   },
   "devDependencies": {

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

@@ -1,76 +1,157 @@
 import Tailwindcss from '@tailwindcss/vite'
 import { defineConfig } from 'vitepress'
 import { withMermaid } from 'vitepress-plugin-mermaid'
-// https://vitepress.dev/reference/site-config
+
+const repoctlSidebar = [
+  {
+    text: 'repoctl',
+    items: [
+      { text: '概览', link: '/repoctl/' },
+      { text: '快速开始', link: '/repoctl/getting-started' },
+      { text: '接入已有仓库', link: '/repoctl/adopt-existing' },
+      { text: '按场景选命令', link: '/repoctl/scenarios' },
+      { text: '命令速查', link: '/repoctl/commands' },
+      { text: '配置文件', link: '/repoctl/config' },
+      { text: '模板与创建', link: '/repoctl/templates' },
+      { text: '工作流与 CI', link: '/repoctl/workflows' },
+      { text: '排障与报告', link: '/repoctl/troubleshooting' },
+      { text: '命令别名', link: '/repoctl/aliases' },
+    ],
+  },
+  {
+    text: '知识库',
+    items: [
+      { text: '为什么往 monorepo 方向演进', link: '/monorepo/' },
+      { text: '如何管理 monorepo', link: '/monorepo/manage' },
+      { text: '发包与变更日志', link: '/monorepo/publish' },
+      { text: '如何复用 js 代码', link: '/why/how-to-reuse-js-code' },
+      { text: 'JS 文件的各种后缀', link: '/why/js-cjs-mjs' },
+      { text: 'CJS 和 ESM 关键字/全局变量对比', link: '/why/js-keywords' },
+      { text: '什么是 npm 包', link: '/why/what-is-npm-package' },
+      { text: '如何发布 npm 包', link: '/why/publish-basic-npm-package' },
+      { text: '改进并发布现代 npm 包', link: '/why/index' },
+    ],
+  },
+  {
+    text: '工具专题',
+    items: [
+      { text: 'pnpm', link: '/tools/pnpm' },
+      { text: 'turborepo', link: '/tools/turborepo' },
+      { text: 'changeset', link: '/tools/changeset' },
+      { text: 'husky', link: '/tools/husky' },
+      { text: 'lint-staged', link: '/tools/lint-staged' },
+      { text: 'renovate', link: '/tools/renovate' },
+    ],
+  },
+]
+
+const enSidebar = [
+  {
+    text: 'repoctl',
+    items: [
+      { text: 'Overview', link: '/en/repoctl/' },
+      { text: 'Getting Started', link: '/en/repoctl/getting-started' },
+      { text: 'Adopt Existing Repos', link: '/en/repoctl/adopt-existing' },
+      { text: 'Choose By Scenario', link: '/en/repoctl/scenarios' },
+      { text: 'Command Reference', link: '/en/repoctl/commands' },
+      { text: 'Configuration', link: '/en/repoctl/config' },
+      { text: 'Templates', link: '/en/repoctl/templates' },
+      { text: 'Workflows and CI', link: '/en/repoctl/workflows' },
+      { text: 'Troubleshooting', link: '/en/repoctl/troubleshooting' },
+      { text: 'Command Aliases', link: '/en/repoctl/aliases' },
+    ],
+  },
+  {
+    text: 'Knowledge Base',
+    items: [
+      { text: 'Why Monorepo', link: '/en/knowledge/monorepo' },
+    ],
+  },
+]
+
 export default withMermaid(defineConfig({
   outDir: '.vitepress/dist',
-  title: 'icebreaker\'s monorepo',
-  description: 'A practical pnpm + turbo monorepo template with short onboarding commands and repo tooling.',
+  title: 'repoctl',
+  description: 'repoctl documentation for practical pnpm and Turborepo monorepos.',
+  lastUpdated: true,
+  cleanUrls: true,
+  head: [
+    ['link', { rel: 'icon', href: '/logo.jpg' }],
+  ],
   themeConfig: {
-    // https://vitepress.dev/reference/default-theme-config
-    nav: [
-      { text: '开始使用', link: '/' },
-      { text: '新手指南', link: '/getting-started' },
-      { text: 'Monorepo', link: '/monorepo/' },
-      { text: '工具专题', link: '/tools/turborepo' },
-      { text: '一些思考', link: '/thinking' },
-    ],
+    logo: '/logo.jpg',
+    search: {
+      provider: 'local',
+    },
     socialLinks: [
       { icon: 'github', link: 'https://github.com/sonofmagic/monorepo-template' },
     ],
-    outline: {
-      label: '目录',
-      level: [2, 3],
-    },
-    logo: '/logo.jpg',
-    sidebar: {
-      '/': [
-        {
-          text: '开始使用',
-          items: [
-            { text: '首页', link: '/' },
-            { text: '新手使用指南', link: '/getting-started' },
-            { text: '一些思考', link: '/thinking' },
-          ],
+  },
+  locales: {
+    root: {
+      label: '简体中文',
+      lang: 'zh-CN',
+      title: 'repoctl',
+      description: '围绕 repoctl 的 pnpm + Turborepo monorepo 使用文档。',
+      themeConfig: {
+        nav: [
+          { text: 'repoctl', link: '/repoctl/' },
+          { text: '快速开始', link: '/repoctl/getting-started' },
+          { text: '命令', link: '/repoctl/commands' },
+          { text: '知识库', link: '/monorepo/' },
+          { text: '工具专题', link: '/tools/turborepo' },
+        ],
+        outline: {
+          label: '目录',
+          level: [2, 3],
+        },
+        sidebar: {
+          '/': repoctlSidebar,
         },
-        {
-          text: 'Monorepo',
-          items: [
-            { text: '为什么往 monorepo 方向演进', link: '/monorepo/' },
-            { text: '如何管理 monorepo', link: '/monorepo/manage' },
-            { text: '模板速查', link: '/monorepo/templates' },
-            { text: '命令速查', link: '/monorepo/commands' },
-            { text: '常见问题排障', link: '/monorepo/troubleshooting' },
-            { text: '发包与变更日志', link: '/monorepo/publish' },
-          ],
+        editLink: {
+          pattern: 'https://github.com/sonofmagic/monorepo-template/edit/main/templates/vitepress/:path',
+          text: '为此页提供修改建议',
         },
-        {
-          text: 'npm 与包',
-          items: [
-            { text: '如何复用 js 代码', link: '/why/how-to-reuse-js-code' },
-            { text: 'JS 文件的各种后缀', link: '/why/js-cjs-mjs' },
-            { text: 'CJS 和 ESM 关键字/全局变量对比', link: '/why/js-keywords' },
-            { text: '什么是 npm 包', link: '/why/what-is-npm-package' },
-            { text: '如何发布 npm 包', link: '/why/publish-basic-npm-package' },
-            { text: '改进并发布现代 npm 包', link: '/why/index' },
-          ],
+        docFooter: {
+          prev: '上一页',
+          next: '下一页',
         },
-        {
-          text: '相关的工具',
-          items: [
-            { text: 'pnpm', link: '/tools/pnpm' },
-            { text: 'turborepo', link: '/tools/turborepo' },
-            { text: 'changeset', link: '/tools/changeset' },
-            { text: 'husky', link: '/tools/husky' },
-            { text: 'lint-staged', link: '/tools/lint-staged' },
-            { text: 'renovate', link: '/tools/renovate' },
-          ],
+        lastUpdated: {
+          text: '最后更新',
         },
-      ],
+      },
     },
-    editLink: {
-      pattern: 'https://github.com/sonofmagic/monorepo-template/edit/main/templates/vitepress/:path',
-      text: '为此页提供修改建议',
+    en: {
+      label: 'English',
+      lang: 'en-US',
+      title: 'repoctl',
+      description: 'Documentation for using repoctl in practical pnpm and Turborepo monorepos.',
+      themeConfig: {
+        nav: [
+          { text: 'repoctl', link: '/en/repoctl/' },
+          { text: 'Getting Started', link: '/en/repoctl/getting-started' },
+          { text: 'Commands', link: '/en/repoctl/commands' },
+          { text: 'Knowledge Base', link: '/en/knowledge/monorepo' },
+        ],
+        outline: {
+          label: 'On This Page',
+          level: [2, 3],
+        },
+        sidebar: {
+          '/en/': enSidebar,
+        },
+        editLink: {
+          pattern: 'https://github.com/sonofmagic/monorepo-template/edit/main/templates/vitepress/:path',
+          text: 'Edit this page',
+        },
+        docFooter: {
+          prev: 'Previous page',
+          next: 'Next page',
+        },
+        lastUpdated: {
+          text: 'Last updated',
+        },
+      },
     },
   },
   vite: {
@@ -78,14 +159,6 @@ export default withMermaid(defineConfig({
       // @ts-ignore
       Tailwindcss(),
     ],
-    // server: {
-    //   hmr: {
-    //     overlay: false,
-    //   },
-    // },
-  },
-  mermaid: {
-
   },
-}),
-)
+  mermaid: {},
+}))

package/templates/vitepress/en/index.md

@@ -0,0 +1,57 @@
+---
+layout: home
+
+hero:
+  name: repoctl
+  text: Short, stable workflows for pnpm monorepos
+  tagline: Initialize, diagnose, scaffold, verify, and upgrade practical Turborepo workspaces from one CLI.
+  image:
+    src: /logo.jpg
+    alt: repoctl logo
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /en/repoctl/getting-started
+    - theme: alt
+      text: Commands
+      link: /en/repoctl/commands
+
+features:
+  - title: Adopt existing workspaces
+    details: Run setup and doctor to align workspace patterns, root scripts, config files, and commit hooks.
+  - title: Create packages and apps
+    details: Scaffold libraries, apps, services, docs, and CLIs with interactive prompts or explicit template keys.
+  - title: Make checks repeatable
+    details: Preview and run local verification plans that match your lint, typecheck, build, test, and tsd workflow.
+---
+
+## Fast Path
+
+```bash
+pnpm add -D repoctl
+pnpm exec repo setup
+pnpm exec repo doctor
+pnpm exec repo new
+pnpm exec repo check
+```
+
+Generated repositories expose the same workflow as shorter root scripts:
+
+```bash
+pnpm setup
+pnpm doctor
+pnpm new
+pnpm check
+```
+
+## Keep Reading
+
+- [repoctl Overview](./repoctl/index.md)
+- [Getting Started](./repoctl/getting-started.md)
+- [Adopt Existing Repositories](./repoctl/adopt-existing.md)
+- [Choose By Scenario](./repoctl/scenarios.md)
+- [Command Reference](./repoctl/commands.md)
+- [Configuration](./repoctl/config.md)
+- [Templates](./repoctl/templates.md)
+- [Workflows and CI](./repoctl/workflows.md)
+- [Knowledge Base: Why Monorepo](./knowledge/monorepo.md)

package/templates/vitepress/en/knowledge/monorepo.md

@@ -0,0 +1,37 @@
+# Why Monorepo
+
+This project uses monorepo practices because multiple packages, applications, CLIs, and docs sites usually share the same engineering rules.
+
+The goal is not to make the repository look more complex. The goal is to reduce repeated setup work.
+
+## Problems A Monorepo Solves
+
+### Shared Tooling
+
+In separate repositories, each package tends to maintain its own lint, typecheck, test, release, and commit setup. That makes upgrades slow and inconsistent.
+
+In a pnpm workspace, those rules can be centralized at the root and reused by every package.
+
+### Atomic Cross-Package Changes
+
+When one type change affects a library, an app, and a CLI, a monorepo lets you update, verify, review, and revert that change together.
+
+### Incremental Builds
+
+pnpm handles workspace dependencies. Turborepo coordinates tasks and caching. Together they make it practical to run build, lint, test, and typecheck flows across many packages.
+
+## Where repoctl Fits
+
+repoctl adds the missing workflow layer:
+
+- `repo setup` aligns root scripts and standard files.
+- `repo doctor` checks whether the workspace is ready.
+- `repo new` creates packages and apps from known templates.
+- `repo check` previews and runs local verification.
+- `repo upgrade` syncs standard assets as the template evolves.
+
+## Keep Reading
+
+- [repoctl Overview](../repoctl/index.md)
+- [Command Reference](../repoctl/commands.md)
+- [Templates](../repoctl/templates.md)