create-codeforge-app 1.0.0

package/README.md

@@ -0,0 +1,23 @@
+# create-codeforge
+
+一行命令创建全栈项目（NestJS + Vue3 + PostgreSQL）。
+
+## 使用
+
+```bash
+npx create-codeforge my-project
+```
+
+## 前置条件
+
+- Node.js 20+
+- PostgreSQL 或 Docker（二选一）
+
+## 功能
+
+- 交互式配置（项目名/标题/数据库名）
+- 自动检测 PostgreSQL / Docker 环境
+- 可选移动端 H5 骨架
+- 可选删除示例模块
+- 自动安装依赖、初始化数据库、写入种子数据
+- 生成随机 JWT_SECRET

package/index.js

@@ -0,0 +1,76 @@
+#!/usr/bin/env node
+
+const path = require('path')
+const { runPrompts } = require('./lib/prompts')
+const { detect } = require('./lib/detect')
+const { cloneTemplate } = require('./lib/clone')
+const { configure } = require('./lib/configure')
+const { cleanup } = require('./lib/cleanup')
+const { setupDatabase } = require('./lib/database')
+const { install } = require('./lib/install')
+const chalk = require('chalk')
+
+async function main() {
+  const projectName = process.argv[2]
+  if (!projectName) {
+    console.log(chalk.red('请指定项目名称：npx create-codeforge <project-name>'))
+    process.exit(1)
+  }
+
+  const targetDir = path.resolve(process.cwd(), projectName)
+
+  // 检查目录是否存在
+  const fs = require('fs')
+  if (fs.existsSync(targetDir)) {
+    const prompts = require('prompts')
+    const { overwrite } = await prompts({ type: 'confirm', name: 'overwrite', message: `目录 ${projectName} 已存在，是否覆盖？`, initial: false })
+    if (!overwrite) { console.log('已取消'); process.exit(0) }
+    fs.rmSync(targetDir, { recursive: true, force: true })
+  }
+
+  console.log(chalk.cyan(`\n🚀 create-codeforge v1.0.0\n`))
+
+  // 1. 交互问答
+  const answers = await runPrompts(projectName)
+  if (!answers) process.exit(0)
+
+  // 2. 检测环境
+  console.log(chalk.cyan('\n🔍 检测环境...'))
+  const env = await detect()
+
+  // 3. 克隆模板
+  console.log(chalk.cyan('\n⏳ 正在创建项目...\n'))
+  await cloneTemplate(targetDir)
+
+  // 4. 替换配置
+  await configure(targetDir, answers)
+
+  // 5. 清理示例模块
+  if (!answers.keepExample) {
+    await cleanup(targetDir)
+  }
+
+  // 6. 数据库
+  await setupDatabase(targetDir, answers, env)
+
+  // 7. 安装依赖 + git init
+  await install(targetDir)
+
+  // 完成
+  console.log(chalk.green('\n✅ 项目创建成功！\n'))
+  console.log(`  cd ${projectName}`)
+  console.log(`  cd server && npm run start:dev    ${chalk.gray('# 后端 http://localhost:3000')}`)
+  console.log(`  cd client && npm run dev          ${chalk.gray('# 前端 http://localhost:5173')}`)
+  console.log('')
+  console.log(`  管理员账号: ${chalk.yellow('admin@example.com / admin123')}`)
+  console.log(`  Swagger 文档: ${chalk.yellow('http://localhost:3000/api-docs')}`)
+  console.log('')
+  console.log(`  📖 开发教程: TUTORIAL.md`)
+  console.log(`  🚀 部署指南: DEPLOY.md`)
+  console.log('')
+}
+
+main().catch((err) => {
+  console.error(chalk.red('❌ 创建失败：'), err.message)
+  process.exit(1)
+})

package/lib/cleanup.js

@@ -0,0 +1,116 @@
+const fs = require('fs')
+const path = require('path')
+const chalk = require('chalk')
+
+function removeDir(dir) {
+  if (fs.existsSync(dir)) fs.rmSync(dir, { recursive: true, force: true })
+}
+
+function replaceInFile(filePath, replacements) {
+  if (!fs.existsSync(filePath)) return
+  let content = fs.readFileSync(filePath, 'utf8')
+  for (const [search, replace] of replacements) {
+    if (search instanceof RegExp) content = content.replace(search, replace)
+    else content = content.split(search).join(replace)
+  }
+  fs.writeFileSync(filePath, content)
+}
+
+async function cleanup(targetDir) {
+  console.log(`  [4/8] 🗑️  删除示例模块...`)
+
+  // 删除后端 example 模块
+  removeDir(path.join(targetDir, 'server/src/example'))
+
+  // 删除前端 example 页面
+  removeDir(path.join(targetDir, 'client/src/views/example'))
+
+  // app.module.ts — 删除 ExampleModule
+  replaceInFile(path.join(targetDir, 'server/src/app.module.ts'), [
+    [/import \{ ExampleModule \}.*?\n/, ''],
+    [/\s*ExampleModule,?\n?/, '\n'],
+  ])
+
+  // schema.prisma — 删除 Article 和 Tag 模型
+  const schemaPath = path.join(targetDir, 'server/prisma/schema.prisma')
+  if (fs.existsSync(schemaPath)) {
+    let schema = fs.readFileSync(schemaPath, 'utf8')
+    // 删除 Article 模型
+    schema = schema.replace(/model Article \{[\s\S]*?\}\n*/g, '')
+    // 删除 Tag 模型
+    schema = schema.replace(/model Tag \{[\s\S]*?\}\n*/g, '')
+    // 删除 User 中的 articles 字段
+    schema = schema.replace(/\s*articles\s+Article\[\]\n?/g, '\n')
+    fs.writeFileSync(schemaPath, schema)
+  }
+
+  // seed.ts — 简化为只创建 admin
+  fs.writeFileSync(path.join(targetDir, 'server/prisma/seed.ts'), `import { PrismaClient } from '@prisma/client';
+import * as bcrypt from 'bcrypt';
+
+const prisma = new PrismaClient();
+
+async function main() {
+  const password = await bcrypt.hash('admin123', 10);
+  await prisma.user.upsert({
+    where: { email: 'admin@example.com' },
+    update: {},
+    create: { email: 'admin@example.com', password, name: '管理员', role: 'ADMIN' },
+  });
+}
+
+main()
+  .catch((e) => { throw e; })
+  .finally(() => prisma.$disconnect());
+`)
+
+  // router — 删除 examples 路由
+  const routerPath = path.join(targetDir, 'client/src/router/index.ts')
+  if (fs.existsSync(routerPath)) {
+    let router = fs.readFileSync(routerPath, 'utf8')
+    // 删除 examples 路由行
+    router = router.replace(/.*path: 'examples'.*\n/g, '')
+    // 修复可能出现的 }, }, 问题
+    router = router.replace(/\},\s*\},/g, '},')
+    fs.writeFileSync(routerPath, router)
+  }
+
+  // AdminLayout — 删除示例管理菜单项
+  replaceInFile(path.join(targetDir, 'client/src/layout/AdminLayout.vue'), [
+    [/\s*\{ path: '\/examples'.*?\},?\n?/g, ''],
+  ])
+
+  // api/index.ts — 删除 exampleApi
+  replaceInFile(path.join(targetDir, 'client/src/api/index.ts'), [
+    [/\nexport const exampleApi[\s\S]*?\}\n/g, '\n'],
+  ])
+
+  // Dashboard — 简化
+  const dashPath = path.join(targetDir, 'client/src/views/dashboard/index.vue')
+  if (fs.existsSync(dashPath)) {
+    let dash = fs.readFileSync(dashPath, 'utf8')
+    // 替换整个 script 部分
+    dash = dash.replace(/<script setup lang="ts">[\s\S]*?<\/script>/, `<script setup lang="ts">
+import { ref, onMounted } from 'vue'
+import { User, Document, EditPen, Files } from '@element-plus/icons-vue'
+import { userApi } from '@/api'
+
+const cards = ref([
+  { title: '用户总数', value: '-', icon: User, color: '#409eff' },
+  { title: '待开发', value: '-', icon: Document, color: '#67c23a' },
+  { title: '待开发', value: '-', icon: Files, color: '#e6a23c' },
+  { title: '待开发', value: '-', icon: EditPen, color: '#f56c6c' },
+])
+
+onMounted(async () => {
+  try {
+    const users = await userApi.list({ page: 1, pageSize: 1 })
+    cards.value[0].value = String(users.total)
+  } catch {}
+})
+</script>`)
+    fs.writeFileSync(dashPath, dash)
+  }
+}
+
+module.exports = { cleanup }

package/lib/clone.js

@@ -0,0 +1,15 @@
+const { execSync } = require('child_process')
+const chalk = require('chalk')
+
+const TEMPLATE_REPO = 'https://github.com/codeforge-arch/project-template.git'
+
+async function cloneTemplate(targetDir) {
+  console.log(`  [1/8] 📥 克隆模板...`)
+  try {
+    execSync(`git clone --depth 1 ${TEMPLATE_REPO} "${targetDir}"`, { stdio: 'ignore' })
+  } catch {
+    throw new Error('克隆模板失败，请检查网络连接')
+  }
+}
+
+module.exports = { cloneTemplate }

package/lib/configure.js

@@ -0,0 +1,80 @@
+const fs = require('fs')
+const path = require('path')
+const crypto = require('crypto')
+const chalk = require('chalk')
+
+function replaceInFile(filePath, replacements) {
+  if (!fs.existsSync(filePath)) return
+  let content = fs.readFileSync(filePath, 'utf8')
+  for (const [search, replace] of replacements) {
+    content = content.replace(search, replace)
+  }
+  fs.writeFileSync(filePath, content)
+}
+
+async function configure(targetDir, answers) {
+  console.log(`  [2/8] ✏️  替换项目配置...`)
+
+  const { projectName, title, dbName } = answers
+  const jwtSecret = crypto.randomBytes(32).toString('hex')
+  const logoFull = title.length > 6 ? title.slice(0, 6) : title
+  const logoShort = title.charAt(0)
+
+  // server/package.json
+  replaceInFile(path.join(targetDir, 'server/package.json'), [
+    ['"name": "server"', `"name": "${projectName}-server"`],
+  ])
+
+  // client/package.json
+  replaceInFile(path.join(targetDir, 'client/package.json'), [
+    ['"name": "client"', `"name": "${projectName}-client"`],
+  ])
+
+  // index.html 标题
+  replaceInFile(path.join(targetDir, 'client/index.html'), [
+    [/<title>.*?<\/title>/, `<title>${title}</title>`],
+  ])
+
+  // AdminLayout Logo
+  replaceInFile(path.join(targetDir, 'client/src/layout/AdminLayout.vue'), [
+    [/>Admin</, `>${logoFull}<`],
+    [/>A</, `>${logoShort}<`],
+  ])
+
+  // server/.env
+  console.log(`  [3/8] 🔑 生成 .env...`)
+  // 检测本地 PostgreSQL 用户（macOS brew 默认用系统用户名，无密码）
+  const os = require('os')
+  let pgUser = 'postgres', pgPassword = 'postgres'
+  try {
+    const { execSync } = require('child_process')
+    execSync(`psql -U ${os.userInfo().username} -d postgres -c "SELECT 1" 2>/dev/null`, { stdio: 'ignore' })
+    pgUser = os.userInfo().username
+    pgPassword = ''
+  } catch {}
+
+  const dbUrl = pgPassword
+    ? `postgresql://${pgUser}:${pgPassword}@localhost:5432/${dbName}?schema=public`
+    : `postgresql://${pgUser}@localhost:5432/${dbName}?schema=public`
+
+  fs.writeFileSync(path.join(targetDir, 'server/.env'), [
+    `DATABASE_URL=${dbUrl}`,
+    `JWT_SECRET=${jwtSecret}`,
+    `PORT=3000`,
+    `NODE_ENV=development`,
+    `CORS_ORIGIN=*`,
+  ].join('\n') + '\n')
+
+  // 根目录 .env（Docker 用）
+  fs.writeFileSync(path.join(targetDir, '.env'), [
+    `DB_USER=postgres`,
+    `DB_PASSWORD=postgres`,
+    `DB_NAME=${dbName}`,
+    `JWT_SECRET=${jwtSecret}`,
+    `PORT=3000`,
+    `NODE_ENV=production`,
+    `CORS_ORIGIN=http://localhost`,
+  ].join('\n') + '\n')
+}
+
+module.exports = { configure }

package/lib/database.js

@@ -0,0 +1,37 @@
+const { execSync } = require('child_process')
+const chalk = require('chalk')
+const prompts = require('prompts')
+
+async function setupDatabase(targetDir, answers, env) {
+  const { dbName } = answers
+  const serverDir = `${targetDir}/server`
+
+  if (env.hasPg) {
+    console.log(`  [5/8] 🗄️  配置 PostgreSQL...`)
+    // 创建数据库（如果不存在）
+    try {
+      execSync(`createdb ${dbName} 2>/dev/null`, { stdio: 'ignore' })
+      console.log(chalk.gray(`         数据库 ${dbName} 已创建`))
+    } catch {
+      console.log(chalk.gray(`         数据库 ${dbName} 已存在`))
+    }
+  } else if (env.hasDocker) {
+    console.log(`  [5/8] 🐳 启动 PostgreSQL（Docker）...`)
+    const containerName = `${answers.projectName}-db`
+    try {
+      // 停掉同名容器
+      execSync(`docker rm -f ${containerName} 2>/dev/null`, { stdio: 'ignore' })
+      execSync(`docker run -d --name ${containerName} -p 5432:5432 -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=${dbName} postgres:16-alpine`, { stdio: 'ignore' })
+      // 等待就绪
+      for (let i = 0; i < 20; i++) {
+        await new Promise(r => setTimeout(r, 500))
+        try { execSync(`docker exec ${containerName} pg_isready`, { stdio: 'ignore' }); break } catch {}
+      }
+      console.log(chalk.gray(`         容器 ${containerName} 已启动`))
+    } catch (e) {
+      throw new Error('Docker 启动 PostgreSQL 失败：' + e.message)
+    }
+  }
+}
+
+module.exports = { setupDatabase }

package/lib/detect.js

@@ -0,0 +1,64 @@
+const { execSync } = require('child_process')
+const chalk = require('chalk')
+
+function commandExists(cmd) {
+  try { execSync(`which ${cmd}`, { stdio: 'ignore' }); return true } catch { return false }
+}
+
+function pgReady() {
+  try { const r = execSync('pg_isready 2>&1', { encoding: 'utf8' }); return r.includes('accepting') } catch { return false }
+}
+
+function dockerRunning() {
+  try { execSync('docker info', { stdio: 'ignore' }); return true } catch { return false }
+}
+
+async function detect() {
+  const env = { hasPg: false, hasDocker: false }
+
+  // Node.js
+  const nodeVer = process.version
+  console.log(`  ✅ Node.js ${nodeVer}`)
+
+  // PostgreSQL
+  if (commandExists('psql')) {
+    if (pgReady()) {
+      env.hasPg = true
+      console.log(`  ✅ PostgreSQL 已运行`)
+    } else {
+      console.log(chalk.yellow(`  ⚠️  PostgreSQL 已安装但未启动`))
+      // 尝试启动
+      try {
+        execSync('brew services start postgresql@16 2>/dev/null || brew services start postgresql 2>/dev/null', { stdio: 'ignore' })
+        // 等待启动
+        for (let i = 0; i < 10; i++) {
+          await new Promise(r => setTimeout(r, 500))
+          if (pgReady()) { env.hasPg = true; break }
+        }
+        if (env.hasPg) console.log(`  ✅ PostgreSQL 已自动启动`)
+        else console.log(chalk.yellow(`  ⚠️  PostgreSQL 启动失败`))
+      } catch {}
+    }
+  }
+
+  // Docker
+  if (commandExists('docker')) {
+    if (dockerRunning()) {
+      env.hasDocker = true
+      console.log(`  ✅ Docker 已运行`)
+    } else {
+      console.log(chalk.yellow(`  ⚠️  Docker 已安装但未运行`))
+    }
+  }
+
+  if (!env.hasPg && !env.hasDocker) {
+    console.log(chalk.red('\n❌ 需要 PostgreSQL 或 Docker（二选一）'))
+    console.log(`  安装 PostgreSQL: ${chalk.cyan('brew install postgresql@16')}`)
+    console.log(`  安装 Docker: ${chalk.cyan('https://docker.com')}`)
+    process.exit(1)
+  }
+
+  return env
+}
+
+module.exports = { detect }

package/lib/install.js

@@ -0,0 +1,40 @@
+const { execSync } = require('child_process')
+const fs = require('fs')
+const path = require('path')
+const chalk = require('chalk')
+
+async function install(targetDir) {
+  const serverDir = path.join(targetDir, 'server')
+  const clientDir = path.join(targetDir, 'client')
+
+  // 删除模板的旧迁移文件
+  const migrationsDir = path.join(serverDir, 'prisma/migrations')
+  if (fs.existsSync(migrationsDir)) {
+    fs.rmSync(migrationsDir, { recursive: true, force: true })
+  }
+
+  // 安装依赖
+  console.log(`  [6/8] 📦 安装依赖...`)
+  execSync('npm install', { cwd: serverDir, stdio: 'ignore' })
+  console.log(chalk.gray('         server 依赖已安装'))
+  execSync('npm install', { cwd: clientDir, stdio: 'ignore' })
+  console.log(chalk.gray('         client 依赖已安装'))
+
+  // 数据库迁移 + 种子
+  console.log(`  [7/8] 🗄️  初始化数据库...`)
+  try {
+    execSync('npx prisma migrate dev --name init', { cwd: serverDir, stdio: 'ignore' })
+    execSync('npx prisma db seed', { cwd: serverDir, stdio: 'ignore' })
+    console.log(chalk.gray('         数据库迁移 + 种子数据完成'))
+  } catch {
+    console.log(chalk.yellow('         ⚠️  数据库初始化失败，请手动执行：'))
+    console.log(chalk.gray('         cd server && npx prisma migrate dev && npx prisma db seed'))
+  }
+
+  // 清理 git 历史，重新 init
+  console.log(`  [8/8] 🧹 初始化 Git...`)
+  fs.rmSync(path.join(targetDir, '.git'), { recursive: true, force: true })
+  execSync('git init && git add -A && git commit -m "init: 项目初始化"', { cwd: targetDir, stdio: 'ignore' })
+}
+
+module.exports = { install }

package/lib/prompts.js

@@ -0,0 +1,17 @@
+const prompts = require('prompts')
+
+async function runPrompts(projectName) {
+  const dbName = projectName.replace(/-/g, '_')
+
+  const answers = await prompts([
+    { type: 'text', name: 'title', message: '📄 页面标题', initial: projectName },
+    { type: 'text', name: 'dbName', message: '🗄️  数据库名', initial: dbName },
+    { type: 'confirm', name: 'mobile', message: '📱 需要移动端 H5？', initial: true },
+    { type: 'confirm', name: 'keepExample', message: '📦 保留示例模块？', initial: false },
+  ], { onCancel: () => { process.exit(0) } })
+
+  answers.projectName = projectName
+  return answers
+}
+
+module.exports = { runPrompts }

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "create-codeforge-app",
+  "version": "1.0.0",
+  "description": "一行命令创建全栈项目（NestJS + Vue3 + PostgreSQL）",
+  "bin": {
+    "create-codeforge-app": "./index.js"
+  },
+  "keywords": [
+    "scaffold",
+    "fullstack",
+    "nestjs",
+    "vue3",
+    "prisma",
+    "postgresql"
+  ],
+  "author": "codeforge-arch",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "prompts": "^2.4.2"
+  }
+}