@spaceflow/core 0.8.0 → 0.9.0

package/src/commands/runx/runx.utils.ts

@@ -0,0 +1,83 @@
+/**
+ * Runx 命令参数解析工具
+ */
+
+export interface RunxParsedArgs {
+  cmdIndex: number;
+  sourceIndex: number;
+  source: string;
+  args: string[];
+}
+
+/**
+ * 查找 runx/x 命令在 argv 中的位置
+ */
+export function findRunxCmdIndex(argv: string[]): number {
+  return argv.findIndex((arg) => arg === "runx" || arg === "x");
+}
+
+/**
+ * 判断参数是否为 -n/--name 选项
+ */
+export function isNameOption(arg: string): boolean {
+  return arg === "-n" || arg === "--name" || arg.startsWith("-n=") || arg.startsWith("--name=");
+}
+
+/**
+ * 判断参数是否为 -n/--name 选项（需要跳过下一个参数）
+ */
+export function isNameOptionWithValue(arg: string): boolean {
+  return arg === "-n" || arg === "--name";
+}
+
+/**
+ * 从参数列表中找到 source（跳过 -n/--name 选项）
+ */
+export function findSourceInArgs(args: string[]): { index: number; source: string } {
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    if (isNameOptionWithValue(arg)) {
+      i++; // 跳过选项值
+      continue;
+    }
+    if (isNameOption(arg)) {
+      continue;
+    }
+    if (!arg.startsWith("-")) {
+      return { index: i, source: arg };
+    }
+  }
+  return { index: -1, source: "" };
+}
+
+/**
+ * 解析 runx 命令的完整参数
+ */
+export function parseRunxArgs(argv: string[]): RunxParsedArgs {
+  const cmdIndex = findRunxCmdIndex(argv);
+  if (cmdIndex === -1) {
+    return { cmdIndex: -1, sourceIndex: -1, source: "", args: [] };
+  }
+  const separatorIndex = argv.indexOf("--");
+  if (separatorIndex === -1) {
+    // 没有分隔符
+    const remaining = argv.slice(cmdIndex + 1);
+    const { index, source } = findSourceInArgs(remaining);
+    return {
+      cmdIndex,
+      sourceIndex: index === -1 ? -1 : cmdIndex + 1 + index,
+      source,
+      args: [],
+    };
+  }
+  // 有分隔符
+  const beforeSeparator = argv.slice(cmdIndex + 1, separatorIndex);
+  const afterSeparator = argv.slice(separatorIndex + 1);
+  const { index, source } = findSourceInArgs(beforeSeparator);
+  return {
+    cmdIndex,
+    sourceIndex: index === -1 ? -1 : cmdIndex + 1 + index,
+    source,
+    args: afterSeparator,
+  };
+}

package/src/commands/schema/index.ts

@@ -0,0 +1,30 @@
+import { defineExtension, SchemaGeneratorService } from "@spaceflow/core";
+
+/**
+ * Schema 命令扩展
+ */
+export const schemaExtension = defineExtension({
+  name: "schema",
+  version: "1.0.0",
+  description: "生成 schema",
+  commands: [
+    {
+      name: "schema",
+      description: "生成 JSON Schema 配置文件",
+      options: [
+        {
+          flags: "-o, --output <path>",
+          description: "输出路径",
+        },
+      ],
+      run: async (_args, options, _ctx) => {
+        const schemaGenerator = new SchemaGeneratorService();
+        if (options?.output) {
+          schemaGenerator.generateJsonSchema(options.output as string);
+        } else {
+          schemaGenerator.generate();
+        }
+      },
+    },
+  ],
+});

package/src/commands/setup/index.ts

@@ -0,0 +1,34 @@
+import { defineExtension, SchemaGeneratorService } from "@spaceflow/core";
+import { SetupService } from "./setup.service";
+
+/**
+ * Setup 命令扩展
+ */
+export const setupExtension = defineExtension({
+  name: "setup",
+  version: "1.0.0",
+  description: "设置配置",
+  commands: [
+    {
+      name: "setup",
+      description: "设置配置",
+      options: [
+        {
+          flags: "-g, --global",
+          description: "全局设置",
+        },
+      ],
+      run: async (_args, options, _ctx) => {
+        const schemaGenerator = new SchemaGeneratorService();
+        const setupService = new SetupService(schemaGenerator);
+        if (options?.global) {
+          await setupService.setupGlobal();
+        } else {
+          await setupService.setupLocal();
+        }
+      },
+    },
+  ],
+});
+
+export * from "./setup.service";

package/src/commands/setup/setup.service.ts

@@ -0,0 +1,234 @@
+import { existsSync, readFileSync, writeFileSync } from "fs";
+import { t } from "@spaceflow/core";
+import { join } from "path";
+import { homedir } from "os";
+import stringify from "json-stringify-pretty-compact";
+import {
+  CONFIG_FILE_NAME,
+  RC_FILE_NAME,
+  getConfigPath,
+  readConfigSync,
+  type SpaceflowConfig,
+  SchemaGeneratorService,
+  SPACEFLOW_DIR,
+  ensureSpaceflowPackageJson,
+} from "@spaceflow/core";
+
+export class SetupService {
+  constructor(private readonly schemaGenerator: SchemaGeneratorService) {}
+  /**
+   * 本地初始化：创建 .spaceflow/ 目录和 package.json
+   */
+  async setupLocal(): Promise<void> {
+    const cwd = process.cwd();
+
+    // 1. 创建 .spaceflow/ 目录和 package.json
+    const spaceflowDir = join(cwd, SPACEFLOW_DIR);
+    ensureSpaceflowPackageJson(spaceflowDir);
+    console.log(t("setup:dirCreated", { dir: spaceflowDir }));
+
+    // 2. 创建 spaceflow.json 配置文件（运行时配置）
+    const configPath = getConfigPath(cwd);
+    const rcPath = join(cwd, RC_FILE_NAME);
+    if (!existsSync(configPath) && !existsSync(rcPath)) {
+      this.schemaGenerator.generate();
+      const defaultConfig: Partial<SpaceflowConfig> = {
+        $schema: "./config-schema.json",
+        support: ["claudeCode"],
+      };
+      writeFileSync(configPath, stringify(defaultConfig, { indent: 2 }) + "\n");
+      console.log(t("setup:configGenerated", { path: configPath }));
+    } else {
+      const existingPath = existsSync(rcPath) ? rcPath : configPath;
+      console.log(t("setup:configExists", { path: existingPath }));
+    }
+  }
+
+  /**
+   * 全局初始化：创建 ~/.spaceflow/ 目录和 package.json，并合并配置
+   */
+  async setupGlobal(): Promise<void> {
+    const cwd = process.cwd();
+    const globalDir = join(homedir(), SPACEFLOW_DIR);
+    const globalConfigPath = join(globalDir, CONFIG_FILE_NAME);
+
+    // 1. 创建 ~/.spaceflow/ 目录和 package.json
+    ensureSpaceflowPackageJson(globalDir);
+    console.log(t("setup:dirCreated", { dir: globalDir }));
+
+    // 读取本地配置（支持 .spaceflow/spaceflow.json 和 .spaceflowrc）
+    const localConfig = readConfigSync(cwd);
+    if (Object.keys(localConfig).length > 0) {
+      console.log(t("setup:localConfigRead"));
+    }
+
+    // 读取本地 .env 文件并解析为配置
+    const envPath = join(cwd, ".env");
+    const envConfig = this.parseEnvToConfig(envPath);
+
+    const instanceConfig = (global as any).spaceflowConfig ?? {};
+
+    // 合并配置：本地配置（已含全局） < 实例配置 < 环境变量配置
+    const mergedConfig = this.deepMerge(localConfig, instanceConfig, envConfig);
+
+    // 写入全局配置
+    writeFileSync(globalConfigPath, stringify(mergedConfig, { indent: 2 }) + "\n");
+    console.log(t("setup:globalConfigGenerated", { path: globalConfigPath }));
+
+    // 显示合并的环境变量
+    if (Object.keys(envConfig).length > 0) {
+      console.log(t("setup:envConfigMerged"));
+      this.printConfigTree(envConfig, "   ");
+    }
+  }
+
+  /**
+   * 解析 .env 文件为配置对象
+   * 支持嵌套格式：SPACEFLOW_GIT_PROVIDER_SERVER_URL -> { gitProvider: { serverUrl: "..." } }
+   */
+  private parseEnvToConfig(envPath: string): Record<string, unknown> {
+    if (!existsSync(envPath)) {
+      return {};
+    }
+
+    const config: Record<string, unknown> = {};
+
+    try {
+      const content = readFileSync(envPath, "utf-8");
+      const lines = content.split("\n");
+
+      for (const line of lines) {
+        const trimmed = line.trim();
+        // 跳过空行和注释
+        if (!trimmed || trimmed.startsWith("#")) continue;
+
+        const eqIndex = trimmed.indexOf("=");
+        if (eqIndex === -1) continue;
+
+        const key = trimmed.slice(0, eqIndex).trim();
+        let value = trimmed.slice(eqIndex + 1).trim();
+
+        // 移除引号
+        if (
+          (value.startsWith('"') && value.endsWith('"')) ||
+          (value.startsWith("'") && value.endsWith("'"))
+        ) {
+          value = value.slice(1, -1);
+        }
+
+        // 只处理 SPACEFLOW_ 前缀的环境变量
+        if (!key.startsWith("SPACEFLOW_")) continue;
+
+        // 转换为嵌套配置
+        // SPACEFLOW_GIT_PROVIDER_SERVER_URL -> gitProvider.serverUrl
+        const parts = key
+          .slice("SPACEFLOW_".length)
+          .toLowerCase()
+          .split("_")
+          .map((part, index) => {
+            // 第一个部分保持小写，后续部分转为 camelCase
+            if (index === 0) return part;
+            return part.charAt(0).toUpperCase() + part.slice(1);
+          });
+
+        // 重新组织为嵌套结构
+        // 例如: ["git", "Provider", "Server", "Url"] -> { gitProviderServerUrl: value }
+        // 简化处理：按照常见模式分组
+        this.setNestedValue(config, parts, value);
+      }
+
+      console.log(t("setup:envRead", { path: envPath }));
+    } catch {
+      console.warn(t("setup:envReadFailed", { path: envPath }));
+    }
+
+    return config;
+  }
+
+  /**
+   * 设置嵌套值
+   * 例如: ["review", "Gitea", "Server", "Url"] 和 value
+   * 结果: { review: { giteaServerUrl: value } }
+   */
+  private setNestedValue(obj: Record<string, unknown>, parts: string[], value: string): void {
+    if (parts.length === 0) return;
+
+    // 第一个部分作为顶级 key（如 review, commit 等）
+    const topKey = parts[0];
+
+    if (parts.length === 1) {
+      obj[topKey] = value;
+      return;
+    }
+
+    // 剩余部分合并为 camelCase 作为嵌套 key
+    // 例如: ["Gitea", "Server", "Url"] -> giteaServerUrl
+    const restParts = parts.slice(1);
+    const nestedKey = restParts
+      .map((part, index) => (index === 0 ? part.toLowerCase() : part))
+      .join("");
+
+    if (!obj[topKey] || typeof obj[topKey] !== "object") {
+      obj[topKey] = {};
+    }
+
+    (obj[topKey] as Record<string, unknown>)[nestedKey] = value;
+  }
+
+  /**
+   * 深度合并对象
+   */
+  private deepMerge<T extends Record<string, unknown>>(...objects: Partial<T>[]): Partial<T> {
+    const result: Record<string, unknown> = {};
+
+    for (const obj of objects) {
+      for (const key in obj) {
+        const value = obj[key];
+        const existing = result[key];
+
+        if (
+          value !== null &&
+          typeof value === "object" &&
+          !Array.isArray(value) &&
+          existing !== null &&
+          typeof existing === "object" &&
+          !Array.isArray(existing)
+        ) {
+          result[key] = this.deepMerge(
+            existing as Record<string, unknown>,
+            value as Record<string, unknown>,
+          );
+        } else if (value !== undefined) {
+          result[key] = value;
+        }
+      }
+    }
+
+    return result as Partial<T>;
+  }
+
+  /**
+   * 打印配置树
+   */
+  private printConfigTree(config: Record<string, unknown>, prefix: string): void {
+    for (const [key, value] of Object.entries(config)) {
+      if (typeof value === "object" && value !== null && !Array.isArray(value)) {
+        console.log(`${prefix}${key}:`);
+        this.printConfigTree(value as Record<string, unknown>, prefix + "  ");
+      } else {
+        // 隐藏敏感值
+        const displayValue = this.isSensitiveKey(key) ? "***" : String(value);
+        console.log(`${prefix}${key}: ${displayValue}`);
+      }
+    }
+  }
+
+  /**
+   * 判断是否为敏感 key
+   */
+  private isSensitiveKey(key: string): boolean {
+    const sensitivePatterns = ["token", "secret", "password", "key", "apikey"];
+    const lowerKey = key.toLowerCase();
+    return sensitivePatterns.some((pattern) => lowerKey.includes(pattern));
+  }
+}

package/src/commands/uninstall/index.ts

@@ -0,0 +1,42 @@
+import { defineExtension, type VerboseLevel } from "@spaceflow/core";
+import { UninstallService } from "./uninstall.service";
+
+/**
+ * Uninstall 命令扩展
+ */
+export const uninstallExtension = defineExtension({
+  name: "uninstall",
+  version: "1.0.0",
+  description: "卸载 Extension",
+  commands: [
+    {
+      name: "uninstall",
+      description: "卸载 Extension",
+      aliases: ["un"],
+      arguments: "<name>",
+      options: [
+        {
+          flags: "-g, --global",
+          description: "全局卸载",
+        },
+        {
+          flags: "-v, --verbose",
+          description: "详细输出",
+        },
+      ],
+      run: async (args, options, ctx) => {
+        const name = args[0];
+        if (!name) {
+          ctx.output.error("请指定要卸载的扩展名称");
+          process.exit(1);
+        }
+        const verbose = (options?.verbose ? 2 : 1) as VerboseLevel;
+        const isGlobal = !!options?.global;
+        const uninstallService = new UninstallService();
+        await uninstallService.execute(name, isGlobal, verbose);
+      },
+    },
+  ],
+});
+
+export * from "./uninstall.service";

package/src/commands/uninstall/uninstall.service.ts

@@ -0,0 +1,166 @@
+import { execSync } from "child_process";
+import { readFile, rm } from "fs/promises";
+import { join } from "path";
+import { existsSync, readdirSync } from "fs";
+import { shouldLog, type VerboseLevel, t } from "@spaceflow/core";
+import { getEditorDirName } from "@spaceflow/core";
+import { detectPackageManager } from "@spaceflow/core";
+import { getSpaceflowDir } from "@spaceflow/core";
+import { getConfigPath, getSupportedEditors, removeDependency } from "@spaceflow/core";
+
+export class UninstallService {
+  /**
+   * 从 .spaceflow/node_modules/ 目录卸载 Extension
+   * 所有类型的 Extension 都通过 pnpm remove 卸载
+   */
+  private async uninstallExtension(
+    name: string,
+    isGlobal: boolean = false,
+    verbose: VerboseLevel = 1,
+  ): Promise<void> {
+    const spaceflowDir = getSpaceflowDir(isGlobal);
+
+    if (shouldLog(verbose, 1)) {
+      console.log(t("uninstall:uninstallingExtension", { name }));
+      console.log(t("uninstall:targetDir", { dir: spaceflowDir }));
+    }
+
+    const pm = detectPackageManager(spaceflowDir);
+    let cmd: string;
+    if (pm === "pnpm") {
+      cmd = `pnpm remove --prefix "${spaceflowDir}" ${name}`;
+    } else {
+      cmd = `npm uninstall --prefix "${spaceflowDir}" ${name}`;
+    }
+
+    try {
+      execSync(cmd, {
+        cwd: process.cwd(),
+        stdio: verbose ? "inherit" : "pipe",
+      });
+    } catch {
+      if (shouldLog(verbose, 1)) console.warn(t("uninstall:extensionUninstallFailed", { name }));
+    }
+  }
+
+  /**
+   * 执行卸载
+   */
+  async execute(name: string, isGlobal = false, verbose: VerboseLevel = 1): Promise<void> {
+    if (shouldLog(verbose, 1)) {
+      if (isGlobal) {
+        console.log(t("uninstall:uninstallingGlobal", { name }));
+      } else {
+        console.log(t("uninstall:uninstalling", { name }));
+      }
+    }
+
+    const cwd = process.cwd();
+    const configPath = getConfigPath(cwd);
+
+    // 1. 读取配置获取 source
+    const dependencies = await this.parseSkillsFromConfig(configPath);
+    let actualName = name;
+    let config = dependencies[name];
+
+    // 如果通过 name 找不到，尝试通过 source 值查找（支持 @spaceflow/review 这样的 npm 包名）
+    if (!config) {
+      for (const [key, value] of Object.entries(dependencies)) {
+        if (value === name) {
+          actualName = key;
+          config = value;
+          if (shouldLog(verbose, 1)) console.log(t("uninstall:foundDependency", { key, value }));
+          break;
+        }
+      }
+    }
+
+    if (!config && !isGlobal) {
+      throw new Error(t("uninstall:notRegistered", { name }));
+    }
+
+    // 使用实际的 name 进行后续操作
+    name = actualName;
+
+    // 2. 从 .spaceflow/node_modules/ 卸载 Extension
+    await this.uninstallExtension(name, isGlobal, verbose);
+
+    // 3. 删除各个编辑器 commands/skills 中的复制文件
+    const editors = getSupportedEditors(cwd);
+    const home = process.env.HOME || process.env.USERPROFILE || "~";
+
+    for (const editor of editors) {
+      const editorDirName = getEditorDirName(editor);
+      const installRoot = isGlobal ? join(home, editorDirName) : join(cwd, editorDirName);
+      await this.removeEditorFiles(installRoot, name, verbose);
+    }
+
+    // 4. 从配置文件中移除（仅本地安装）
+    if (!isGlobal && config) {
+      this.removeFromConfig(name, cwd, verbose);
+    }
+
+    if (shouldLog(verbose, 1)) console.log(t("uninstall:uninstallDone"));
+  }
+
+  /**
+   * 删除编辑器目录中的 commands/skills 文件
+   * install 现在是复制文件到编辑器目录，所以卸载时需要删除这些复制的文件/目录
+   */
+  private async removeEditorFiles(
+    installRoot: string,
+    name: string,
+    verbose: VerboseLevel = 1,
+  ): Promise<void> {
+    // 删除 skills 目录中的文件
+    const skillsDir = join(installRoot, "skills");
+    if (existsSync(skillsDir)) {
+      const entries = readdirSync(skillsDir);
+      for (const entry of entries) {
+        // 匹配 name 或 name-xxx 格式
+        if (entry === name || entry.startsWith(`${name}-`)) {
+          const targetPath = join(skillsDir, entry);
+          if (shouldLog(verbose, 1)) console.log(t("uninstall:deletingSkill", { entry }));
+          await rm(targetPath, { recursive: true, force: true });
+        }
+      }
+    }
+
+    // 删除 commands 目录中的 .md 文件
+    const commandsDir = join(installRoot, "commands");
+    if (existsSync(commandsDir)) {
+      const entries = readdirSync(commandsDir);
+      for (const entry of entries) {
+        // 匹配 name.md 或 name-xxx.md 格式
+        if (entry === `${name}.md` || entry.startsWith(`${name}-`)) {
+          const targetPath = join(commandsDir, entry);
+          if (shouldLog(verbose, 1)) console.log(t("uninstall:deletingCommand", { entry }));
+          await rm(targetPath, { force: true });
+        }
+      }
+    }
+  }
+
+  /**
+   * 从配置文件解析 dependencies
+   */
+  private async parseSkillsFromConfig(configPath: string): Promise<Record<string, unknown>> {
+    try {
+      const content = await readFile(configPath, "utf-8");
+      const config = JSON.parse(content);
+      return config.dependencies || {};
+    } catch {
+      return {};
+    }
+  }
+
+  /**
+   * 从配置文件中移除依赖
+   */
+  private removeFromConfig(name: string, cwd: string, verbose: VerboseLevel = 1): void {
+    const removed = removeDependency(name, cwd);
+    if (removed && shouldLog(verbose, 1)) {
+      console.log(t("uninstall:configUpdated", { path: getConfigPath(cwd) }));
+    }
+  }
+}

package/src/commands/update/index.ts

@@ -0,0 +1,42 @@
+import { defineExtension, type VerboseLevel } from "@spaceflow/core";
+import { UpdateService } from "./update.service";
+
+/**
+ * Update 命令扩展
+ */
+export const updateExtension = defineExtension({
+  name: "update",
+  version: "1.0.0",
+  description: "更新 Extension",
+  commands: [
+    {
+      name: "update",
+      description: "更新 Extension",
+      arguments: "[name]",
+      options: [
+        {
+          flags: "-a, --all",
+          description: "更新所有扩展",
+        },
+        {
+          flags: "-v, --verbose",
+          description: "详细输出",
+        },
+      ],
+      run: async (args, options, _ctx) => {
+        const name = args[0];
+        const verbose = (options?.verbose ? 2 : 1) as VerboseLevel;
+        const updateService = new UpdateService();
+        if (options?.all) {
+          await updateService.updateAll(verbose);
+        } else if (name) {
+          await updateService.updateDependency(name, verbose);
+        } else {
+          await updateService.updateSelf(verbose);
+        }
+      },
+    },
+  ],
+});
+
+export * from "./update.service";