feat: add fba-cli add command to register existing FBA projects

yuWorm · yuWorm · commit 7bc672669abf · 2026-04-02T14:15:53.000+08:00
Scan an existing project directory to auto-detect backend/frontend
subdirectories, infrastructure, database type, and ports, then write
`.fba.json` and register the project into the global config.

Made-with: Cursor
diff --git a/src/commands/add.ts b/src/commands/add.ts
@@ -0,0 +1,310 @@
+// add.ts — 添加现有 FBA 项目到管理列表
+import * as clack from "@clack/prompts";
+import chalk from "chalk";
+import { basename, join, resolve } from "path";
+import { existsSync, readdirSync, readFileSync, statSync } from "fs";
+import { t } from "../lib/i18n.js";
+import {
+  readGlobalConfig,
+  addProject,
+  writeProjectConfig,
+} from "../lib/config.js";
+import type { ProjectConfig } from "../types/config.js";
+import type { DatabaseType } from "../lib/infra.js";
+
+// ─── 项目结构探测 ───
+
+interface DetectResult {
+  backendName: string | null;
+  frontendName: string | null;
+  hasInfra: boolean;
+  infraServices: string[];
+  dbType: DatabaseType | null;
+  serverPort: number | null;
+  webPort: number | null;
+}
+
+function isBackendDir(dir: string): boolean {
+  return (
+    existsSync(join(dir, "pyproject.toml")) &&
+    existsSync(join(dir, "backend")) &&
+    statSync(join(dir, "backend")).isDirectory()
+  );
+}
+
+function isFrontendDir(dir: string): boolean {
+  const webAppDir = join(dir, "apps", "web-antdv-next");
+  return existsSync(webAppDir) && statSync(webAppDir).isDirectory();
+}
+
+function parseBackendEnv(
+  backendDir: string,
+): { dbType: DatabaseType | null } {
+  const envPath = join(backendDir, "backend", ".env");
+  if (!existsSync(envPath)) return { dbType: null };
+
+  try {
+    const content = readFileSync(envPath, "utf-8");
+    const dbTypeMatch = content.match(
+      /DATABASE_TYPE\s*=\s*['"]?(\w+)['"]?/,
+    );
+    const dbType =
+      dbTypeMatch?.[1] === "mysql"
+        ? "mysql"
+        : dbTypeMatch?.[1] === "postgresql"
+          ? "postgresql"
+          : null;
+    return { dbType };
+  } catch {
+    return { dbType: null };
+  }
+}
+
+function parseFrontendEnv(
+  frontendDir: string,
+): { webPort: number | null } {
+  const envPath = join(
+    frontendDir,
+    "apps",
+    "web-antdv-next",
+    ".env.development",
+  );
+  if (!existsSync(envPath)) return { webPort: null };
+
+  try {
+    const content = readFileSync(envPath, "utf-8");
+    const portMatch = content.match(/VITE_PORT\s*=\s*(\d+)/);
+    return { webPort: portMatch?.[1] ? parseInt(portMatch[1]) : null };
+  } catch {
+    return { webPort: null };
+  }
+}
+
+function parseInfraServices(projectDir: string): string[] {
+  const composePath = join(projectDir, "infra", "docker-compose.yml");
+  if (!existsSync(composePath)) return [];
+
+  try {
+    const content = readFileSync(composePath, "utf-8");
+    const services: string[] = [];
+    if (content.includes("fba-postgres")) services.push("postgres");
+    if (content.includes("fba-mysql")) services.push("mysql");
+    if (content.includes("fba-redis")) services.push("redis");
+    if (content.includes("fba-rabbitmq")) services.push("rabbitmq");
+    return services;
+  } catch {
+    return [];
+  }
+}
+
+function detectProject(projectDir: string): DetectResult {
+  const result: DetectResult = {
+    backendName: null,
+    frontendName: null,
+    hasInfra: false,
+    infraServices: [],
+    dbType: null,
+    serverPort: null,
+    webPort: null,
+  };
+
+  // 扫描直接子目录
+  let entries: string[];
+  try {
+    entries = readdirSync(projectDir).filter((name) => {
+      const full = join(projectDir, name);
+      return !name.startsWith(".") && statSync(full).isDirectory();
+    });
+  } catch {
+    return result;
+  }
+
+  for (const entry of entries) {
+    const fullPath = join(projectDir, entry);
+
+    if (!result.backendName && isBackendDir(fullPath)) {
+      result.backendName = entry;
+      const { dbType } = parseBackendEnv(fullPath);
+      result.dbType = dbType;
+    }
+
+    if (!result.frontendName && isFrontendDir(fullPath)) {
+      result.frontendName = entry;
+      const { webPort } = parseFrontendEnv(fullPath);
+      result.webPort = webPort;
+    }
+  }
+
+  // 检测基础设施
+  const infraDir = join(projectDir, "infra");
+  if (existsSync(infraDir) && statSync(infraDir).isDirectory()) {
+    result.hasInfra = true;
+    result.infraServices = parseInfraServices(projectDir);
+  }
+
+  return result;
+}
+
+// ─── 命令入口 ───
+
+export async function addAction() {
+  clack.intro(chalk.bgCyan(" fba-cli add "));
+
+  // 1. 输入项目目录
+  const projectDirInput = await clack.text({
+    message: t("addProjectDir"),
+    placeholder: process.cwd(),
+    defaultValue: process.cwd(),
+    validate: (v) => {
+      const dir = v?.trim() ? resolve(v.trim()) : process.cwd();
+      if (!existsSync(dir)) return t("projectRootNotExist");
+      if (!statSync(dir).isDirectory()) return t("projectRootNotDirectory");
+      return undefined;
+    },
+  });
+  if (clack.isCancel(projectDirInput)) {
+    clack.outro(chalk.dim("Cancelled"));
+    return;
+  }
+
+  const projectDir = projectDirInput?.trim()
+    ? resolve(String(projectDirInput).trim())
+    : process.cwd();
+
+  // 检查是否已注册
+  const globalConfig = readGlobalConfig();
+  if (globalConfig.projects.some((p) => p.path === projectDir)) {
+    clack.log.error(chalk.red(t("addAlreadyRegistered")));
+    clack.outro("");
+    return;
+  }
+
+  // 2. 扫描项目结构
+  const spinner = clack.spinner();
+  spinner.start(t("addScanning"));
+  const detected = detectProject(projectDir);
+  spinner.stop(t("addScanning"));
+
+  // 3. 验证结果
+  if (!detected.backendName) {
+    clack.log.error(chalk.red(t("addNoBackend")));
+    clack.outro("");
+    return;
+  }
+  if (!detected.frontendName) {
+    clack.log.error(chalk.red(t("addNoFrontend")));
+    clack.outro("");
+    return;
+  }
+
+  // 4. 展示探测结果
+  clack.log.step(t("addConfirmDetected"));
+  clack.log.info(
+    `${chalk.bold(t("addBackendDetected"))}: ${chalk.green(detected.backendName)}`,
+  );
+  clack.log.info(
+    `${chalk.bold(t("addFrontendDetected"))}: ${chalk.green(detected.frontendName)}`,
+  );
+  clack.log.info(
+    `${chalk.bold(t("addInfraDetected"))}: ${detected.hasInfra ? chalk.green(t("addInfraYes")) : chalk.dim(t("addInfraNo"))}` +
+      (detected.infraServices.length > 0
+        ? ` (${detected.infraServices.join(", ")})`
+        : ""),
+  );
+  if (detected.dbType) {
+    clack.log.info(
+      `${chalk.bold(t("addDbTypeDetected"))}: ${chalk.green(detected.dbType)}`,
+    );
+  }
+
+  const confirmed = await clack.confirm({
+    message: t("addConfirmDetected"),
+    initialValue: true,
+  });
+  if (clack.isCancel(confirmed) || !confirmed) {
+    clack.outro(chalk.dim("Cancelled"));
+    return;
+  }
+
+  // 5. 收集需要用户输入的配置
+  const userConfig = await clack.group(
+    {
+      projectName: () =>
+        clack.text({
+          message: t("addProjectName"),
+          placeholder: basename(projectDir),
+          defaultValue: basename(projectDir),
+          validate: (v) => {
+            if (!v?.trim()) return t("projectNameRequired");
+            return undefined;
+          },
+        }),
+      dbType: () => {
+        if (detected.dbType) return Promise.resolve(detected.dbType);
+        return clack.select({
+          message: t("dbTypeSelect"),
+          options: [
+            { value: "postgresql", label: t("infraPostgres") },
+            { value: "mysql", label: t("infraMysql") },
+          ],
+        });
+      },
+      serverPort: () =>
+        clack.text({
+          message: t("addServerPort"),
+          defaultValue: "8000",
+        }),
+      webPort: () =>
+        clack.text({
+          message: t("addWebPort"),
+          defaultValue: detected.webPort ? String(detected.webPort) : "5173",
+        }),
+    },
+    {
+      onCancel: () => {
+        clack.outro(chalk.dim("Cancelled"));
+        process.exit(0);
+      },
+    },
+  );
+
+  const projectName = String(userConfig.projectName).trim();
+  const dbType = String(userConfig.dbType) as DatabaseType;
+  const serverPort = parseInt(String(userConfig.serverPort)) || 8000;
+  const webPort = parseInt(String(userConfig.webPort)) || 5173;
+
+  // 6. 写入项目配置
+  const projConfig: ProjectConfig = {
+    name: projectName,
+    backend_name: detected.backendName,
+    frontend_name: detected.frontendName,
+    server_port: serverPort,
+    web_port: webPort,
+    infra: detected.hasInfra,
+    infra_services: detected.infraServices,
+    db_type: dbType,
+  };
+  writeProjectConfig(projectDir, projConfig);
+
+  // 7. 注册到全局配置
+  addProject({
+    name: projectName,
+    path: projectDir,
+    createdAt: new Date().toISOString(),
+  });
+
+  // 8. 完成
+  clack.log.success(chalk.green.bold(t("addSuccess")));
+  clack.note(
+    [
+      `${chalk.bold(t("addProjectName"))}: ${projectName}`,
+      `${chalk.bold(t("addBackendDetected"))}: ${detected.backendName}`,
+      `${chalk.bold(t("addFrontendDetected"))}: ${detected.frontendName}`,
+      `${chalk.bold(t("addDbTypeDetected"))}: ${dbType}`,
+      `${chalk.bold(t("serverPort"))}: ${serverPort}`,
+      `${chalk.bold(t("webPort"))}: ${webPort}`,
+    ].join("\n"),
+    projectDir,
+  );
+  clack.outro(chalk.cyan(t("happyCoding")));
+}
diff --git a/src/index.ts b/src/index.ts
@@ -46,6 +46,15 @@ program
     await createAction()
   })
 
+// ─── add ───
+program
+  .command('add')
+  .description(t('cmdAdd'))
+  .action(async () => {
+    const { addAction } = await import('./commands/add.js')
+    await addAction()
+  })
+
 // ─── dev ───
 program
   .command('dev')
diff --git a/src/lib/i18n.ts b/src/lib/i18n.ts
@@ -153,6 +153,27 @@ const messages = {
     pluginNameAutoSuffix: "前端插件名称已自动添加 _ui 后缀",
     pluginMarketCacheUsed: "网络不可用，使用本地缓存数据",
 
+    // Add existing project
+    addProjectDir: "项目目录路径",
+    addScanning: "正在扫描项目结构...",
+    addBackendDetected: "后端目录",
+    addFrontendDetected: "前端目录",
+    addInfraDetected: "基础设施",
+    addInfraYes: "已检测到",
+    addInfraNo: "未检测到",
+    addDbTypeDetected: "数据库类型",
+    addNoBackend: "未找到有效的后端目录 (需包含 pyproject.toml 和 backend/ 子目录)",
+    addNoFrontend: "未找到有效的前端目录 (需包含 apps/web-antdv-next/ 子目录)",
+    addNotSameParent: "前后端目录必须在同一项目目录下",
+    addAlreadyRegistered: "该项目已注册",
+    addConfirmDetected: "检测到以下项目结构，是否正确？",
+    addProjectName: "项目名称",
+    addServerPort: "后端服务端口",
+    addWebPort: "前端服务端口",
+    addSuccess: "项目添加成功!",
+    addDetectFailed: "项目结构验证失败",
+    cmdAdd: "添加现有 FBA 项目到管理列表",
+
     // Completion
     createSuccess: "项目创建成功!",
     nextSteps: "下一步",
@@ -403,6 +424,27 @@ const messages = {
     pluginNameAutoSuffix: "Frontend plugin name auto-appended with _ui suffix",
     pluginMarketCacheUsed: "Network unavailable, using local cache",
 
+    // Add existing project
+    addProjectDir: "Project directory path",
+    addScanning: "Scanning project structure...",
+    addBackendDetected: "Backend directory",
+    addFrontendDetected: "Frontend directory",
+    addInfraDetected: "Infrastructure",
+    addInfraYes: "detected",
+    addInfraNo: "not detected",
+    addDbTypeDetected: "Database type",
+    addNoBackend: "No valid backend directory found (must contain pyproject.toml and backend/ subdirectory)",
+    addNoFrontend: "No valid frontend directory found (must contain apps/web-antdv-next/ subdirectory)",
+    addNotSameParent: "Frontend and backend must be in the same project directory",
+    addAlreadyRegistered: "This project is already registered",
+    addConfirmDetected: "Detected the following project structure. Is this correct?",
+    addProjectName: "Project name",
+    addServerPort: "Backend server port",
+    addWebPort: "Frontend server port",
+    addSuccess: "Project added successfully!",
+    addDetectFailed: "Project structure validation failed",
+    cmdAdd: "Add an existing FBA project to the managed list",
+
     createSuccess: "Project created successfully!",
     nextSteps: "Next steps",
 
