create-vue3-enterprise 1.0.1 → 1.0.2

package/dist/index.js

@@ -1,34 +1,34 @@
 #!/usr/bin/env node
-import fs from 'node:fs';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import minimist from 'minimist';
-import prompts from 'prompts';
-import { red, green, cyan } from 'kolorist';
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import minimist from "minimist";
+import prompts from "prompts";
+import { red, green, cyan } from "kolorist";
 const argv = minimist(process.argv.slice(2), {
-    string: ['_'],
-    boolean: ['help', 'template', 'force'],
+    string: ["_"],
+    boolean: ["help", "template", "force"],
     alias: {
-        h: 'help',
-        t: 'template',
-        f: 'force'
-    }
+        h: "help",
+        t: "template",
+        f: "force",
+    },
 });
 const cwd = process.cwd();
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 function printHelp() {
     console.log(`
-${cyan('create-vue3-enterprise')}
+${cyan("create-vue3-enterprise")}
 
-${green('Usage:')}
+${green("Usage:")}
   npm create vue3-enterprise <project-name> [options]
 
-${green('Options:')}
+${green("Options:")}
   -h, --help        Show help
   -f, --force       Force overwrite
 
-${green('Examples:')}
+${green("Examples:")}
   npm create vue3-enterprise my-project
 `);
 }
@@ -36,7 +36,12 @@ function isValidPackageName(projectName) {
     return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(projectName);
 }
 function toValidPackageName(projectName) {
-    return projectName.trim().toLowerCase().replace(/\s+/g, '-').replace(/^[._]/, '').replace(/[^a-z0-9-~]+/g, '-');
+    return projectName
+        .trim()
+        .toLowerCase()
+        .replace(/\s+/g, "-")
+        .replace(/^[._]/, "")
+        .replace(/[^a-z0-9-~]+/g, "-");
 }
 function emptyDir(dir) {
     if (!fs.existsSync(dir))
@@ -58,66 +63,78 @@ function copyDir(srcDir, destDir) {
     }
 }
 function makePkg(targetDir, features, needRouter, needPinia) {
-    const name = isValidPackageName(targetDir) ? targetDir : toValidPackageName(targetDir);
+    const name = isValidPackageName(targetDir)
+        ? targetDir
+        : toValidPackageName(targetDir);
     const pkg = {
         name,
-        version: '0.0.0',
+        version: "0.0.0",
         private: true,
-        type: 'module',
+        type: "module",
         scripts: {
-            dev: 'vite',
-            build: 'vue-tsc && vite build',
-            preview: 'vite preview',
-            test: 'vitest',
-            'test:e2e': 'playwright test',
-            'test:perf': 'playwright test --config=playwright.config.perf.ts',
-            lint: 'eslint . --ext .vue,.ts,.tsx --fix',
-            format: 'prettier --write .',
-            'type-check': 'vue-tsc --noEmit'
+            dev: "vite",
+            build: "vue-tsc && vite build",
+            preview: "vite preview",
+            test: "vitest",
+            "test:e2e": "playwright test",
+            "test:perf": "playwright test --config=playwright.config.perf.ts",
+            lint: "eslint . --ext .vue,.ts,.tsx --fix",
+            format: "prettier --write .",
+            "type-check": "vue-tsc --noEmit",
         },
-        dependencies: { vue: '^3.4.0' },
+        dependencies: { vue: "^3.4.0" },
         devDependencies: {
-            '@vitejs/plugin-vue': '^5.0.0',
-            typescript: '^5.3.0',
-            vite: '^5.0.0',
-            'vue-tsc': '^1.8.0'
-        }
+            "@vitejs/plugin-vue": "^5.0.0",
+            typescript: "^5.3.0",
+            vite: "^5.0.0",
+            "vue-tsc": "^1.8.0",
+        },
     };
     if (needRouter)
-        pkg.dependencies['vue-router'] = '^4.2.0';
+        pkg.dependencies["vue-router"] = "^4.2.0";
     if (needPinia)
-        pkg.dependencies['pinia'] = '^2.1.0';
-    if (features.includes('lint')) {
+        pkg.dependencies["pinia"] = "^2.1.0";
+    if (features.includes("lint")) {
         Object.assign(pkg.devDependencies, {
-            '@typescript-eslint/eslint-plugin': '^6.21.0',
-            '@typescript-eslint/parser': '^6.21.0',
-            '@vue/eslint-config-prettier': '^9.0.0',
-            '@vue/eslint-config-typescript': '^12.0.0',
-            eslint: '^8.57.0',
-            'eslint-plugin-vue': '^9.21.0',
-            prettier: '^3.2.0'
+            "@typescript-eslint/eslint-plugin": "^6.21.0",
+            "@typescript-eslint/parser": "^6.21.0",
+            "@vue/eslint-config-prettier": "^9.0.0",
+            "@vue/eslint-config-typescript": "^12.0.0",
+            eslint: "^8.57.0",
+            "eslint-plugin-vue": "^9.21.0",
+            prettier: "^3.2.0",
+            husky: "^9.0.11",
+            "lint-staged": "^15.2.2",
         });
+        pkg.scripts["prepare"] = "husky";
+        pkg.scripts["lint-staged"] = "lint-staged";
+        pkg["lint-staged"] = {
+            "*.{js,jsx,ts,tsx,vue}": ["eslint --fix", "prettier --write"],
+            "*.{json,md,css,scss,html}": ["prettier --write"],
+        };
     }
-    if (features.includes('vitest')) {
+    if (features.includes("vitest")) {
         Object.assign(pkg.devDependencies, {
-            '@vue/test-utils': '^2.4.0',
-            'happy-dom': '^13.0.0',
-            vitest: '^1.2.0'
+            "@vue/test-utils": "^2.4.0",
+            "happy-dom": "^13.0.0",
+            vitest: "^1.2.0",
         });
     }
-    if (features.includes('playwright')) {
-        pkg.devDependencies['@playwright/test'] = '^1.41.0';
+    if (features.includes("playwright")) {
+        pkg.devDependencies["@playwright/test"] = "^1.41.0";
     }
-    if (features.includes('mcp')) {
-        pkg.devDependencies['vue3-enterprise-mcp'] = '^1.0.0';
+    if (features.includes("mcp")) {
+        pkg.devDependencies["vue3-enterprise-mcp"] = "^1.0.0";
     }
-    if (features.includes('ci')) {
-        pkg.devDependencies['vue3-enterprise-ci'] = '^1.0.0';
+    if (features.includes("ci")) {
+        pkg.devDependencies["vue3-enterprise-ci"] = "^1.0.0";
     }
     return pkg;
 }
 async function main() {
-    console.log(`\n${cyan('Vue3 Enterprise Toolchain')}\n`);
+    console.log(`
+${cyan("Vue3 Enterprise Toolchain")}
+`);
     if (argv.help) {
         printHelp();
         return;
@@ -125,46 +142,67 @@ async function main() {
     let targetDir = argv._[0];
     const response = await prompts([
         {
-            type: targetDir ? null : 'text',
-            name: 'name',
-            message: 'Project name:',
-            initial: 'vue3-enterprise-project',
-            onState: (s) => { targetDir = String(s.value).trim() || 'vue3-enterprise-project'; }
+            type: targetDir ? null : "text",
+            name: "name",
+            message: "Project name:",
+            initial: "vue3-enterprise-project",
+            onState: (s) => {
+                targetDir = String(s.value).trim() || "vue3-enterprise-project";
+            },
         },
         {
-            type: 'select', name: 'template', message: 'Select template:',
+            type: "select",
+            name: "template",
+            message: "Select template:",
             choices: [
-                { title: 'Vue3 + TypeScript + Vite', value: 'vue3-ts' },
-                { title: 'Vue3 + TS + Vite + Pinia', value: 'vue3-ts-pinia' },
-                { title: 'Vue3 + TS + Vite + Pinia + Router', value: 'vue3-ts-full' }
-            ]
+                { title: "Vue3 + TypeScript + Vite", value: "vue3-ts" },
+                { title: "Vue3 + TS + Vite + Pinia", value: "vue3-ts-pinia" },
+                { title: "Vue3 + TS + Vite + Pinia + Router", value: "vue3-ts-full" },
+            ],
         },
         {
-            type: 'multiselect', name: 'features', message: 'Select features:',
+            type: "multiselect",
+            name: "features",
+            message: "Select features:",
             choices: [
-                { title: 'ESLint + Prettier', value: 'lint', selected: true },
-                { title: 'Vitest', value: 'vitest', selected: true },
-                { title: 'Playwright', value: 'playwright', selected: true },
-                { title: 'Vue3 Enterprise MCP', value: 'mcp', selected: true },
-                { title: 'CI/CD Workflow', value: 'ci', selected: true },
-                { title: 'Performance Benchmark', value: 'perf', selected: true }
-            ]
+                { title: "ESLint + Prettier", value: "lint", selected: true },
+                { title: "Vitest", value: "vitest", selected: true },
+                { title: "Playwright", value: "playwright", selected: true },
+                { title: "Vue3 Enterprise MCP", value: "mcp", selected: true },
+                { title: "CI/CD Workflow", value: "ci", selected: true },
+                { title: "Performance Benchmark", value: "perf", selected: true },
+            ],
         },
         {
-            type: 'confirm', name: 'router', message: 'Add Vue Router?', initial: true
+            type: "confirm",
+            name: "router",
+            message: "Add Vue Router?",
+            initial: true,
         },
         {
-            type: 'confirm', name: 'pinia', message: 'Add Pinia?', initial: true
+            type: "confirm",
+            name: "pinia",
+            message: "Add Pinia?",
+            initial: true,
         },
         {
-            type: 'confirm', name: 'overwrite',
-            message: targetDir && fs.existsSync(targetDir) && fs.readdirSync(targetDir).length > 0
-                ? `Dir "${targetDir}" exists. Overwrite?` : 'Overwrite existing?',
-            initial: false
-        }
-    ], { onCancel: () => { console.log(red('✖ Cancelled')); process.exit(1); } });
+            type: "confirm",
+            name: "overwrite",
+            message: targetDir &&
+                fs.existsSync(targetDir) &&
+                fs.readdirSync(targetDir).length > 0
+                ? `Dir "${targetDir}" exists. Overwrite?`
+                : "Overwrite existing?",
+            initial: false,
+        },
+    ], {
+        onCancel: () => {
+            console.log(red("✖ Cancelled"));
+            process.exit(1);
+        },
+    });
     if (!response.overwrite) {
-        console.log(red('✖ Cancelled'));
+        console.log(red("✖ Cancelled"));
         process.exit(1);
     }
     const root = path.join(cwd, targetDir);
@@ -178,24 +216,29 @@ async function main() {
     }
     else
         fs.mkdirSync(root, { recursive: true });
-    console.log(`\n${cyan('Creating project...')}\n`);
-    copyDir(path.resolve(__dirname, '../template'), root);
+    console.log(`
+${cyan("Creating project...")}
+`);
+    copyDir(path.resolve(__dirname, "../template"), root);
     const pkg = makePkg(targetDir, response.features || [], response.router, response.pinia);
-    fs.writeFileSync(path.join(root, 'package.json'), JSON.stringify(pkg, null, 2));
+    fs.writeFileSync(path.join(root, "package.json"), JSON.stringify(pkg, null, 2));
     const desc = {
-        lint: '- 🧹 ESLint + Prettier',
-        vitest: '- 🧪 Vitest Unit Tests',
-        playwright: '- 🎭 Playwright E2E',
-        mcp: '- 🔍 Vue3 Enterprise MCP',
-        ci: '- ⚡ CI/CD',
-        perf: '- 📊 Performance'
+        lint: "- 🧹 ESLint + Prettier",
+        vitest: "- 🧪 Vitest Unit Tests",
+        playwright: "- 🎭 Playwright E2E",
+        mcp: "- 🔍 Vue3 Enterprise MCP",
+        ci: "- ⚡ CI/CD",
+        perf: "- 📊 Performance",
     };
     const readme = `# ${pkg.name}
 
 Created with Vue3 Enterprise Toolchain
 
 ## Features
-${(response.features || []).map((f) => desc[f]).filter(Boolean).join('\n')}
+${(response.features || [])
+        .map((f) => desc[f])
+        .filter(Boolean)
+        .join("\n")}
 
 ## Quick Start
 \`\`\`bash
@@ -208,9 +251,19 @@ npm run dev
 - \`npm run build\` - Build
 - \`npm test\` - Run tests
 `;
-    fs.writeFileSync(path.join(root, 'README.md'), readme);
-    const gitignore = `node_modules\ndist\n*.local\n.vscode\ncoverage\ntest-results\nplaywright-report\n.perf-baseline.json`;
-    fs.writeFileSync(path.join(root, '.gitignore'), gitignore);
-    console.log(`${green('✔')} Created!\n  cd ${cyan(targetDir)}\n  npm install\n  npm run dev\n`);
+    fs.writeFileSync(path.join(root, "README.md"), readme);
+    const gitignore = `node_modules
+dist
+*.local
+.vscode
+coverage
+test-results
+playwright-report
+.perf-baseline.json`;
+    fs.writeFileSync(path.join(root, ".gitignore"), gitignore);
+    console.log(`${green("✔")} Created!\n  cd ${cyan(targetDir)}\n  npm install\n  npm run dev\n`);
 }
-main().catch((e) => { console.error(e); process.exit(1); });
+main().catch((e) => {
+    console.error(e);
+    process.exit(1);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-vue3-enterprise",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Vue3 + TypeScript + Vite 企业级项目脚手架",
   "type": "module",
   "bin": {

package/template/.husky/commit-msg

@@ -0,0 +1,59 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# 获取提交信息
+COMMIT_MSG_FILE=$1
+COMMIT_MSG=$(cat "$COMMIT_MSG_FILE")
+
+echo "🔍 正在检查提交信息规范..."
+
+# 定义提交信息格式规范
+# 支持的类型
+VALID_TYPES="feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert"
+
+# 检查提交信息格式
+# 格式: type(scope): subject 或 type: subject
+PATTERN="^($VALID_TYPES)(\(.+\))?: .+"
+
+if ! echo "$COMMIT_MSG" | grep -qE "$PATTERN"; then
+  echo ""
+  echo "❌ 提交信息格式错误！"
+  echo ""
+  echo "提交信息必须符合以下格式:"
+  echo "  <type>: <subject>"
+  echo "  或"
+  echo "  <type>(<scope>): <subject>"
+  echo ""
+  echo "支持的 type:"
+  echo "  feat:     新功能"
+  echo "  fix:      修复 bug"
+  echo "  docs:     文档更新"
+  echo "  style:    代码格式调整（不影响代码逻辑）"
+  echo "  refactor: 重构代码"
+  echo "  perf:     性能优化"
+  echo "  test:     测试相关"
+  echo "  chore:    构建/工具链相关"
+  echo "  ci:       CI/CD 相关"
+  echo "  build:    构建相关"
+  echo "  revert:   回滚提交"
+  echo ""
+  echo "示例:"
+  echo "  feat: 添加用户登录功能"
+  echo "  fix(auth): 修复登录失效问题"
+  echo "  docs: 更新 README"
+  echo ""
+  exit 1
+fi
+
+# 检查提交信息长度
+MSG_LENGTH=$(echo "$COMMIT_MSG" | wc -c)
+if [ "$MSG_LENGTH" -gt 100 ]; then
+  echo ""
+  echo "⚠️  提交信息过长 ($MSG_LENGTH 字符)"
+  echo "建议保持提交信息简洁，不超过 100 个字符"
+  echo ""
+  # 不阻止提交，只给出警告
+fi
+
+echo "✅ 提交信息格式正确！"
+exit 0

package/template/.husky/pre-commit

@@ -0,0 +1,78 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+echo "🔍 正在运行代码审查规范..."
+
+# 获取当前暂存的文件列表
+STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM)
+
+if [ -z "$STAGED_FILES" ]; then
+  echo "ℹ️  没有暂存的文件需要检查"
+  exit 0
+fi
+
+echo "📋 暂存文件列表:"
+echo "$STAGED_FILES" | while read file; do
+  echo "   - $file"
+done
+
+# 检查是否有需要 lint 的代码文件
+CODE_FILES=$(echo "$STAGED_FILES" | grep -E '\.(js|jsx|ts|tsx|vue)$' || true)
+
+if [ -n "$CODE_FILES" ]; then
+  echo ""
+  echo "🧹 正在运行 ESLint 检查..."
+  echo "$CODE_FILES" | xargs npx eslint --ext .js,.jsx,.ts,.tsx,.vue --max-warnings=0
+  
+  if [ $? -ne 0 ]; then
+    echo ""
+    echo "❌ ESLint 检查失败"
+    echo "   请修复上述错误后重新提交"
+    exit 1
+  fi
+  
+  echo "   ✅ ESLint 检查通过"
+fi
+
+# 检查是否有 TypeScript 文件需要类型检查
+TS_FILES=$(echo "$STAGED_FILES" | grep -E '\.(ts|tsx|vue)$' || true)
+
+if [ -n "$TS_FILES" ]; then
+  echo ""
+  echo "🔎 正在运行 TypeScript 类型检查..."
+  npx vue-tsc --noEmit
+  
+  if [ $? -ne 0 ]; then
+    echo ""
+    echo "❌ TypeScript 类型检查失败"
+    echo "   请修复类型错误后重新提交"
+    exit 1
+  fi
+  
+  echo "   ✅ TypeScript 类型检查通过"
+fi
+
+# 运行测试（仅运行与提交文件相关的测试）
+echo ""
+echo "🧪 正在运行相关单元测试..."
+npx vitest run --reporter=verbose 2>&1 | head -50
+
+if [ $? -ne 0 ]; then
+  echo ""
+  echo "❌ 单元测试失败"
+  echo "   请修复测试后重新提交"
+  exit 1
+fi
+
+echo "   ✅ 单元测试通过"
+
+echo ""
+echo "🎉 所有代码审查规范检查通过！"
+echo ""
+
+# 如果有 MCP 配置，可以在这里调用 MCP 进行深度代码审查
+if [ -f ".mcp-review.config.js" ] || [ -f "vue3-enterprise-mcp.config.js" ]; then
+  echo "💡 提示: 你可以运行 'npx vue3-enterprise-mcp review' 进行更深入的代码审查"
+fi
+
+exit 0

package/template/README.md

@@ -0,0 +1,153 @@
+# 🚀 Vue3 Enterprise 脚手架项目
+
+Vue3 + TypeScript + Vite 企业级开发脚手架
+
+## ✨ 功能特性
+
+- **🎯 Vue3 + TypeScript + Vite** - 现代化的前端开发体验
+- **🧹 ESLint + Prettier** - 自动化的代码规范检查
+- **🧪 Vitest** - 快速的单元测试框架
+- **🎭 Playwright** - 端到端测试方案
+- **🔍 Vue3 Enterprise MCP** - Claude MCP Server 代码审查
+- **⚡ CI/CD 工作流** - GitHub Actions 自动化
+
+## 🚀 快速开始
+
+```bash
+# 创建新项目
+npm create vue3-enterprise@latest my-project
+
+# 进入项目目录
+cd my-project
+
+# 安装依赖
+npm install
+
+# 启动开发服务器
+npm run dev
+```
+
+## 📋 可用脚本
+
+| 脚本                 | 说明                     |
+| -------------------- | ------------------------ |
+| `npm run dev`        | 启动开发服务器           |
+| `npm run build`      | 构建生产版本             |
+| `npm run preview`    | 预览生产构建             |
+| `npm test`           | 运行单元测试             |
+| `npm run test:e2e`   | 运行 E2E 测试            |
+| `npm run lint`       | 运行 ESLint 检查         |
+| `npm run format`     | 格式化代码               |
+| `npm run type-check` | 运行 TypeScript 类型检查 |
+
+## 🏗️ 项目结构
+
+```
+my-project/
+├── src/                    # 源代码目录
+│   ├── components/         # Vue 组件
+│   ├── composables/        # 组合式函数
+│   ├── views/              # 页面视图
+│   ├── stores/             # Pinia 状态管理
+│   ├── utils/              # 工具函数
+│   ├── assets/             # 静态资源
+│   ├── App.vue             # 根组件
+│   ├── main.ts             # 入口文件
+│   └── style.css           # 全局样式
+├── tests/                  # 测试目录
+│   ├── unit/              # 单元测试
+│   └── e2e/               # E2E 测试
+├── public/                # 静态文件
+├── .github/               # GitHub 配置
+│   └── workflows/         # GitHub Actions
+├── index.html             # HTML 模板
+├── package.json           # 项目配置
+├── vite.config.ts         # Vite 配置
+├── vitest.config.ts       # Vitest 配置
+├── playwright.config.ts   # Playwright 配置
+├── tsconfig.json          # TypeScript 配置
+├── .eslintrc.cjs          # ESLint 配置
+└── .prettierrc            # Prettier 配置
+```
+
+## 🔒 代码提交规范
+
+本项目使用 **Husky** + **lint-staged** 实现代码提交前自动检查。
+
+### 提交信息规范
+
+提交信息必须符合以下格式：
+
+```
+<type>: <subject>
+```
+
+或
+
+```
+<type>(<scope>): <subject>
+```
+
+### 支持的 type
+
+| 类型       | 说明                           |
+| ---------- | ------------------------------ |
+| `feat`     | 新功能                         |
+| `fix`      | 修复 bug                       |
+| `docs`     | 文档更新                       |
+| `style`    | 代码格式调整（不影响代码逻辑） |
+| `refactor` | 重构代码                       |
+| `perf`     | 性能优化                       |
+| `test`     | 测试相关                       |
+| `chore`    | 构建/工具链相关                |
+| `ci`       | CI/CD 相关                     |
+| `build`    | 构建相关                       |
+| `revert`   | 回滚提交                       |
+
+### 示例
+
+```bash
+git commit -m "feat: 添加用户登录功能"
+git commit -m "fix(auth): 修复登录失效问题"
+git commit -m "docs: 更新 README"
+```
+
+## 🧪 测试
+
+### 单元测试
+
+```bash
+npm test
+# 或
+npm run test -- --coverage
+```
+
+### E2E 测试
+
+```bash
+npm run test:e2e
+```
+
+## 📦 构建
+
+```bash
+npm run build
+```
+
+构建后的文件将位于 `dist/` 目录。
+
+## 🚀 部署
+
+构建完成后，可以将 `dist/` 目录部署到任何静态文件服务器。
+
+## 📄 许可证
+
+[MIT](LICENSE)
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 📞 支持
+
+如有问题，请提交 GitHub Issue。

package/template/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "template",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vue-tsc && vite build",
+    "preview": "vite preview",
+    "test": "vitest",
+    "test:e2e": "playwright test",
+    "test:perf": "playwright test --config=playwright.config.perf.ts",
+    "lint": "eslint . --ext .vue,.ts,.tsx --fix",
+    "format": "prettier --write .",
+    "type-check": "vue-tsc --noEmit",
+    "prepare": "husky",
+    "lint-staged": "lint-staged"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,vue}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{json,md,css,scss,html}": [
+      "prettier --write"
+    ]
+  },
+  "dependencies": {
+    "vue": "^3.4.0"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^5.0.0",
+    "@vue/test-utils": "^2.4.0",
+    "happy-dom": "^13.0.0",
+    "husky": "^9.0.11",
+    "lint-staged": "^15.2.2",
+    "typescript": "^5.3.0",
+    "vite": "^5.0.0",
+    "vitest": "^1.2.0",
+    "vue-tsc": "^1.8.0"
+  }
+}