@icebreakers/monorepo-templates 0.1.1 → 0.1.2

package/assets/package.json

@@ -74,7 +74,7 @@
     "tslib": "^2.8.1",
     "tsup": "^8.5.1",
     "tsx": "^4.21.0",
-    "turbo": "^2.7.4",
+    "turbo": "^2.7.5",
     "type-fest": "^5.4.1",
     "typescript": "^5.9.3",
     "unbuild": "^3.6.1",

package/dist/index.d.mts

@@ -4,6 +4,18 @@ import input from "@inquirer/input";
 import select from "@inquirer/select";
 import { Command, program } from "commander";
 
+//#region src/types.d.ts
+interface TemplateChoice {
+  key: string;
+  label: string;
+  source: string;
+  target: string;
+}
+interface TemplateDefinition {
+  source: string;
+  target: string;
+}
+//#endregion
 //#region src/paths.d.ts
 declare const packageDir: string;
 declare const templatesDir: string;
@@ -17,6 +29,28 @@ interface PrepareAssetsOptions {
 }
 declare function prepareAssets(options?: PrepareAssetsOptions): Promise<void>;
 //#endregion
+//#region src/scaffold.d.ts
+type TargetMode = 'prepare' | 'ensure' | 'skip';
+interface ScaffoldTemplateOptions {
+  sourceDir: string;
+  targetDir: string;
+  ensureTargetDir?: boolean;
+  filter?: (src: string) => boolean;
+  renameEntry?: (name: string) => string;
+  skipRootBasenames?: string[];
+}
+interface ScaffoldWorkspaceOptions {
+  targetDir: string;
+  templateKeys?: string[];
+  assetsDir?: string;
+  templatesDir?: string;
+  includeAssets?: boolean;
+  targetMode?: TargetMode;
+  force?: boolean;
+}
+declare function scaffoldTemplate(options: ScaffoldTemplateOptions): Promise<void>;
+declare function scaffoldWorkspace(options: ScaffoldWorkspaceOptions): Promise<void>;
+//#endregion
 //#region src/utils/command.d.ts
 interface RunCommandOptions {
   cwd?: string;
@@ -33,12 +67,6 @@ declare function shouldSkipTemplatePath(rootDir: string, targetPath: string): bo
 declare function createTemplateCopyFilter(rootDir: string): (src: string) => boolean;
 //#endregion
 //#region src/index.d.ts
-interface TemplateChoice {
-  key: string;
-  label: string;
-  source: string;
-  target: string;
-}
 declare const templateChoices: TemplateChoice[];
 declare const assetTargets: string[];
 declare const getAssetTargets: (core?: boolean) => string[];
@@ -46,4 +74,4 @@ declare const templateSourceMap: Record<string, string>;
 declare const templateTargetMap: Record<string, string>;
 declare const templateMap: Record<string, string>;
 //#endregion
-export { Command, TemplateChoice, assetTargets, assetsDir, checkbox, createTemplateCopyFilter, execaCommand, getAssetTargets, input, isGitignoreFile, packageDir, prepareAssets, program, runCommand, select, shouldSkipTemplatePath, skeletonDir, templateChoices, templateMap, templateSourceMap, templateTargetMap, templatesDir, toPublishGitignorePath, toWorkspaceGitignorePath };
+export { Command, type TemplateChoice, type TemplateDefinition, assetTargets, assetsDir, checkbox, createTemplateCopyFilter, execaCommand, getAssetTargets, input, isGitignoreFile, packageDir, prepareAssets, program, runCommand, scaffoldTemplate, scaffoldWorkspace, select, shouldSkipTemplatePath, skeletonDir, templateChoices, templateMap, templateSourceMap, templateTargetMap, templatesDir, toPublishGitignorePath, toWorkspaceGitignorePath };

package/dist/index.mjs

@@ -151,6 +151,7 @@ const skipDirs = new Set([
 ]);
 const skipFiles = new Set([
 	".DS_Store",
+	"CHANGELOG.md",
 	"typed-router.d.ts",
 	"worker-configuration.d.ts"
 ]);
@@ -254,6 +255,84 @@ async function prepareAssets(options = {}) {
 	await copyTemplates(repoRoot, overwriteExisting);
 }
 
+//#endregion
+//#region src/scaffold.ts
+async function isEmptyDir(dir) {
+	try {
+		return (await fs.readdir(dir)).length === 0;
+	} catch (error) {
+		if (error && error.code === "ENOENT") return true;
+		throw error;
+	}
+}
+async function prepareTargetDir(dir, options = {}) {
+	if (await isEmptyDir(dir)) {
+		await fs.mkdir(dir, { recursive: true });
+		return;
+	}
+	if (!options.force) throw new Error(`Target directory ${dir} is not empty. Pass --force to overwrite.`);
+	await fs.rm(dir, {
+		recursive: true,
+		force: true
+	});
+	await fs.mkdir(dir, { recursive: true });
+}
+async function copyDirContents(sourceDir, targetDir, options = {}) {
+	const rootDir = options.rootDir ?? sourceDir;
+	const filter = options.filter ?? ((src) => !shouldSkipTemplatePath(rootDir, src));
+	const renameEntry = options.renameEntry ?? toWorkspaceGitignorePath;
+	const skipRoot = new Set(options.skipRootBasenames ?? []);
+	await fs.mkdir(targetDir, { recursive: true });
+	const entries = await fs.readdir(sourceDir, { withFileTypes: true });
+	for (const entry of entries) {
+		if (sourceDir === rootDir && skipRoot.has(entry.name)) continue;
+		const from = path.join(sourceDir, entry.name);
+		if (!filter(from)) continue;
+		const targetName = renameEntry(entry.name);
+		const to = path.join(targetDir, targetName);
+		if (entry.isDirectory()) {
+			await copyDirContents(from, to, {
+				rootDir,
+				filter,
+				renameEntry,
+				skipRootBasenames: options.skipRootBasenames
+			});
+			continue;
+		}
+		if (entry.isSymbolicLink()) {
+			const link = await fs.readlink(from);
+			await fs.symlink(link, to);
+			continue;
+		}
+		await fs.cp(from, to);
+	}
+}
+async function scaffoldTemplate(options) {
+	const { sourceDir, targetDir, ensureTargetDir = true, filter, renameEntry, skipRootBasenames } = options;
+	if (ensureTargetDir) await fs.mkdir(targetDir, { recursive: true });
+	await copyDirContents(sourceDir, targetDir, {
+		rootDir: sourceDir,
+		filter,
+		renameEntry,
+		skipRootBasenames
+	});
+}
+async function scaffoldWorkspace(options) {
+	const { targetDir, templateKeys = [], assetsDir: assetsDir$1 = assetsDir, templatesDir: templatesDir$1 = templatesDir, includeAssets = true, targetMode = "prepare", force = false } = options;
+	if (targetMode === "prepare") await prepareTargetDir(targetDir, { force });
+	else if (targetMode === "ensure") await fs.mkdir(targetDir, { recursive: true });
+	if (includeAssets) await copyDirContents(assetsDir$1, targetDir, { rootDir: assetsDir$1 });
+	if (!templateKeys.length) return;
+	const selections = new Set(templateKeys);
+	for (const template of templateChoices$1) {
+		if (!selections.has(template.key)) continue;
+		await scaffoldTemplate({
+			sourceDir: path.join(templatesDir$1, template.source),
+			targetDir: path.join(targetDir, template.target)
+		});
+	}
+}
+
 //#endregion
 //#region src/utils/command.ts
 async function runCommand(command, args, options = {}) {
@@ -273,4 +352,4 @@ const templateTargetMap = Object.fromEntries(templateChoices.map((item) => [item
 const templateMap = templateSourceMap;
 
 //#endregion
-export { Command, assetTargets, assetsDir, checkbox, createTemplateCopyFilter, execaCommand, getAssetTargets, input, isGitignoreFile, packageDir, prepareAssets, program, runCommand, select, shouldSkipTemplatePath, skeletonDir, templateChoices, templateMap, templateSourceMap, templateTargetMap, templatesDir, toPublishGitignorePath, toWorkspaceGitignorePath };
+export { Command, assetTargets, assetsDir, checkbox, createTemplateCopyFilter, execaCommand, getAssetTargets, input, isGitignoreFile, packageDir, prepareAssets, program, runCommand, scaffoldTemplate, scaffoldWorkspace, select, shouldSkipTemplatePath, skeletonDir, templateChoices, templateMap, templateSourceMap, templateTargetMap, templatesDir, toPublishGitignorePath, toWorkspaceGitignorePath };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@icebreakers/monorepo-templates",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Template assets for icebreaker monorepo scaffolding",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -52,7 +52,7 @@
     "dev": "tsdown --watch --sourcemap",
     "build": "tsdown",
     "typecheck": "tsc -p tsconfig.json",
-    "sync:assets": "node scripts/sync-assets.mjs",
+    "sync:assets": "pnpm run build && node scripts/sync-assets.mjs",
     "lint": "eslint ."
   }
 }

package/templates/vue-lib/eslint.config.js

@@ -4,9 +4,6 @@ export default icebreaker(
   {
     vue: true,
     typescript: true,
-    tailwindcss: {
-      entryPoint: 'src/style.css',
-    },
     ignores: ['**/fixtures/**'],
   },
 )

package/templates/vue-lib/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@icebreakers/vue-lib-template",
   "type": "module",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "vue lib vite lib mode template",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "ISC",
@@ -16,15 +16,13 @@
   "keywords": [],
   "sideEffects": false,
   "exports": {
-    ".": "./lib/index.ts"
+    ".": "./src/index.ts"
   },
   "files": [
     "dist"
   ],
   "scripts": {
-    "dev": "vite",
     "build": "vue-tsc -b && vite build",
-    "preview": "vite preview",
     "test": "vitest run",
     "test:dev": "vitest",
     "release": "pnpm publish",
@@ -45,17 +43,13 @@
     "types": "./dist/index.d.ts"
   },
   "devDependencies": {
-    "@tailwindcss/vite": "^4.1.18",
     "@vitejs/plugin-vue": "^6.0.3",
     "@vue/test-utils": "^2.4.6",
     "@vue/tsconfig": "^0.8.1",
     "jsdom": "^27.4.0",
-    "tailwindcss": "^4.1.18",
-    "unplugin-vue-router": "^0.19.2",
     "vite": "^7.3.1",
     "vite-plugin-dts": "^4.5.4",
     "vue": "^3.5.26",
-    "vue-router": "^4.6.4",
     "vue-tsc": "^3.2.2"
   }
 }

package/templates/vue-lib/{lib → src}/HelloWorld.vue

@@ -7,15 +7,16 @@ withDefaults(defineProps<{
 </script>
 
 <template>
-  <div class="p-2">
-    <div class="rounded-2xl p-2">
-      {{ msg }}
-    </div>
+  <div class="hello-world">
+    {{ msg }}
   </div>
 </template>
 
 <style scoped>
-.a {
-  color: aliceblue;
+.hello-world {
+  padding: 8px;
+  color: #222;
+  background: #f5f5f5;
+  border-radius: 12px;
 }
 </style>

package/templates/vue-lib/{lib → src}/index.ts

@@ -1,3 +1,5 @@
 import HelloWorld from './HelloWorld.vue'
 
-export { HelloWorld }
+export {
+  HelloWorld,
+}

package/templates/vue-lib/src/vite-env.d.ts

@@ -1,2 +1 @@
 /// <reference types="vite/client" />
-/// <reference types="unplugin-vue-router/client" />

package/templates/vue-lib/test/index.test.ts

@@ -1,5 +1,5 @@
 import { mount } from '@vue/test-utils'
-import HelloWorld from '../lib/HelloWorld.vue'
+import HelloWorld from '../src/HelloWorld.vue'
 
 it('displays message', () => {
   const wrapper = mount(HelloWorld, {

package/templates/vue-lib/tsconfig.app.json

@@ -5,9 +5,6 @@
     "paths": {
       "@/*": [
         "./src/*"
-      ],
-      "~/*": [
-        "./lib/*"
       ]
     },
     /* Linting */
@@ -19,12 +16,8 @@
     "noUncheckedSideEffectImports": true
   },
   "include": [
-    "lib/**/*.ts",
-    "lib/**/*.tsx",
-    "lib/**/*.vue",
     "src/**/*.ts",
     "src/**/*.tsx",
-    "src/**/*.vue",
-    "types"
+    "src/**/*.vue"
   ]
 }

package/templates/vue-lib/tsconfig.test.json

@@ -14,9 +14,6 @@
     "paths": {
       "@/*": [
         "./src"
-      ],
-      "~/*": [
-        "./lib"
       ]
     },
     "types": [

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

@@ -1,8 +1,6 @@
 import type { PluginOption, UserConfig } from 'vite'
-import Tailwindcss from '@tailwindcss/vite'
 import Vue from '@vitejs/plugin-vue'
 import path from 'pathe'
-import VueRouter from 'unplugin-vue-router/vite'
 import { mergeConfig } from 'vite'
 import DTS from 'vite-plugin-dts'
 import { sharedConfig } from './vite.shared.config'
@@ -12,28 +10,20 @@ const ensureVitePlugin = <T>(plugin: T) => plugin as unknown as PluginOption
 
 export default mergeConfig(sharedConfig, {
   plugins: [
-    ensureVitePlugin(
-      VueRouter(
-        {
-          dts: path.relative(import.meta.dirname, './types/typed-router.d.ts'),
-        },
-      ),
-    ),
     ensureVitePlugin(Vue()),
     ensureVitePlugin(
       DTS(
         {
           tsconfigPath: './tsconfig.app.json',
-          entryRoot: './lib',
+          entryRoot: './src',
         },
       ),
     ),
-    ensureVitePlugin(Tailwindcss()),
   ],
   // https://vite.dev/guide/build.html#library-mode
   build: {
     lib: {
-      entry: path.resolve(import.meta.dirname, 'lib/index'),
+      entry: path.resolve(import.meta.dirname, 'src/index'),
       name: 'icebreaker',
       // the proper extensions will be added
       fileName: 'index',

package/templates/vue-lib/vite.shared.config.ts

@@ -7,7 +7,6 @@ export const sharedConfig = defineConfig({
   resolve: {
     alias: {
       '@': path.resolve(import.meta.dirname, 'src'),
-      '~': path.resolve(import.meta.dirname, 'lib'),
     },
   },
 })

package/templates/vue-lib/index.html

@@ -1,13 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vite + Vue + TS</title>
-  </head>
-  <body>
-    <div id="app"></div>
-    <script type="module" src="/src/main.ts"></script>
-  </body>
-</html>

package/templates/vue-lib/src/App.vue

@@ -1,9 +0,0 @@
-<script setup lang="ts">
-
-</script>
-
-<template>
-  <RouterView />
-</template>
-
-<style scoped></style>

package/templates/vue-lib/src/main.ts

@@ -1,8 +0,0 @@
-import { createApp } from 'vue'
-import App from './App.vue'
-import { router } from './router'
-import './style.css'
-
-const app = createApp(App)
-app.use(router)
-app.mount('#app')

package/templates/vue-lib/src/pages/index.vue

@@ -1,7 +0,0 @@
-<script setup lang="ts">
-import { HelloWorld } from '~/index'
-</script>
-
-<template>
-  <HelloWorld msg="Vite + Vue" />
-</template>

package/templates/vue-lib/src/router/index.ts

@@ -1,11 +0,0 @@
-import { createRouter, createWebHistory } from 'vue-router'
-import { handleHotUpdate, routes } from 'vue-router/auto-routes'
-
-export const router = createRouter({
-  history: createWebHistory(),
-  routes,
-})
-
-if (import.meta.hot) {
-  handleHotUpdate(router)
-}

package/templates/vue-lib/src/style.css

@@ -1 +0,0 @@
-@import 'tailwindcss';