zant-admin 1.0.0

package/bin/generator.js

@@ -0,0 +1,503 @@
+/**
+ * 项目生成器
+ * 负责创建和管理项目模板
+ */
+
+import fs from 'fs';
+import path from 'path';
+import { 
+  createDirectory, 
+  copyDirectory, 
+  writeFile, 
+  renderTemplate, 
+  executeCommand,
+  getProjectRoot,
+  validateProjectName
+} from './utils.js';
+
+/**
+ * 创建新项目
+ */
+export async function createProject(projectName, options) {
+  // 验证项目名称
+  validateProjectName(projectName);
+  
+  const projectPath = path.resolve(process.cwd(), projectName);
+  
+  // 检查目录是否已存在
+  if (fs.existsSync(projectPath)) {
+    throw new Error(`目录 "${projectName}" 已存在，请选择其他名称`);
+  }
+  
+  // 创建项目目录
+  createDirectory(projectPath);
+  
+  // 根据模板类型生成项目
+  await generateProjectStructure(projectPath, options);
+  
+  // 生成配置文件
+  await generateConfigFiles(projectPath, projectName, options);
+  
+  // 安装依赖（如果未跳过）
+  if (!options.skipInstall) {
+    await installDependencies(projectPath);
+  }
+}
+
+/**
+ * 生成项目结构
+ */
+async function generateProjectStructure(projectPath, options) {
+  const templateType = options.template || 'default';
+  const sourceRoot = getProjectRoot();
+  
+  console.log('📁 生成项目结构...');
+  
+  // 复制基础文件
+  const baseFiles = [
+    'package.json',
+    'vite.config.js',
+    'index.html',
+    'eslint.config.js',
+    '.prettierrc.json',
+    '.gitignore',
+    '.editorconfig',
+    'jsconfig.json'
+  ];
+  
+  baseFiles.forEach(file => {
+    const sourceFile = path.join(sourceRoot, file);
+    const targetFile = path.join(projectPath, file);
+    
+    if (fs.existsSync(sourceFile)) {
+      fs.copyFileSync(sourceFile, targetFile);
+    }
+  });
+  
+  // 复制环境配置文件
+  const envFiles = ['.env.development', '.env.test'];
+  envFiles.forEach(file => {
+    const sourceFile = path.join(sourceRoot, file);
+    const targetFile = path.join(projectPath, file);
+    
+    if (fs.existsSync(sourceFile)) {
+      fs.copyFileSync(sourceFile, targetFile);
+    }
+  });
+  
+  // 使用模板生成生产环境配置文件
+  await generateProductionEnv(projectPath);
+  
+  // 复制 public 目录
+  copyDirectory(path.join(sourceRoot, 'public'), path.join(projectPath, 'public'));
+  
+  // 复制 src 目录（根据模板类型）
+  await copySourceDirectory(sourceRoot, projectPath, templateType);
+}
+
+/**
+ * 复制源代码目录
+ */
+async function copySourceDirectory(sourceRoot, projectPath, templateType) {
+  const srcPath = path.join(sourceRoot, 'src');
+  const targetSrcPath = path.join(projectPath, 'src');
+  
+  // 创建 src 目录结构
+  createDirectory(targetSrcPath);
+  
+  // 复制核心文件
+  const coreFiles = ['main.js', 'App.vue'];
+  coreFiles.forEach(file => {
+    const sourceFile = path.join(srcPath, file);
+    const targetFile = path.join(targetSrcPath, file);
+    
+    if (fs.existsSync(sourceFile)) {
+      fs.copyFileSync(sourceFile, targetFile);
+    }
+  });
+  
+  // 复制核心目录
+  const coreDirs = ['api', 'assets', 'config', 'directives', 'router', 'stores', 'utils'];
+  coreDirs.forEach(dir => {
+    const sourceDir = path.join(srcPath, dir);
+    const targetDir = path.join(targetSrcPath, dir);
+    
+    if (fs.existsSync(sourceDir)) {
+      copyDirectory(sourceDir, targetDir);
+    }
+  });
+  
+  // 根据模板类型处理 components 和 views
+  await handleTemplateSpecificFiles(srcPath, targetSrcPath, templateType);
+}
+
+/**
+ * 处理模板特定的文件
+ */
+async function handleTemplateSpecificFiles(srcPath, targetSrcPath, templateType) {
+  // 复制 components 目录
+  const componentsSource = path.join(srcPath, 'components');
+  const componentsTarget = path.join(targetSrcPath, 'components');
+  
+  if (fs.existsSync(componentsSource)) {
+    copyDirectory(componentsSource, componentsTarget);
+  }
+  
+  // 处理 views 目录
+  const viewsSource = path.join(srcPath, 'views');
+  const viewsTarget = path.join(targetSrcPath, 'views');
+  
+  if (fs.existsSync(viewsSource)) {
+    if (templateType === 'basic') {
+      // 基础模板：只保留核心页面
+      createDirectory(viewsTarget);
+      const basicViews = ['console.vue', 'home.vue', 'login.vue'];
+      
+      basicViews.forEach(view => {
+        const sourceFile = path.join(viewsSource, view);
+        const targetFile = path.join(viewsTarget, view);
+        
+        if (fs.existsSync(sourceFile)) {
+          fs.copyFileSync(sourceFile, targetFile);
+        }
+      });
+    } else {
+      // 默认和完整模板：复制所有页面
+      copyDirectory(viewsSource, viewsTarget);
+    }
+  }
+}
+
+/**
+ * 生成配置文件
+ */
+async function generateConfigFiles(projectPath, projectName, options) {
+  console.log('⚙️  生成配置文件...');
+  
+  // 读取并更新 package.json
+  const packageJsonPath = path.join(projectPath, 'package.json');
+  if (fs.existsSync(packageJsonPath)) {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    
+    // 更新项目信息
+    packageJson.name = projectName;
+    packageJson.description = options.description;
+    
+    if (options.author) {
+      packageJson.author = options.author;
+    }
+    
+    // 根据功能特性调整依赖
+    if (options.features && options.features.length > 0) {
+      await adjustDependencies(packageJson, options.features);
+    }
+    
+    // 移除脚手架特定的配置
+    delete packageJson.bin;
+    delete packageJson.main;
+    
+    // 写入更新后的 package.json
+    writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2));
+  }
+  
+  // 生成 README.md
+  await generateReadme(projectPath, projectName, options);
+  
+  // 根据功能特性生成额外文件
+  if (options.features && options.features.length > 0) {
+    await generateFeatureFiles(projectPath, options.features);
+  }
+}
+
+/**
+ * 根据功能特性调整依赖
+ */
+async function adjustDependencies(packageJson, features) {
+  const featureDependencies = {
+    'i18n-support': {
+      dependencies: {
+        'vue-i18n': '^9.0.0'
+      }
+    },
+    'file-upload': {
+      dependencies: {
+        'ant-design-vue': '^4.2.6' // 已包含，确保版本
+      }
+    }
+  };
+  
+  features.forEach(feature => {
+    const deps = featureDependencies[feature];
+    if (deps && deps.dependencies) {
+      Object.assign(packageJson.dependencies, deps.dependencies);
+    }
+  });
+}
+
+/**
+ * 根据功能特性生成额外文件
+ */
+async function generateFeatureFiles(projectPath, features) {
+  const featureGenerators = {
+    'i18n-support': generateI18nFiles,
+    'user-management': generateUserManagementFiles,
+    'permission-management': generatePermissionFiles
+  };
+  
+  for (const feature of features) {
+    const generator = featureGenerators[feature];
+    if (generator) {
+      await generator(projectPath);
+    }
+  }
+}
+
+/**
+ * 生成国际化支持文件
+ */
+async function generateI18nFiles(projectPath) {
+  console.log('🌐 生成国际化支持文件...');
+  
+  // 创建 locales 目录
+  const localesDir = path.join(projectPath, 'src/locales');
+  createDirectory(localesDir);
+  
+  // 生成中文语言包
+  const zhCNContent = `{
+  "common": {
+    "save": "保存",
+    "cancel": "取消",
+    "delete": "删除",
+    "edit": "编辑",
+    "add": "添加"
+  },
+  "menu": {
+    "dashboard": "仪表盘",
+    "user": "用户管理",
+    "system": "系统管理"
+  }
+}`;
+  
+  writeFile(path.join(localesDir, 'zh-CN.json'), zhCNContent);
+  
+  // 生成英文语言包
+  const enUSContent = `{
+  "common": {
+    "save": "Save",
+    "cancel": "Cancel",
+    "delete": "Delete",
+    "edit": "Edit",
+    "add": "Add"
+  },
+  "menu": {
+    "dashboard": "Dashboard",
+    "user": "User Management",
+    "system": "System Management"
+  }
+}`;
+  
+  writeFile(path.join(localesDir, 'en-US.json'), enUSContent);
+}
+
+/**
+ * 生成用户管理相关文件
+ */
+async function generateUserManagementFiles(projectPath) {
+  console.log('👥 生成用户管理文件...');
+  
+  // 创建用户管理相关目录
+  const userViewsDir = path.join(projectPath, 'src/views/system/user');
+  createDirectory(userViewsDir);
+  
+  // 生成用户列表页面
+  const userListContent = `<template>
+  <div class="user-management">
+    <a-card title="用户管理">
+      <a-table :columns="columns" :data-source="userList">
+        <template #action="{ record }">
+          <a-space>
+            <a-button type="link" @click="handleEdit(record)">编辑</a-button>
+            <a-button type="link" danger @click="handleDelete(record)">删除</a-button>
+          </a-space>
+        </template>
+      </a-table>
+    </a-card>
+  </div>
+</template>
+
+<script setup>
+import { ref, onMounted } from 'vue';
+
+const columns = [
+  { title: '用户名', dataIndex: 'username' },
+  { title: '邮箱', dataIndex: 'email' },
+  { title: '角色', dataIndex: 'role' },
+  { title: '状态', dataIndex: 'status' },
+  { title: '操作', slots: { customRender: 'action' } }
+];
+
+const userList = ref([]);
+
+onMounted(() => {
+  // 加载用户数据
+  loadUserData();
+});
+
+const loadUserData = async () => {
+  // 模拟数据
+  userList.value = [
+    { id: 1, username: 'admin', email: 'admin@example.com', role: '管理员', status: '正常' }
+  ];
+};
+
+const handleEdit = (record) => {
+  console.log('编辑用户:', record);
+};
+
+const handleDelete = (record) => {
+  console.log('删除用户:', record);
+};
+</script>
+
+<style scoped>
+.user-management {
+  padding: 20px;
+}
+</style>`;
+  
+  writeFile(path.join(userViewsDir, 'index.vue'), userListContent);
+}
+
+/**
+ * 生成权限管理相关文件
+ */
+async function generatePermissionFiles(projectPath) {
+  console.log('🔐 生成权限管理文件...');
+  
+  // 创建权限管理相关目录
+  const permissionViewsDir = path.join(projectPath, 'src/views/system/permission');
+  createDirectory(permissionViewsDir);
+  
+  // 生成权限管理页面
+  const permissionContent = `<template>
+  <div class="permission-management">
+    <a-card title="权限管理">
+      <p>权限管理功能已生成，请根据业务需求进行开发。</p>
+    </a-card>
+  </div>
+</template>
+
+<script setup>
+// 权限管理页面逻辑
+</script>
+
+<style scoped>
+.permission-management {
+  padding: 20px;
+}
+</style>`;
+  
+  writeFile(path.join(permissionViewsDir, 'index.vue'), permissionContent);
+}
+
+/**
+ * 生成生产环境配置文件
+ */
+async function generateProductionEnv(projectPath) {
+  console.log('🔧 生成生产环境配置文件...');
+  
+  const templatePath = path.join(getProjectRoot(), 'templates/env.production');
+  const targetPath = path.join(projectPath, '.env.production');
+  
+  if (fs.existsSync(templatePath)) {
+    // 使用模板文件
+    fs.copyFileSync(templatePath, targetPath);
+  } else {
+    // 如果模板不存在，创建默认的生产环境配置
+    const defaultProdConfig = `# 生产环境配置
+VITE_BASE_API=http://your-production-server.com/api/
+
+# 其他生产环境变量
+NODE_ENV=production
+VITE_APP_TITLE=ZAnt Admin`;
+    
+    writeFile(targetPath, defaultProdConfig);
+  }
+}
+
+/**
+ * 生成 README.md 文件
+ */
+async function generateReadme(projectPath, projectName, options) {
+  const readmeContent = `# ${projectName}
+
+${options.description}
+
+## 技术栈
+
+- Vue 3 (Composition API)
+- Vite 构建工具
+- Ant Design Vue UI 组件库
+- Pinia 状态管理
+- Vue Router 路由管理
+
+## 快速开始
+
+### 安装依赖
+\`\`\`bash
+npm install
+\`\`\`
+
+### 启动开发服务器
+\`\`\`bash
+npm run dev
+\`\`\`
+
+### 构建生产版本
+\`\`\`bash
+npm run build
+\`\`\`
+
+## 项目结构
+
+\`\`\`
+src/
+├── api/              # 接口请求相关
+├── assets/           # 静态资源文件
+├── components/       # 公共组件
+├── router/           # 路由配置
+├── stores/           # 状态管理
+├── utils/            # 工具函数
+├── views/            # 页面视图
+├── App.vue           # 根组件
+└── main.js           # 入口文件
+\`\`\`
+
+## 命令说明
+
+- \`npm run dev\` - 启动开发服务器
+- \`npm run build\` - 构建生产版本
+- \`npm run preview\` - 预览生产构建
+- \`npm run lint\` - 代码检查
+- \`npm run format\` - 代码格式化
+
+## 许可证
+
+MIT License
+`;
+
+  writeFile(path.join(projectPath, 'README.md'), readmeContent);
+}
+
+/**
+ * 安装依赖
+ */
+async function installDependencies(projectPath) {
+  console.log('📦 安装依赖包...');
+  
+  const success = executeCommand('npm install', projectPath);
+  
+  if (!success) {
+    console.warn('⚠️  依赖安装失败，请手动运行: npm install');
+  }
+}

package/bin/prompts.js

@@ -0,0 +1,159 @@
+/**
+ * 交互式命令行提示
+ */
+
+import readline from 'readline';
+
+/**
+ * 创建交互式命令行界面
+ */
+export function createPromptInterface() {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  
+  return rl;
+}
+
+/**
+ * 询问问题
+ */
+export function question(rl, query) {
+  return new Promise((resolve) => {
+    rl.question(query, resolve);
+  });
+}
+
+/**
+ * 关闭命令行界面
+ */
+export function closePrompt(rl) {
+  rl.close();
+}
+
+/**
+ * 收集项目配置信息
+ */
+export async function collectProjectConfig(projectName) {
+  const rl = createPromptInterface();
+  
+  console.log('\n🎯 项目配置向导');
+  console.log('='.repeat(50));
+  
+  const config = {
+    projectName,
+    description: '',
+    author: '',
+    template: 'default',
+    features: []
+  };
+  
+  try {
+    // 询问项目描述
+    config.description = await question(rl, '📝 请输入项目描述: ') || '基于 Vue 3 + Vite + Ant Design Vue 的前端管理系统';
+    
+    // 询问作者名称
+    config.author = await question(rl, '👤 请输入作者名称 (可选): ');
+    
+    // 选择模板类型
+    console.log('\n📋 请选择项目模板:');
+    console.log('1. 默认模板 (推荐) - 包含完整的管理系统功能');
+    console.log('2. 基础模板 - 仅包含核心功能');
+    console.log('3. 完整模板 - 包含所有示例和高级功能');
+    
+    const templateChoice = await question(rl, '请选择 (1-3, 默认 1): ');
+    
+    switch (templateChoice) {
+      case '2':
+        config.template = 'basic';
+        break;
+      case '3':
+        config.template = 'full';
+        break;
+      default:
+        config.template = 'default';
+    }
+    
+    // 选择功能特性
+    console.log('\n✨ 请选择要包含的功能特性 (可多选):');
+    console.log('1. 用户管理模块');
+    console.log('2. 权限管理模块');
+    console.log('3. 数据可视化图表');
+    console.log('4. 文件上传功能');
+    console.log('5. 国际化支持');
+    
+    const featureChoices = await question(rl, '请输入功能编号 (用逗号分隔, 如 1,3,5): ');
+    
+    if (featureChoices) {
+      const choices = featureChoices.split(',').map(c => c.trim());
+      
+      choices.forEach(choice => {
+        switch (choice) {
+          case '1':
+            config.features.push('user-management');
+            break;
+          case '2':
+            config.features.push('permission-management');
+            break;
+          case '3':
+            config.features.push('data-visualization');
+            break;
+          case '4':
+            config.features.push('file-upload');
+            break;
+          case '5':
+            config.features.push('i18n-support');
+            break;
+        }
+      });
+    }
+    
+    // 确认配置
+    console.log('\n📊 配置摘要:');
+    console.log(`   项目名称: ${config.projectName}`);
+    console.log(`   项目描述: ${config.description}`);
+    console.log(`   作者名称: ${config.author || '未指定'}`);
+    console.log(`   项目模板: ${getTemplateName(config.template)}`);
+    console.log(`   功能特性: ${config.features.length > 0 ? config.features.join(', ') : '默认功能'}`);
+    
+    const confirm = await question(rl, '\n✅ 确认创建项目? (y/N): ');
+    
+    if (confirm.toLowerCase() !== 'y' && confirm.toLowerCase() !== 'yes') {
+      console.log('❌ 项目创建已取消');
+      process.exit(0);
+    }
+    
+    return config;
+    
+  } finally {
+    closePrompt(rl);
+  }
+}
+
+/**
+ * 获取模板显示名称
+ */
+function getTemplateName(template) {
+  const templates = {
+    'default': '默认模板',
+    'basic': '基础模板',
+    'full': '完整模板'
+  };
+  
+  return templates[template] || template;
+}
+
+/**
+ * 询问是否跳过依赖安装
+ */
+export async function askSkipInstall() {
+  const rl = createPromptInterface();
+  
+  try {
+    const answer = await question(rl, '\n📦 是否跳过依赖安装? (y/N): ');
+    return answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes';
+  } finally {
+    closePrompt(rl);
+  }
+}