@lark-apaas/fullstack-cli 0.1.0-alpha.1

package/README.md

@@ -0,0 +1,89 @@
+# @lark-apaas/fullstack-cli
+
+> Fullstack 模板文件自动派生工具
+
+## 功能
+
+自动派生和管理 fullstack 模板项目的文件和目录。
+
+## 安装
+
+```bash
+npm install --save-dev @lark-apaas/fullstack-cli
+```
+
+## 使用
+
+### 自动派生
+
+每次运行 `npm install` 时，会根据配置自动派生文件到项目：
+
+**派生内容：**
+- `scripts/` - 脚本目录（总是覆盖）
+- `.gitignore` - 追加 fullstack-cli 相关忽略规则
+
+### 重要提示
+
+⚠️ **`scripts/` 目录由 `@lark-apaas/fullstack-cli` 自动管理，请勿手动修改！**
+
+每次安装依赖时，所有脚本文件会被自动覆盖为最新版本。
+
+## 配置
+
+派生规则通过 `src/postinstall.config.ts` 配置：
+
+```typescript
+export default {
+  // 派生规则
+  sync: [
+    // 派生整个目录
+    {
+      from: 'templates/scripts',
+      to: 'scripts',
+      type: 'directory',
+      overwrite: true,
+    },
+
+    // 追加内容到文件
+    {
+      from: 'templates/.gitignore.append',
+      to: '.gitignore',
+      type: 'append',
+    },
+  ],
+
+  // 文件权限设置
+  permissions: {
+    '**/*.sh': 0o755,
+  },
+};
+```
+
+### 支持的 sync type
+
+- **directory** - 派生整个目录
+  - `overwrite: true` - 总是覆盖
+  - `overwrite: false` - 只复制不存在的文件
+
+- **file** - 派生单个文件
+  - `overwrite: true` - 总是覆盖
+  - `overwrite: false` - 仅当文件不存在时复制
+
+- **append** - 追加内容到文件末尾
+  - 自动去重，不会重复追加
+
+## 工作原理
+
+1. 在 `postinstall` 钩子中自动运行
+2. 检测是否在用户项目中（通过 `INIT_CWD`）
+3. 读取 `dist/postinstall.config.js` 配置（由 `src/postinstall.config.ts` 编译而来）
+4. 根据配置规则派生文件/目录
+5. 设置文件权限
+
+## 自定义需求
+
+如需自定义脚本或配置，请联系框架团队。
+
+## License
+
+MIT

package/bin/sync-scripts.js

@@ -0,0 +1,185 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const fs = require('fs');
+
+// 主函数
+async function main() {
+  // 检测是否在用户项目中（通过 INIT_CWD 判断）
+  const userProjectRoot = process.env.INIT_CWD || process.cwd();
+  const pluginRoot = path.resolve(__dirname, '..');
+
+  // 如果在插件自己的目录，跳过
+  const isInstallingPlugin = __dirname.includes('/node_modules/@lark-apaas/fullstack-cli/');
+  if (isInstallingPlugin || userProjectRoot === pluginRoot) {
+    console.log('[fullstack-cli] Skip syncing (installing plugin itself)');
+    process.exit(0);
+  }
+
+  // 检查是否存在 package.json，确保是有效的项目
+  const userPackageJson = path.join(userProjectRoot, 'package.json');
+  if (!fs.existsSync(userPackageJson)) {
+    console.log('[fullstack-cli] Skip syncing (not a valid npm project)');
+    process.exit(0);
+  }
+
+  try {
+    console.log('[fullstack-cli] Starting sync...');
+
+    // 加载配置文件（从 dist 目录加载编译后的配置）
+    const configPath = path.join(pluginRoot, 'dist', 'postinstall.config.js');
+    const { default: config } = await import(`file://${configPath}`);
+
+    if (!config || !config.sync) {
+      console.warn('[fullstack-cli] No sync configuration found');
+      process.exit(0);
+    }
+
+    // 执行同步规则
+    for (const rule of config.sync) {
+      await syncRule(rule, pluginRoot, userProjectRoot);
+    }
+
+    // 设置权限
+    if (config.permissions) {
+      setPermissions(config.permissions, userProjectRoot);
+    }
+
+    console.log('[fullstack-cli] Sync completed successfully ✅');
+  } catch (error) {
+    console.error('[fullstack-cli] Failed to sync:', error.message);
+    // 不阻塞安装过程
+    process.exit(0);
+  }
+}
+
+/**
+ * 执行单个同步规则
+ */
+async function syncRule(rule, pluginRoot, userProjectRoot) {
+  const srcPath = path.join(pluginRoot, rule.from);
+  const destPath = path.join(userProjectRoot, rule.to);
+
+  if (!fs.existsSync(srcPath)) {
+    console.warn(`[fullstack-cli] Source not found: ${rule.from}`);
+    return;
+  }
+
+  switch (rule.type) {
+    case 'directory':
+      syncDirectory(srcPath, destPath, rule.overwrite);
+      break;
+    case 'file':
+      syncFile(srcPath, destPath, rule.overwrite);
+      break;
+    case 'append':
+      appendToFile(srcPath, destPath);
+      break;
+    default:
+      console.warn(`[fullstack-cli] Unknown sync type: ${rule.type}`);
+  }
+}
+
+/**
+ * 同步单个文件
+ */
+function syncFile(src, dest, overwrite = true) {
+  // 确保目标目录存在
+  const destDir = path.dirname(dest);
+  if (!fs.existsSync(destDir)) {
+    fs.mkdirSync(destDir, { recursive: true });
+  }
+
+  // 检查目标文件是否存在
+  if (fs.existsSync(dest) && !overwrite) {
+    console.log(`[fullstack-cli] ○ ${path.basename(dest)} (skipped, already exists)`);
+    return;
+  }
+
+  // 复制文件
+  fs.copyFileSync(src, dest);
+  console.log(`[fullstack-cli] ✓ ${path.basename(dest)}`);
+}
+
+/**
+ * 同步整个目录
+ */
+function syncDirectory(src, dest, overwrite = true) {
+  // 确保目标目录存在
+  if (!fs.existsSync(dest)) {
+    fs.mkdirSync(dest, { recursive: true });
+  }
+
+  // 读取源目录所有文件
+  const files = fs.readdirSync(src);
+  let count = 0;
+
+  files.forEach(file => {
+    const srcFile = path.join(src, file);
+    const destFile = path.join(dest, file);
+    const stats = fs.statSync(srcFile);
+
+    if (stats.isDirectory()) {
+      // 递归处理子目录
+      syncDirectory(srcFile, destFile, overwrite);
+    } else {
+      // 复制文件
+      if (overwrite || !fs.existsSync(destFile)) {
+        fs.copyFileSync(srcFile, destFile);
+        console.log(`[fullstack-cli] ✓ ${path.relative(dest, destFile)}`);
+        count++;
+      }
+    }
+  });
+
+  if (count > 0) {
+    console.log(`[fullstack-cli] Synced ${count} files to ${path.basename(dest)}/`);
+  }
+}
+
+/**
+ * 追加内容到文件
+ */
+function appendToFile(src, dest) {
+  const content = fs.readFileSync(src, 'utf-8');
+  
+  // 读取目标文件内容（如果存在）
+  let existingContent = '';
+  if (fs.existsSync(dest)) {
+    existingContent = fs.readFileSync(dest, 'utf-8');
+  }
+
+  // 检查是否已包含相同内容（避免重复追加）
+  if (existingContent.includes(content.trim())) {
+    console.log(`[fullstack-cli] ○ ${path.basename(dest)} (already contains content)`);
+    return;
+  }
+
+  // 追加内容
+  fs.appendFileSync(dest, content);
+  console.log(`[fullstack-cli] ✓ ${path.basename(dest)} (appended)`);
+}
+
+/**
+ * 设置文件权限
+ */
+function setPermissions(permissions, projectRoot) {
+  for (const [pattern, mode] of Object.entries(permissions)) {
+    // 简单实现：只支持 **/*.sh 这种模式
+    if (pattern === '**/*.sh') {
+      const scriptsDir = path.join(projectRoot, 'scripts');
+      if (fs.existsSync(scriptsDir)) {
+        const files = fs.readdirSync(scriptsDir);
+        files.forEach(file => {
+          if (file.endsWith('.sh')) {
+            const filePath = path.join(scriptsDir, file);
+            fs.chmodSync(filePath, mode);
+          }
+        });
+      }
+    }
+  }
+}
+
+// 运行主函数
+main();

package/dist/config/postinstall.config.d.ts

@@ -0,0 +1,22 @@
+/**
+ * fullstack-cli 派生配置
+ * 定义哪些文件/目录需要同步到用户项目
+ */
+export interface SyncRule {
+    /** 源文件/目录路径（相对于插件根目录） */
+    from: string;
+    /** 目标文件/目录路径（相对于用户项目根目录） */
+    to: string;
+    /** 同步类型 */
+    type: 'directory' | 'file' | 'append';
+    /** 是否覆盖已存在的文件（仅 directory 和 file 类型有效） */
+    overwrite?: boolean;
+}
+export interface PostinstallConfig {
+    /** 派生规则 */
+    sync: SyncRule[];
+    /** 文件权限设置 */
+    permissions?: Record<string, number>;
+}
+declare const config: PostinstallConfig;
+export default config;

package/dist/config/postinstall.config.js

@@ -0,0 +1,28 @@
+/**
+ * fullstack-cli 派生配置
+ * 定义哪些文件/目录需要同步到用户项目
+ */
+const config = {
+    // 派生规则
+    sync: [
+        // 1. 派生 scripts 目录（总是覆盖）
+        {
+            from: 'templates/scripts',
+            to: 'scripts',
+            type: 'directory',
+            overwrite: true,
+        },
+        // 2. 追加内容到 .gitignore
+        {
+            from: 'templates/.gitignore.append',
+            to: '.gitignore',
+            type: 'append',
+        },
+    ],
+    // 文件权限设置
+    permissions: {
+        // 所有 .sh 文件设置为可执行
+        '**/*.sh': 0o755,
+    },
+};
+export default config;

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @lark-apaas/fullstack-cli
+ *
+ * CLI tool for fullstack template management
+ */
+export declare const version = "1.0.0";
+declare const _default: {
+    version: string;
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,9 @@
+/**
+ * @lark-apaas/fullstack-cli
+ *
+ * CLI tool for fullstack template management
+ */
+export const version = '1.0.0';
+export default {
+    version,
+};

package/dist/postinstall.config.d.ts

@@ -0,0 +1,22 @@
+/**
+ * fullstack-cli 派生配置
+ * 定义哪些文件/目录需要同步到用户项目
+ */
+export interface SyncRule {
+    /** 源文件/目录路径（相对于插件根目录） */
+    from: string;
+    /** 目标文件/目录路径（相对于用户项目根目录） */
+    to: string;
+    /** 同步类型 */
+    type: 'directory' | 'file' | 'append';
+    /** 是否覆盖已存在的文件（仅 directory 和 file 类型有效） */
+    overwrite?: boolean;
+}
+export interface PostinstallConfig {
+    /** 派生规则 */
+    sync: SyncRule[];
+    /** 文件权限设置 */
+    permissions?: Record<string, number>;
+}
+declare const config: PostinstallConfig;
+export default config;

package/dist/postinstall.config.js

@@ -0,0 +1,34 @@
+/**
+ * fullstack-cli 派生配置
+ * 定义哪些文件/目录需要同步到用户项目
+ */
+const config = {
+    // 派生规则
+    sync: [
+        // 1. 派生 scripts 目录（总是覆盖）
+        {
+            from: 'templates/scripts',
+            to: 'scripts',
+            type: 'directory',
+            overwrite: true,
+        },
+        // 2. 追加内容到 .gitignore
+        {
+            from: 'templates/.gitignore.append',
+            to: '.gitignore',
+            type: 'append',
+        },
+        // 3. 派生 server/type.ts 文件（总是覆盖）
+        {
+            from: 'templates/server/type.ts',
+            to: 'server/type.ts',
+            type: 'file',
+        },
+    ],
+    // 文件权限设置
+    permissions: {
+        // 所有 .sh 文件设置为可执行
+        '**/*.sh': 0o755,
+    },
+};
+export default config;

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@lark-apaas/fullstack-cli",
+  "version": "0.1.0-alpha.1",
+  "description": "CLI tool for fullstack template management",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "templates",
+    "bin"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "postinstall": "node bin/sync-scripts.js"
+  },
+  "keywords": [
+    "fullstack",
+    "cli",
+    "template"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0",
+    "npm": ">=9.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.9.2"
+  }
+}

package/templates/.gitignore.append

@@ -0,0 +1 @@
+# ===

package/templates/scripts/build.sh

@@ -0,0 +1,49 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+ROOT_DIR="$(pwd)"
+OUT_DIR="$ROOT_DIR/dist/server"
+
+echo "===================="
+echo "0) 更新 openapi 代码"
+echo "===================="
+npm run gen:openapi
+
+echo "===================="
+echo "1) 清理 dist 目录"
+echo "===================="
+rm -rf "$ROOT_DIR/dist"
+
+echo "===================="
+echo "2) 构建项目"
+echo "===================="
+npm run build:prod
+echo "✅ Build completed"
+
+echo "===================="
+echo "3) 准备 server 产物目录"
+echo "===================="
+mkdir -p "$OUT_DIR/dist/client"
+
+# 拷贝 HTML
+cp "$ROOT_DIR/dist/client/"*.html "$OUT_DIR/dist/client/" || true
+
+# 拷贝 package.json
+cp "$ROOT_DIR/package.json" "$OUT_DIR/"
+[ -f "$ROOT_DIR/pnpm-lock.yaml" ] && cp "$ROOT_DIR/pnpm-lock.yaml" "$OUT_DIR/"
+
+# 拷贝 run.sh 文件
+cp "$ROOT_DIR/scripts/run.sh" "$OUT_DIR/"
+
+# 清理无用文件
+rm -rf "$ROOT_DIR/dist/scripts"
+rm -rf "$ROOT_DIR/dist/tsconfig.node.tsbuildinfo"
+
+echo "===================="
+echo "4) 复制 node_modules（仅生产依赖）"
+echo "===================="
+
+npm prune --omit=dev
+cp -R "$ROOT_DIR/node_modules" "$OUT_DIR/"
+
+echo "✅ node_modules ready"

package/templates/scripts/dev.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Ensure the script always runs from the project root
+cd "$(dirname "${BASH_SOURCE[0]}")/.."
+
+# Split and clean logs for server and client
+split_logs() {
+  local log_dir=$1
+
+  awk -v server_log="${log_dir}/server.std.log" -v client_log="${log_dir}/client.std.log" '
+  {
+    # Remove all ANSI escape sequences (not just colors)
+    gsub(/\x1b\[[0-9;]*[a-zA-Z]/, "")  # CSI sequences (colors, cursor movement, etc.)
+    gsub(/\x1b\][^\x07]*\x07/, "")     # OSC sequences
+    gsub(/\x1b[=>]/, "")                # Other escape sequences
+
+    # Write to appropriate log file and stdout
+    if ($0 ~ /\[server\]/) {
+      print $0 >> server_log
+      fflush(server_log)
+    } else if ($0 ~ /\[client\]/) {
+      print $0 >> client_log
+      fflush(client_log)
+    }
+
+    # Always print to stdout (terminal)
+    print $0
+    fflush()
+  }
+  '
+}
+
+LOG_DIR=${LOG_DIR:-logs}
+mkdir -p "${LOG_DIR}"
+
+concurrently -p "[{time}] [{name}]" -t "yyyy-MM-dd HH:mm:ss" -n "server,client" -c "blue,green" \
+  "npm run dev:server" \
+  "sleep 2 && npm run dev:client" 2>&1 | split_logs "${LOG_DIR}"

package/templates/scripts/gen-db-schema.ts

@@ -0,0 +1,48 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { spawnSync } from 'node:child_process';
+import { postprocessDrizzleSchema } from '@lark-apaas/devtool-kits';
+
+const OUT_DIR = path.resolve(process.cwd(), 'server/database/.introspect');
+const SCHEMA_FILE = path.resolve(process.cwd(), 'server/database/schema.ts');
+
+function run(): void {
+  const args = process.argv.slice(2);
+  const spawnArgs = ['--yes', 'drizzle-kit', 'introspect', '--config', 'drizzle.config.ts', ...args];
+
+  const result = spawnSync('npx', spawnArgs, { stdio: 'inherit' });
+  if (result.error) {
+    console.error('[gen-db-schema] Execution failed:', result.error);
+    process.exit(result.status ?? 1);
+  }
+
+  if ((result.status ?? 0) !== 0) {
+    process.exit(result.status ?? 1);
+  }
+
+  const generatedSchema = path.join(OUT_DIR, 'schema.ts');
+  if (!fs.existsSync(generatedSchema)) {
+    console.warn('[gen-db-schema] schema.ts not generated');
+    process.exit(1);
+  }
+
+  fs.mkdirSync(path.dirname(SCHEMA_FILE), { recursive: true });
+  fs.copyFileSync(generatedSchema, SCHEMA_FILE);
+
+  try {
+    const stats = postprocessDrizzleSchema(SCHEMA_FILE);
+    if (stats?.unmatchedUnknown?.length) {
+      console.warn('[gen-db-schema] Unmatched custom types detected');
+    }
+  } catch (error) {
+    console.warn('[gen-db-schema] postprocess failed:', error);
+  }
+
+  if (fs.existsSync(OUT_DIR)) {
+    fs.rmSync(OUT_DIR, { recursive: true, force: true });
+  }
+}
+
+if (require.main === module) {
+  run();
+}

package/templates/scripts/gen-openapi.ts

@@ -0,0 +1,24 @@
+import { NestFactory } from '@nestjs/core';
+import { DevToolsModule } from '@lark-apaas/fullstack-nestjs-core';
+
+import { AppModule } from '../server/app.module';
+
+async function generateOpenApi() {
+  const app = await NestFactory.create(AppModule, {logger: false});
+  const basePath = process.env.CLIENT_BASE_PATH;
+  app.setGlobalPrefix(basePath);
+  
+  await DevToolsModule.mount(app, {
+    basePath,
+    docsPath: '/api_docs',
+    needSetupServer: false,
+    needGenerateClientSdk: true,
+  });
+
+  await app.close();
+}
+
+generateOpenApi().catch((err) => {
+  console.error('[OpenAPI] Failed to generate schema', err);
+  process.exitCode = 1;
+});

package/templates/scripts/run.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# 生产环境下，启动服务
+npm run start

package/templates/type.ts

@@ -0,0 +1,4 @@
+export interface ServerType {
+  // 服务器类型
+  serverType: string;
+}