create-dp-koa 1.0.0

package/README.md

@@ -0,0 +1,50 @@
+# create-dp-koa
+
+通过官方模板快速创建 [DP-Koa Framework](https://gitee.com/rajan_admin/dp-koa-framework) 项目。
+
+## 要求
+
+- Node.js >= 18
+
+## 使用
+
+```bash
+npm create dp-koa@latest
+# 或
+npx create-dp-koa@latest <目录名>
+```
+
+按提示输入项目名称，或直接在命令行传入目录名。
+
+进入项目后：
+
+```bash
+cd <目录名>
+npm install
+cp env.production.example .env
+npm run dev
+```
+
+## 源码与维护
+
+框架源码仓库（SSH）：
+
+```bash
+git clone git@gitee.com:rajan_admin/dp-koa-framework.git
+```
+
+若 npm 包名为作用域包（例如 `@your-org/create-dp-koa`），请使用：
+
+```bash
+npm create @your-org/dp-koa@latest
+```
+
+具体以包发布说明为准。
+
+## 维护者发版
+
+在仓库根目录：
+
+1. 合并并推送代码到远程。
+2. 更新模板：`node scripts/sync-template.mjs`
+3. 在 `packages/create-dp-koa` 下提升 `version`，执行 `npm publish`（`prepublishOnly` 会再次同步模板；若已手动同步可保持一致）。

package/index.mjs

@@ -0,0 +1,97 @@
+#!/usr/bin/env node
+import { cp, readFile, readdir, stat, writeFile } from 'fs/promises';
+import { dirname, join, resolve } from 'path';
+import { fileURLToPath } from 'url';
+import prompts from 'prompts';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const TEMPLATE_DIR = join(__dirname, 'template');
+
+function toPackageName(input) {
+  const s = String(input || '')
+    .trim()
+    .toLowerCase()
+    .replace(/\s+/g, '-')
+    .replace(/[^a-z0-9._-]/g, '-')
+    .replace(/-+/g, '-')
+    .replace(/^-+|-+$/g, '');
+  return s || 'my-app';
+}
+
+async function pathExists(p) {
+  try {
+    await stat(p);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function assertTargetDirAllowed(targetDir) {
+  if (!(await pathExists(targetDir))) return;
+  const st = await stat(targetDir);
+  if (!st.isDirectory()) {
+    console.error(`错误: 目标路径已存在且不是目录: ${targetDir}`);
+    process.exit(1);
+  }
+  const entries = await readdir(targetDir);
+  if (entries.length > 0) {
+    console.error(`错误: 目标目录已存在且非空: ${targetDir}`);
+    process.exit(1);
+  }
+}
+
+async function main() {
+  let projectName = process.argv[2];
+
+  if (!projectName) {
+    const res = await prompts(
+      {
+        type: 'text',
+        name: 'name',
+        message: '项目名称（将作为目录名与 package.json 的 name）',
+        initial: 'my-dp-koa-app',
+      },
+      { onCancel: () => process.exit(0) }
+    );
+    projectName = res.name;
+  }
+
+  const pkgName = toPackageName(projectName);
+  const cwd = process.cwd();
+  const targetDir = resolve(cwd, projectName);
+
+  if (!(await pathExists(TEMPLATE_DIR))) {
+    console.error(
+      `错误: 未找到模板目录。请在仓库根执行: node scripts/sync-template.mjs`
+    );
+    process.exit(1);
+  }
+
+  await assertTargetDirAllowed(targetDir);
+
+  await cp(TEMPLATE_DIR, targetDir, { recursive: true });
+
+  const pkgPath = join(targetDir, 'package.json');
+  if (await pathExists(pkgPath)) {
+    const raw = await readFile(pkgPath, 'utf8');
+    const json = JSON.parse(raw);
+    json.name = pkgName;
+    await writeFile(pkgPath, `${JSON.stringify(json, null, 2)}\n`, 'utf8');
+  }
+
+  console.log();
+  console.log(`已创建项目: ${targetDir}`);
+  console.log();
+  console.log('接下来执行:');
+  console.log(`  cd ${projectName}`);
+  console.log('  npm install');
+  console.log('  cp env.production.example .env   # 按需配置环境变量');
+  console.log('  npm run dev');
+  console.log();
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "create-dp-koa",
+  "version": "1.0.0",
+  "description": "Scaffold a DP-Koa framework project from the official template",
+  "type": "module",
+  "bin": {
+    "create-dp-koa": "./index.mjs"
+  },
+  "files": [
+    "index.mjs",
+    "template"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "prepublishOnly": "node ../../scripts/sync-template.mjs"
+  },
+  "dependencies": {
+    "prompts": "^2.4.2"
+  },
+  "keywords": [
+    "koa",
+    "scaffold",
+    "dp-koa",
+    "create-app"
+  ],
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git@gitee.com:rajan_admin/dp-koa-framework.git"
+  }
+}

package/template/.env.development

@@ -0,0 +1,9 @@
+# 寮€鍙戠幆澧冮厤缃甡n# 鏁版嵁搴撻厤缃甡ndb_enable=1
+db_memory=1
+
+# MySQL鏁版嵁搴撻厤缃紙褰?db_memory=0 鏃剁敓鏁堬級
+db_host=127.0.0.1
+db_port=3306
+db_username=test
+db_password=test
+db_database=test

package/template/.env.production

@@ -0,0 +1,12 @@
+host=127.0.0.1
+port=3011
+jwt_secret=eT4*fL8#uW9$mW4.pE5?yZ6`jB2[dE9.
+db_enable=1
+db_memory=0 # 关闭内存数据库
+db_type=mysql
+db_host=localhost
+db_port=3306
+db_username=ytfx
+db_password=LDrMzwBMGEwkaYYM
+db_database=ytfx
+aok_email_api_key=330b853af20ef6762f259545ef7b4c17

package/template/.github/workflows/ci-cd.yml

@@ -0,0 +1,182 @@
+name: Enterprise CI/CD Pipeline
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  NODE_VERSION: '18'
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  # 代码质量检查
+  quality-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint code
+        run: npm run lint
+
+      - name: Type check
+        run: npm run type-check
+
+      - name: Security audit
+        run: npm audit --audit-level=moderate
+
+  # 测试
+  test:
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_ROOT_PASSWORD: root
+          MYSQL_DATABASE: test_db
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm run test:coverage
+        env:
+          DB_HOST: localhost
+          DB_PORT: 3306
+          DB_USERNAME: root
+          DB_PASSWORD: root
+          DB_DATABASE: test_db
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          file: ./coverage/lcov.info
+          flags: unittests
+          name: codecov-umbrella
+
+  # 构建Docker镜像
+  build:
+    runs-on: ubuntu-latest
+    needs: [quality-check, test]
+    if: github.event_name == 'push'
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=sha,prefix={{branch}}-
+            type=raw,value=latest,enable={{is_default_branch}}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+  # 安全扫描
+  security-scan:
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'push'
+    
+    steps:
+      - name: Run Trivy vulnerability scanner
+        uses: aquasecurity/trivy-action@master
+        with:
+          image-ref: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.sha }}
+          format: 'sarif'
+          output: 'trivy-results.sarif'
+
+      - name: Upload Trivy scan results to GitHub Security tab
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: 'trivy-results.sarif'
+
+  # 部署到测试环境
+  deploy-staging:
+    runs-on: ubuntu-latest
+    needs: [build, security-scan]
+    if: github.ref == 'refs/heads/develop'
+    environment: staging
+    
+    steps:
+      - name: Deploy to staging
+        run: |
+          echo "Deploying to staging environment..."
+          # 这里添加实际的部署脚本
+
+  # 部署到生产环境
+  deploy-production:
+    runs-on: ubuntu-latest
+    needs: [build, security-scan]
+    if: github.ref == 'refs/heads/main'
+    environment: production
+    
+    steps:
+      - name: Deploy to production
+        run: |
+          echo "Deploying to production environment..."
+          # 这里添加实际的部署脚本
+
+  # 性能测试
+  performance-test:
+    runs-on: ubuntu-latest
+    needs: deploy-staging
+    if: github.ref == 'refs/heads/develop'
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Run performance tests
+        run: |
+          npm install -g artillery
+          artillery run tests/performance/load-test.yml
+