@xubill/xx-cli 2.0.4

package/lib/plugins/plugin-manager.js

@@ -0,0 +1,700 @@
+/**
+ * 插件管理插件
+ * 用于管理所有插件
+ *
+ * 命令说明：
+ * - plugin [options]：管理所有插件
+ *   - 示例：plugin list
+ *   - 示例：plugin enable <plugin>
+ *   - 示例：plugin disable <plugin>
+ *   - 示例：plugin add <url>
+ *   - 示例：plugin remove <plugin>
+ *   - 示例：plugin create <name>
+ *   - 示例：plugin config <plugin> [key] [value]
+ *
+ * 功能说明：
+ * - 列出所有插件
+ * - 启用指定插件
+ * - 禁用指定插件
+ * - 添加外部插件
+ * - 删除指定插件
+ * - 创建指定名称的插件模板
+ * - 查看和设置插件配置
+ *
+ * 用户体验：
+ * - 使用标准化的用户提示
+ * - 提供清晰的错误提示
+ * - 支持命令行参数
+ */
+
+const fs = require("fs-extra");
+const path = require("path");
+const https = require("https");
+const http = require("http");
+const { createPluginsHelper } = require("../utils/plugins-helper");
+const validator = require("../utils/validator");
+const pluginConfig = require("../utils/plugin-config");
+
+/**
+ * 插件管理类
+ * 封装所有插件管理相关的方法
+ */
+class PluginManager {
+  constructor() {
+    // 获取用户主目录，添加 process.cwd() 作为 fallback
+    this.homeDir = process.env.HOME || process.env.USERPROFILE || process.cwd();
+    this.xxDir = path.join(this.homeDir, ".xx-cli");
+    this.builtinPluginsDir = path.join(__dirname, "../plugins");
+    this.userPluginsDir = path.join(this.xxDir, "plugins");
+  }
+
+  /**
+   * 列出所有插件
+   * @param {Object} helper - 插件帮助器
+   */
+  listPlugins(helper) {
+    const core = require("../core");
+    const pluginsInfo = core.getPluginsInfo();
+    helper.showInfo("\n可用插件列表:");
+    helper.showInfo("=====================================");
+    pluginsInfo.forEach((plugin) => {
+      const isDisabled = pluginConfig.isPluginDisabled(plugin.name);
+      const status = isDisabled ? "[已禁用]" : "[已启用]";
+      helper.showInfo(`- ${plugin.name} ${status}`);
+    });
+    helper.showInfo("=====================================");
+    helper.showInfo(`总计: ${pluginsInfo.length} 个插件\n`);
+  }
+
+  /**
+   * 启用插件
+   * @param {string} pluginName - 插件名称
+   * @param {Object} helper - 插件帮助器
+   */
+  enablePlugin(pluginName, helper) {
+    // 验证插件名称
+    if (!validator.validateCommandParam(pluginName)) {
+      helper.showError("错误: 插件名称包含无效字符");
+      return;
+    }
+
+    // 启用插件
+    pluginConfig.enablePlugin(pluginName);
+    helper.showSuccess(`已启用插件: ${pluginName}`);
+    helper.showInfo("提示: 请重新运行命令以应用更改");
+  }
+
+  /**
+   * 禁用插件
+   * @param {string} pluginName - 插件名称
+   * @param {Object} helper - 插件帮助器
+   */
+  disablePlugin(pluginName, helper) {
+    // 验证插件名称
+    if (!validator.validateCommandParam(pluginName)) {
+      helper.showError("错误: 插件名称包含无效字符");
+      return;
+    }
+
+    // 禁用插件
+    pluginConfig.disablePlugin(pluginName);
+    helper.showSuccess(`已禁用插件: ${pluginName}`);
+    helper.showInfo("提示: 请重新运行命令以应用更改");
+  }
+
+  /**
+   * 删除插件
+   * @param {string} pluginName - 插件名称
+   * @param {Object} helper - 插件帮助器
+   */
+  removePlugin(pluginName, helper) {
+    // 验证插件名称
+    if (!validator.validateCommandParam(pluginName)) {
+      helper.showError("错误: 插件名称包含无效字符");
+      return;
+    }
+
+    // 构建插件文件路径
+    const pluginFileName = `${pluginName}.js`;
+    let pluginPath = path.join(this.builtinPluginsDir, pluginFileName);
+
+    // 如果内置插件目录中不存在，则从用户插件目录查找
+    if (!fs.existsSync(pluginPath)) {
+      pluginPath = path.join(this.userPluginsDir, pluginFileName);
+    }
+
+    // 检查插件文件是否存在
+    if (!fs.existsSync(pluginPath)) {
+      helper.showError(`错误: 插件文件不存在`);
+      return;
+    }
+
+    try {
+      // 删除插件文件
+      fs.unlinkSync(pluginPath);
+
+      // 从配置中移除插件的禁用状态
+      pluginConfig.removePluginFromConfig(pluginName);
+
+      helper.showSuccess(`已成功删除插件: ${pluginName}`);
+      helper.showInfo("提示: 请重新运行命令以应用更改");
+    } catch (error) {
+      helper.showError(`删除插件失败: ${error.message}`);
+    }
+  }
+
+  /**
+   * 转换为驼峰命名
+   * @param {string} str - 字符串
+   * @returns {string} 驼峰命名的字符串
+   */
+  toCamelCase(str) {
+    if (!str) {
+      return "Plugin";
+    }
+    return str
+      .replace(/-([a-zA-Z])/g, (g) => g[1].toUpperCase())
+      .replace(/^[a-zA-Z]/, (g) => g.toUpperCase());
+  }
+
+  /**
+   * 生成插件模板内容
+   * @param {string} name - 插件名称
+   * @param {string} format - 插件格式，new 或 old
+   * @returns {string} 插件模板内容
+   */
+  generatePluginTemplate(name, format) {
+    // 参数检查
+    if (!name) {
+      throw new Error("插件名称不能为空");
+    }
+
+    // 生成插件命令名称（去除后缀，转小写，连字符转驼峰）
+    const commandName = name
+      .replace(".js", "")
+      .toLowerCase()
+      .replace(/-([a-zA-Z])/g, (g) => g[1].toUpperCase());
+
+    // 生成驼峰命名的类名
+    const className = this.toCamelCase(name);
+
+    // 生成配置对象格式模板，包含类结构实现
+    return `/**
+ * ${name} 插件
+ * 用于实现 ${name} 相关功能
+ * 
+ * 命令说明：
+ * - ${commandName} [options]：${name} 相关功能
+ *   - 示例：${commandName}
+ * 
+ * 功能说明：
+ * - 实现 ${name} 相关功能
+ * 
+ * 用户体验：
+ * - 使用标准化的用户提示
+ * - 提供清晰的错误提示
+ * - 支持命令行参数
+ */
+
+/**
+ * ${name} 插件类
+ * 实现 ${name} 相关核心功能
+ */
+class ${className}Plugin {
+  constructor() {
+    this.pluginName = '${name}';
+  }
+
+  /**
+   * 执行 ${name} 命令
+   * @param {Array} args - 命令参数
+   * @param {Object} options - 命令选项
+   * @param {Object} helper - 插件帮助器
+   */
+  async execute(args, options, helper) {
+    helper.showInfo('${name} 命令执行成功！');
+    if (options && options.verbose) {
+      helper.showInfo('详细信息:');
+      helper.showInfo('- 命令名称: ${commandName}');
+      helper.showInfo('- 执行时间: ' + new Date().toLocaleString());
+    }
+  }
+}
+
+// 创建插件实例
+const pluginInstance = new ${className}Plugin();
+
+module.exports = {
+  name: "${commandName}",
+  alias: "${commandName.charAt(0)}",
+  description: "${name} 相关功能",
+  options: [
+    {
+      name: "-v, --verbose",
+      description: "显示详细信息",
+    },
+    {
+      name: "-h, --help",
+      description: "显示帮助信息",
+    },
+  ],
+  action: async (args, options, helper) => {
+    await pluginInstance.execute(args, options, helper);
+  },
+};
+`;
+  }
+
+  /**
+   * 创建插件
+   * @param {string} name - 插件名称
+   * @param {Object} options - 选项
+   * @param {Object} helper - 插件帮助器
+   */
+  async createPlugin(name, options, helper) {
+    try {
+      helper.showInfo("创建插件模板...");
+
+      // 插件目录路径（用户插件目录，不会被重新安装影响）
+      const pluginsDir = this.userPluginsDir;
+      const pluginFileName = `${name}.js`;
+      const pluginPath = path.join(pluginsDir, pluginFileName);
+
+      // 检查插件是否已存在
+      if (fs.existsSync(pluginPath)) {
+        helper.showInfo(`插件 ${name} 已存在，请使用其他名称`);
+        return;
+      }
+
+      // 生成插件模板内容
+      const format = options.format || "new";
+      const pluginContent = this.generatePluginTemplate(name, format);
+
+      // 写入插件文件
+      await fs.writeFile(pluginPath, pluginContent);
+
+      helper.showSuccess(`插件模板已成功创建到：${pluginPath}`);
+      helper.showInfo("提示：请编辑插件文件，实现具体功能");
+      helper.showInfo('测试方法：运行 "node bin/cli.js <插件命令>"');
+
+      // 使用 vscode 打开创建的插件文件
+      try {
+        const { exec } = require("child_process");
+        const os = require("os");
+        let command;
+
+        // 根据操作系统类型构建不同的命令
+        if (os.platform() === "win32") {
+          // Windows 系统
+          command = `start code "${pluginPath}"`;
+        } else {
+          // macOS 和 Linux 系统
+          command = `code "${pluginPath}"`;
+        }
+
+        exec(command, (error) => {
+          if (error) {
+            helper.showInfo(
+              "提示：无法自动打开 vscode，请手动打开插件文件进行编辑",
+            );
+          } else {
+            helper.showInfo("已自动打开 vscode 编辑插件文件");
+          }
+        });
+      } catch (error) {
+        helper.showInfo(
+          "提示：无法自动打开 vscode，请手动打开插件文件进行编辑",
+        );
+      }
+    } catch (error) {
+      helper.showError(`创建插件模板失败: ${error.message || error}`);
+      helper.showInfo(`错误详情: ${JSON.stringify(error)}`);
+    }
+  }
+
+  /**
+   * 管理插件配置
+   * @param {string} pluginName - 插件名称
+   * @param {string} key - 配置键
+   * @param {string} value - 配置值
+   * @param {Object} helper - 插件帮助器
+   */
+  managePluginConfig(pluginName, key, value, helper) {
+    // 验证插件名称
+    if (!validator.validateCommandParam(pluginName)) {
+      helper.showError("错误: 插件名称包含无效字符");
+      return;
+    }
+
+    const pluginConfigDir = path.join(this.xxDir, pluginName);
+    const configFile = path.join(pluginConfigDir, "config.json");
+
+    // 确保插件配置目录存在
+    fs.ensureDirSync(pluginConfigDir);
+
+    // 读取现有配置
+    let config = {};
+    if (fs.existsSync(configFile)) {
+      config = JSON.parse(fs.readFileSync(configFile, "utf8"));
+    }
+
+    if (!key) {
+      // 显示所有配置
+      helper.showInfo(`插件 ${pluginName} 的配置:`);
+      helper.showInfo("=====================================");
+      if (Object.keys(config).length > 0) {
+        Object.entries(config).forEach(([k, v]) => {
+          helper.showInfo(`${k}: ${v}`);
+        });
+      } else {
+        helper.showInfo("无配置项");
+      }
+      helper.showInfo("=====================================");
+    } else if (!value) {
+      // 显示指定配置
+      helper.showInfo(`插件 ${pluginName} 的配置 ${key}:`);
+      helper.showInfo("=====================================");
+      if (config.hasOwnProperty(key)) {
+        helper.showInfo(`${key}: ${config[key]}`);
+      } else {
+        helper.showInfo(`配置项 ${key} 不存在`);
+      }
+      helper.showInfo("=====================================");
+    } else {
+      // 设置配置
+      config[key] = value;
+      fs.writeFileSync(configFile, JSON.stringify(config, null, 2));
+      helper.showSuccess(`已设置插件 ${pluginName} 的配置 ${key} = ${value}`);
+    }
+  }
+
+  /**
+   * 添加外部插件
+   * @param {string} url - 插件 URL
+   * @param {Object} helper - 插件帮助器
+   */
+  async addExternalPlugin(url, helper) {
+    try {
+      // 确保用户插件目录存在
+      fs.ensureDirSync(this.userPluginsDir);
+
+      // 提取插件名称
+      const pluginFileName = path.basename(url);
+      const pluginPath = path.join(this.userPluginsDir, pluginFileName);
+
+      // 检查插件是否已存在
+      if (fs.existsSync(pluginPath)) {
+        helper.showInfo(`插件 ${pluginFileName} 已存在，是否覆盖？`);
+        // 这里可以添加交互式确认
+        helper.showInfo("已覆盖现有插件");
+      }
+
+      // 下载或复制插件
+      if (url.startsWith("http://") || url.startsWith("https://")) {
+        // 是 URL，下载插件
+        helper.showInfo(`正在从 URL 下载插件: ${url}`);
+
+        // 选择 HTTP 或 HTTPS
+        const protocol = url.startsWith("https://") ? https : http;
+
+        await new Promise((resolve, reject) => {
+          protocol
+            .get(url, (response) => {
+              if (response.statusCode === 200) {
+                // 获取文件大小
+                const fileSize = parseInt(
+                  response.headers["content-length"],
+                  10,
+                );
+                let downloadedSize = 0;
+
+                // 创建写入流
+                const writer = fs.createWriteStream(pluginPath);
+
+                // 监听数据事件，显示进度
+                response.on("data", (chunk) => {
+                  downloadedSize += chunk.length;
+                  const percentage = Math.round(
+                    (downloadedSize / fileSize) * 100,
+                  );
+
+                  // 清除当前行并显示进度
+                  process.stdout.clearLine();
+                  process.stdout.cursorTo(0);
+                  process.stdout.write(`下载进度: ${percentage}%`);
+                });
+
+                // 管道数据到文件
+                response.pipe(writer);
+
+                // 监听完成事件
+                writer.on("finish", () => {
+                  console.log(""); // 换行
+                  helper.showSuccess(`插件已成功下载到: ${pluginPath}`);
+                  resolve();
+                });
+
+                // 监听错误事件
+                writer.on("error", (error) => {
+                  reject(error);
+                });
+              } else {
+                reject(new Error(`下载失败，状态码: ${response.statusCode}`));
+              }
+            })
+            .on("error", (error) => {
+              reject(error);
+            });
+        });
+      } else if (fs.existsSync(url) && url.endsWith(".js")) {
+        // 是本地文件，拷贝插件
+        helper.showInfo(`正在从本地文件拷贝插件: ${url}`);
+
+        // 提取文件名
+        const pluginFileName = path.basename(url);
+        const pluginPath = path.join(this.userPluginsDir, pluginFileName);
+
+        // 拷贝文件
+        await fs.copy(url, pluginPath);
+
+        helper.showSuccess(`插件已成功拷贝到: ${pluginPath}`);
+      } else {
+        helper.showError("错误: 无效的插件URL或本地文件路径");
+        return;
+      }
+
+      // 提示用户
+      helper.showInfo("\n提示:");
+      helper.showInfo("- 插件已自动注册到命令系统");
+      helper.showInfo('- 可以使用 "xx plugin list" 命令查看已安装的插件');
+      helper.showInfo('- 可以使用 "xx <plugin-command>" 命令使用插件功能');
+      helper.showInfo("- 此插件保存在用户目录中，不会被重新安装影响");
+    } catch (error) {
+      helper.showError("添加插件失败:", error.message);
+    }
+  }
+
+  /**
+   * 同步开发插件
+   * 将当前目录下的 lib/myplugins 同步到 CLI 配置目录的 plugins
+   * @param {Object} helper - 插件帮助器
+   */
+  async syncDevPlugins(helper) {
+    try {
+      // 确保用户插件目录存在
+      fs.ensureDirSync(this.userPluginsDir);
+
+      // 开发插件目录路径
+      const devPluginsDir = path.join(process.cwd(), "lib/myplugins");
+
+      // 检查开发插件目录是否存在
+      if (!fs.existsSync(devPluginsDir)) {
+        helper.showError(`开发插件目录不存在: ${devPluginsDir}`);
+        return;
+      }
+
+      // 读取开发插件目录中的文件
+      const devPluginFiles = fs
+        .readdirSync(devPluginsDir)
+        .filter((file) => file.endsWith(".js"));
+
+      if (devPluginFiles.length === 0) {
+        helper.showInfo("开发插件目录中没有 JavaScript 文件");
+        return;
+      }
+
+      helper.showInfo(
+        `找到 ${devPluginFiles.length} 个开发插件文件，开始同步...`,
+      );
+
+      // 同步每个插件文件
+      let syncedCount = 0;
+      for (const file of devPluginFiles) {
+        const sourcePath = path.join(devPluginsDir, file);
+        const targetPath = path.join(this.userPluginsDir, file);
+
+        // 检查源文件是否存在
+        if (fs.existsSync(sourcePath)) {
+          // 复制文件
+          await fs.copy(sourcePath, targetPath, { overwrite: true });
+          helper.showSuccess(`已同步: ${file}`);
+          syncedCount++;
+        } else {
+          helper.showWarning(`跳过不存在的文件: ${file}`);
+        }
+      }
+
+      helper.showSuccess(`同步完成，共同步 ${syncedCount} 个插件文件`);
+      helper.showInfo(`插件已同步到: ${this.userPluginsDir}`);
+      helper.showInfo("\n提示:");
+      helper.showInfo("- 插件已自动注册到命令系统");
+      helper.showInfo('- 可以使用 "xx plugin list" 命令查看已安装的插件');
+      helper.showInfo('- 可以使用 "xx <plugin-command>" 命令使用插件功能');
+    } catch (error) {
+      helper.showError(`同步开发插件失败: ${error.message}`);
+    }
+  }
+}
+
+// 创建插件管理实例
+const pluginManager = new PluginManager();
+
+module.exports = {
+  name: "plugin-manager",
+  alias: "p",
+  description: "插件管理",
+  subcommands: [
+    {
+      name: "list",
+      alias: "ls",
+      description: "列出所有插件",
+      action: (args, options, helper) => {
+        pluginManager.listPlugins(helper);
+      },
+    },
+    {
+      name: "enable",
+      alias: "en",
+      description: "启用插件",
+      args: [
+        {
+          name: "plugin",
+          description: "插件名称",
+          required: true,
+        },
+      ],
+      action: (args, options, helper) => {
+        pluginManager.enablePlugin(args.plugin, helper);
+      },
+    },
+    {
+      name: "disable",
+      alias: "dis",
+      description: "禁用插件",
+      args: [
+        {
+          name: "plugin",
+          description: "插件名称",
+          required: true,
+        },
+      ],
+      action: (args, options, helper) => {
+        pluginManager.disablePlugin(args.plugin, helper);
+      },
+    },
+    {
+      name: "add",
+      description: "添加外部自定义插件",
+      args: [
+        {
+          name: "url",
+          description: "插件 URL",
+          required: true,
+        },
+      ],
+      action: async (args, options, helper) => {
+        await pluginManager.addExternalPlugin(args.url, helper);
+      },
+    },
+    {
+      name: "remove",
+      alias: "rm",
+      description: "删除指定插件",
+      args: [
+        {
+          name: "plugin",
+          description: "插件名称",
+          required: true,
+        },
+      ],
+      action: (args, options, helper) => {
+        pluginManager.removePlugin(args.plugin, helper);
+      },
+    },
+    {
+      name: "create",
+      alias: "cr",
+      description: "创建指定名称的插件模板",
+      args: [
+        {
+          name: "name",
+          description: "插件名称",
+          required: true,
+        },
+      ],
+      options: [
+        {
+          name: "-f, --format <format>",
+          description:
+            "插件模板格式，支持 new（配置对象格式）或 old（类结构格式）",
+          default: "new",
+        },
+      ],
+      action: async (args, options, helper) => {
+        helper.showInfo(`args 对象: ${JSON.stringify(args)}`);
+        helper.showInfo(`options 对象: ${JSON.stringify(options)}`);
+
+        // 提取插件名称
+        let pluginName = "unnamed";
+        if (Array.isArray(args)) {
+          // 遍历数组，找到非对象的字符串参数
+          for (const arg of args) {
+            if (typeof arg === "string") {
+              pluginName = arg;
+              break;
+            }
+          }
+        } else if (typeof args === "string") {
+          pluginName = args;
+        }
+
+        helper.showInfo(`提取的插件名称: ${pluginName}`);
+        await pluginManager.createPlugin(pluginName, options, helper);
+      },
+    },
+    {
+      name: "config",
+      alias: "c",
+      description: "查看和设置插件配置",
+      args: [
+        {
+          name: "plugin",
+          description: "插件名称",
+          required: true,
+        },
+        {
+          name: "key",
+          description: "配置键",
+          optional: true,
+        },
+        {
+          name: "value",
+          description: "配置值",
+          optional: true,
+        },
+      ],
+      action: (args, options, helper) => {
+        pluginManager.managePluginConfig(
+          args.plugin,
+          args.key,
+          args.value,
+          helper,
+        );
+      },
+    },
+    {
+      name: "sync",
+      alias: "s",
+      description: "将当前目录下的 lib/myplugins 同步到 CLI 配置目录的 plugins",
+      action: async (args, options, helper) => {
+        await pluginManager.syncDevPlugins(helper);
+      },
+    },
+  ],
+  options: [
+    {
+      name: "-h, --help",
+      description: "显示帮助信息",
+    },
+  ],
+};