create-vue3-enterprise 1.0.0 → 1.0.20

package/dist/index.js

@@ -1,48 +1,56 @@
 #!/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, yellow } 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:')}
-  npm create vue3-enterprise <project-name> [options]
+${green("用法:")}
+  npm create vue3-enterprise <项目名称> [选项]
 
-${green('Options:')}
-  -h, --help        Show help
-  -f, --force       Force overwrite
+${green("选项:")}
+  -h, --help        显示帮助信息
+  -t, --template    指定模板（vue3-ts）
+  -f, --force       强制覆盖已存在的目录
 
-${green('Examples:')}
+${green("示例:")}
   npm create vue3-enterprise my-project
+  npm create vue3-enterprise my-project --force
 `);
 }
 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))
         return;
     for (const file of fs.readdirSync(dir)) {
-        fs.rmSync(path.resolve(dir, file), { recursive: true, force: true });
+        const filePath = path.resolve(dir, file);
+        fs.rmSync(filePath, { recursive: true, force: true });
     }
 }
 function copyDir(srcDir, destDir) {
@@ -51,166 +59,319 @@ function copyDir(srcDir, destDir) {
         const srcFile = path.resolve(srcDir, file);
         const destFile = path.resolve(destDir, file);
         const stat = fs.statSync(srcFile);
-        if (stat.isDirectory())
+        if (stat.isDirectory()) {
             copyDir(srcFile, destFile);
-        else
+        }
+        else {
             fs.copyFileSync(srcFile, destFile);
+        }
     }
 }
-function makePkg(targetDir, features, needRouter, needPinia) {
-    const name = isValidPackageName(targetDir) ? targetDir : toValidPackageName(targetDir);
+async function generatePackageJson(targetDir, options) {
     const pkg = {
-        name,
-        version: '0.0.0',
+        name: isValidPackageName(targetDir)
+            ? targetDir
+            : toValidPackageName(targetDir),
+        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",
+            prepare: "husky install",
+            "lint-staged": "lint-staged",
+        },
+        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';
-    if (needPinia)
-        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'
-        });
-    }
-    if (features.includes('vitest')) {
-        Object.assign(pkg.devDependencies, {
-            '@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('mcp')) {
-        pkg.devDependencies['vue3-enterprise-mcp'] = '^1.0.0';
-    }
-    if (features.includes('ci')) {
-        pkg.devDependencies['vue3-enterprise-ci'] = '^1.0.0';
+    if (options.needsRouter) {
+        pkg.dependencies["vue-router"] = "^4.2.0";
+    }
+    if (options.needsPinia) {
+        pkg.dependencies["pinia"] = "^2.1.0";
+    }
+    if (options.features?.includes("lint")) {
+        pkg.devDependencies["@typescript-eslint/eslint-plugin"] = "^6.21.0";
+        pkg.devDependencies["@typescript-eslint/parser"] = "^6.21.0";
+        pkg.devDependencies["@vue/eslint-config-prettier"] = "^9.0.0";
+        pkg.devDependencies["@vue/eslint-config-typescript"] = "^12.0.0";
+        pkg.devDependencies["eslint"] = "^8.57.0";
+        pkg.devDependencies["eslint-plugin-vue"] = "^9.21.0";
+        pkg.devDependencies["prettier"] = "^3.2.0";
+        // Git hooks
+        pkg.devDependencies["husky"] = "^9.0.0";
+        pkg.devDependencies["lint-staged"] = "^15.2.0";
+        pkg.devDependencies["@commitlint/cli"] = "^19.0.0";
+        pkg.devDependencies["@commitlint/config-conventional"] = "^19.0.0";
+    }
+    if (options.features?.includes("vitest")) {
+        pkg.devDependencies["@vue/test-utils"] = "^2.4.0";
+        pkg.devDependencies["happy-dom"] = "^13.0.0";
+        pkg.devDependencies["vitest"] = "^1.2.0";
+    }
+    if (options.features?.includes("playwright")) {
+        pkg.devDependencies["@playwright/test"] = "^1.41.0";
+    }
+    if (options.features?.includes("mcp")) {
+        pkg.devDependencies["vue3-enterprise-mcp"] = "^1.0.0";
+    }
+    if (options.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(`\n${cyan("Vue3 Enterprise Toolchain")}\n`);
     if (argv.help) {
         printHelp();
         return;
     }
     let targetDir = argv._[0];
-    const response = await prompts([
+    const promptResult = 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: "projectName",
+            message: "项目名称:",
+            initial: "vue3-enterprise-project",
+            onState: (state) => {
+                targetDir = String(state.value).trim() || "vue3-enterprise-project";
+            },
         },
         {
-            type: 'select', name: 'template', message: 'Select template:',
+            type: "select",
+            name: "template",
+            message: "选择模板:",
             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 + TypeScript + Vite + Pinia", value: "vue3-ts-pinia" },
+                {
+                    title: "Vue3 + TypeScript + Vite + Pinia + Vue Router",
+                    value: "vue3-ts-full",
+                },
+            ],
         },
         {
-            type: 'multiselect', name: 'features', message: 'Select features:',
+            type: "multiselect",
+            name: "features",
+            message: "选择功能 (空格选择，回车确认):",
             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 (E2E 测试)",
+                    value: "playwright",
+                    selected: true,
+                },
+                { title: "Vue3 Enterprise MCP", value: "mcp", selected: true },
+                { title: "CI/CD 工作流", value: "ci", selected: true },
+                { title: "性能基准测试", value: "perf", selected: true },
+            ],
         },
         {
-            type: 'confirm', name: 'router', message: 'Add Vue Router?', initial: true
+            type: "confirm",
+            name: "needsTypeScript",
+            message: "使用 TypeScript?",
+            initial: true,
         },
         {
-            type: 'confirm', name: 'pinia', message: 'Add Pinia?', initial: true
+            type: "confirm",
+            name: "needsRouter",
+            message: "添加 Vue Router?",
+            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); } });
-    if (!response.overwrite) {
-        console.log(red('✖ Cancelled'));
+            type: "confirm",
+            name: "needsPinia",
+            message: "添加 Pinia (状态管理)?",
+            initial: true,
+        },
+        {
+            type: "confirm",
+            name: "overwrite",
+            message: targetDir &&
+                fs.existsSync(targetDir) &&
+                fs.readdirSync(targetDir).length > 0
+                ? `目录 "${targetDir}" 已存在且不为空。是否覆盖?`
+                : "",
+            initial: false,
+        },
+    ], {
+        onCancel: () => {
+            console.log(red("✖ 操作已取消"));
+            process.exit(1);
+        },
+    });
+    if (promptResult.overwrite === false) {
+        console.log(red("✖ 操作已取消"));
         process.exit(1);
     }
     const root = path.join(cwd, targetDir);
     if (fs.existsSync(root)) {
-        if (argv.force || response.overwrite)
+        if (argv.force || promptResult.overwrite) {
             emptyDir(root);
+        }
         else {
-            console.log(red(`✖ Dir "${targetDir}" exists`));
+            console.log(red(`✖ 目录 "${targetDir}" 已存在`));
+            console.log(yellow("提示: 使用 --force 强制覆盖"));
             process.exit(1);
         }
     }
-    else
+    else {
         fs.mkdirSync(root, { recursive: true });
-    console.log(`\n${cyan('Creating project...')}\n`);
-    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));
-    const desc = {
-        lint: '- 🧹 ESLint + Prettier',
-        vitest: '- 🧪 Vitest Unit Tests',
-        playwright: '- 🎭 Playwright E2E',
-        mcp: '- 🔍 Vue3 Enterprise MCP',
-        ci: '- ⚡ CI/CD',
-        perf: '- 📊 Performance'
+    }
+    console.log(`\n${cyan("正在创建项目...")}\n`);
+    const templateDir = path.resolve(__dirname, "../template");
+    copyDir(templateDir, root);
+    const pkg = await generatePackageJson(targetDir, {
+        features: promptResult.features || [],
+        needsRouter: promptResult.needsRouter,
+        needsPinia: promptResult.needsPinia,
+    });
+    fs.writeFileSync(path.join(root, "package.json"), JSON.stringify(pkg, null, 2));
+    const featureDescriptions = {
+        lint: "- 🧹 ESLint + Prettier 代码规范 + Git Hooks 自动检查",
+        vitest: "- 🧪 Vitest 单元测试",
+        playwright: "- 🎭 Playwright E2E 测试",
+        mcp: "- 🔍 Vue3 Enterprise MCP 代码审查",
+        ci: "- ⚡ CI/CD 自动化",
+        perf: "- 📊 性能基准测试",
     };
     const readme = `# ${pkg.name}
 
-Created with Vue3 Enterprise Toolchain
+使用 Vue3 Enterprise Toolchain 创建的项目
+
+## 功能特性
 
-## Features
-${(response.features || []).map((f) => desc[f]).filter(Boolean).join('\n')}
+${(promptResult.features || [])
+        .map((f) => featureDescriptions[f] || "")
+        .filter(Boolean)
+        .join("\n")}
+
+## 快速开始
 
-## Quick Start
 \`\`\`bash
+# 安装依赖
 npm install
+
+# 启动开发服务器
 npm run dev
+
+# 运行测试
+npm test
+
+# 构建生产版本
+npm run build
 \`\`\`
 
-## Scripts
-- \`npm run dev\` - Start dev server
-- \`npm run build\` - Build
-- \`npm test\` - Run tests
+## 可用脚本
+
+- \`npm run dev\` - 启动开发服务器
+- \`npm run build\` - 构建生产版本
+- \`npm run preview\` - 预览生产版本
+- \`npm test\` - 运行单元测试
+- \`npm run test:e2e\` - 运行 E2E 测试
+- \`npm run test:perf\` - 运行性能测试
+- \`npm run lint\` - 运行 ESLint
+- \`npm run format\` - 运行 Prettier
+
+## 文档
+
+- [Vue3 Enterprise MCP 使用指南](https://github.com/your-org/vue3-enterprise-toolchain/blob/main/docs/mcp.md)
+- [CI 集成指南](https://github.com/your-org/vue3-enterprise-toolchain/blob/main/docs/ci.md)
 `;
-    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 = `# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# Testing
+coverage
+
+# Playwright
+test-results/
+playwright-report/
+playwright/.cache/
+
+# Performance baseline
+.perf-baseline.json
+`;
+    fs.writeFileSync(path.join(root, ".gitignore"), gitignore);
+    // Initialize git and husky if lint feature is enabled
+    if (promptResult.features?.includes("lint")) {
+        const { execSync } = require("child_process");
+        try {
+            execSync("git init", { cwd: root, stdio: "ignore" });
+            execSync("npm run prepare", { cwd: root, stdio: "ignore" });
+        }
+        catch (e) {
+            // Git may not be installed
+        }
+    }
+    console.log(`${green("✔")} 项目创建成功!\n`);
+    console.log(`  cd ${cyan(targetDir)}`);
+    console.log(`  npm install`);
+    console.log(`  npm run dev\n`);
+    // Git hooks info
+    if (promptResult.features?.includes("lint")) {
+        console.log(`${cyan("Git Hooks 配置:")}`);
+        console.log(`  • pre-commit: 自动检查格式和类型`);
+        console.log(`  • commit-msg: 验证提交信息格式`);
+        console.log(`  提交时自动运行检查，无需手动触发\n`);
+    }
+    if (promptResult.features?.includes("mcp")) {
+        console.log(`${cyan("MCP Server 配置:")}`);
+        console.log(`  在 Claude Desktop 的 claude_desktop_config.json 中添加:\n`);
+        console.log(`  {
+    "mcpServers": {
+      "vue3-enterprise": {
+        "command": "npx",
+        "args": ["-y", "vue3-enterprise-mcp", "${targetDir}"]
+      }
+    }
+  }\n`);
+    }
+    if (promptResult.features?.includes("ci")) {
+        console.log(`${cyan("CI 配置:")}`);
+        console.log(`  已配置 GitHub Actions 工作流`);
+        console.log(`  提交代码后会自动运行测试和性能检查\n`);
+    }
 }
-main().catch((e) => { console.error(e); process.exit(1); });
+main().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-vue3-enterprise",
-  "version": "1.0.0",
+  "version": "1.0.20",
   "description": "Vue3 + TypeScript + Vite 企业级项目脚手架",
   "type": "module",
   "bin": {
@@ -13,9 +13,7 @@
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
-    "prepublishOnly": "npm run build",
-    "test": "node ./dist/index.js --help",
-    "test:create": "node ./dist/index.js test-project --force"
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
     "kolorist": "^1.8.0",

package/template/.husky/commit-msg

@@ -0,0 +1,35 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# ============================================
+# 📝 Commit Message Validation
+# Uses Conventional Commits format
+# ============================================
+
+echo ""
+echo "📝 Validating commit message..."
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+
+# Run commitlint
+if ! npx commitlint --edit ${1}; then
+  echo ""
+  echo "❌ Commit message validation FAILED"
+  echo ""
+  echo "📖 Correct format:"
+  echo "   <type>(<scope>): <subject>"
+  echo ""
+  echo "   Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert"
+  echo ""
+  echo "   Examples:"
+  echo "   • feat: add user login button"
+  echo "   • fix: resolve memory leak in component"
+  echo "   • docs: update API documentation"
+  echo ""
+  echo "   Run 'npm run commit' for interactive commit"
+  echo ""
+  exit 1
+fi
+
+echo ""
+echo "✅ Commit message validated!"
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"

package/template/.husky/pre-commit

@@ -0,0 +1,30 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# ============================================
+# 🧹 Pre-commit Checks
+# - Code formatting (Prettier)
+# - Type checking (vue-tsc)
+# - Linting (ESLint)
+# ============================================
+
+echo ""
+echo "🔍 Running pre-commit checks..."
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+
+# Run lint-staged
+if ! npx lint-staged; then
+  echo ""
+  echo "❌ Pre-commit checks FAILED"
+  echo ""
+  echo "📖 Fix suggestions:"
+  echo "   • Run 'npm run format' to fix formatting"
+  echo "   • Run 'npm run lint' to fix linting errors"
+  echo "   • Fix TypeScript errors manually"
+  echo ""
+  exit 1
+fi
+
+echo ""
+echo "✅ Pre-commit checks passed!"
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"

package/template/commitlint.config.js

@@ -0,0 +1,28 @@
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    // Type envelope: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat', // New feature
+        'fix', // Bug fix
+        'docs', // Documentation only changes
+        'style', // Changes that do not affect the meaning of the code (formatting)
+        'refactor', // Code change that neither fixes a bug nor adds a feature
+        'perf', // Performance improvement
+        'test', // Adding or correcting tests
+        'build', // Changes to build system or dependencies
+        'ci', // Changes to CI configuration
+        'chore', // Other changes that don't modify src or test files
+        'revert', // Reverts a previous commit
+      ],
+    ],
+    'type-case': [2, 'always', 'lower-case'],
+    'type-empty': [2, 'never'],
+    'subject-empty': [2, 'never'],
+    'subject-full-stop': [2, 'never', '.'],
+    'header-max-length': [2, 'always', 100],
+  },
+}

package/template/lint-staged.config.js

@@ -0,0 +1,8 @@
+export default {
+  // TypeScript and Vue files - check types
+  '*.ts': ['vue-tsc --noEmit', 'eslint --fix'],
+  '*.tsx': ['vue-tsc --noEmit', 'eslint --fix'],
+  '*.vue': ['vue-tsc --noEmit', 'eslint --fix'],
+  // Format all staged files
+  '**/*': ['prettier --write --ignore-unknown'],
+}