@xubill/xx-cli 1.0.1 → 1.0.2

package/lib/core/commands.js

@@ -0,0 +1,444 @@
+/**
+ * 核心命令实现
+ * 存放具体的命令实现逻辑，保持 index.js 清晰
+ */
+
+const fs = require('fs-extra');
+const path = require('path');
+const validator = require('../utils/validator');
+const pluginConfig = require('../utils/plugin-config');
+
+class CoreCommands {
+  /**
+   * 创建插件
+   * @param {string} name - 插件名称
+   * @param {Object} options - 选项
+   */
+  async createPlugin(name, options) {
+    try {
+      console.log('创建插件模板...');
+
+      // 插件目录路径
+      const pluginsDir = path.join(__dirname, '../plugins');
+      const pluginFileName = `${name}.js`;
+      const pluginPath = path.join(pluginsDir, pluginFileName);
+
+      // 检查插件是否已存在
+      if (fs.existsSync(pluginPath)) {
+        console.log(`插件 ${name} 已存在，请使用其他名称`);
+        return;
+      }
+
+      // 生成插件模板内容
+      const pluginContent = this.generatePluginTemplate(name);
+
+      // 写入插件文件
+      await fs.writeFile(pluginPath, pluginContent);
+
+      console.log(`插件模板已成功创建到：${pluginPath}`);
+      console.log('提示：请编辑插件文件，实现具体功能');
+      console.log('测试方法：运行 "node bin/cli.js <插件命令>"');
+
+    } catch (error) {
+      console.error('创建插件模板失败:', error.message);
+    }
+  }
+
+  /**
+   * 生成插件模板内容
+   * @param {string} name - 插件名称
+   * @returns {string} 插件模板内容
+   */
+  generatePluginTemplate(name) {
+    // 生成插件命令名称（去除后缀，转小写，连字符转驼峰）
+    const commandName = name.replace('.js', '').toLowerCase().replace(/-([a-z])/g, (g) => g[1].toUpperCase());
+    
+    // 导入路径
+    const basePluginPath = '../core/base-plugin';
+
+    return `/**
+ * ${name} 插件
+ * 用于实现 ${name} 相关功能
+ * 
+ * 命令说明：
+ * - ${commandName} [options]：${name} 相关功能
+ *   - 示例：${commandName}
+ * 
+ * 功能说明：
+ * - 实现 ${name} 相关功能
+ * 
+ * 用户体验：
+ * - 使用标准化的用户提示
+ * - 提供清晰的错误提示
+ * - 支持命令行参数
+ */
+
+const BasePlugin = require('${basePluginPath}');
+
+class ${this.toCamelCase(name)}Plugin extends BasePlugin {
+  constructor(options = {}) {
+    super(options);
+    this.pluginName = '${name}';
+  }
+
+  /**
+   * 注册命令
+   * @param {Object} program - Commander.js 实例
+   */
+  registerCommands(program) {
+    program.command('${commandName}')
+      .description('${name} 相关功能')
+      .option('-v, --verbose', '显示详细信息')
+      .option('-h, --help', '显示帮助信息')
+      .action((options) => this.${commandName}Command(options));
+  }
+
+  /**
+   * ${name} 命令
+   * @param {Object} options - 命令选项
+   */
+  ${commandName}Command(options) {
+    console.log('${name} 命令执行成功！');
+    if (options && options.verbose) {
+      console.log('详细信息:');
+      console.log('- 命令名称:', '${commandName}');
+      console.log('- 执行时间:', new Date().toLocaleString());
+    }
+  }
+}
+
+module.exports = ${this.toCamelCase(name)}Plugin;
+`;
+  }
+
+  /**
+   * 转换为驼峰命名
+   * @param {string} str - 字符串
+   * @returns {string} 驼峰命名的字符串
+   */
+  toCamelCase(str) {
+    return str.replace(/-([a-z])/g, (g) => g[1].toUpperCase()).replace(/^[a-z]/, (g) => g.toUpperCase());
+  }
+
+  /**
+   * 配置管理
+   * @param {string} action - 操作类型
+   * @param {string} target - 目标路径
+   */
+  configManager(action, target) {
+    const homeDir = process.env.HOME || process.env.USERPROFILE;
+    const xxDir = path.join(homeDir, '.xx-cli');
+    
+    if (action === 'export') {
+      // 导出配置
+      const exportDir = target || path.join(process.cwd(), 'config-backup');
+      console.log(`开始导出配置到: ${exportDir}`);
+      
+      // 确保导出目录存在
+      fs.ensureDirSync(exportDir);
+      
+      // 复制 .xx 目录
+      if (fs.existsSync(xxDir)) {
+        const exportPath = path.join(exportDir, '.xx-cli');
+        fs.ensureDirSync(path.dirname(exportPath));
+        fs.copySync(xxDir, exportPath);
+        console.log(`导出目录: ${xxDir}`);
+      }
+      
+      console.log('配置导出完成！');
+    } else if (action === 'import') {
+      // 导入配置
+      const importDir = target || path.join(process.cwd(), 'config-backup');
+      console.log(`开始从 ${importDir} 导入配置...`);
+      
+      // 检查导入目录是否存在
+      if (!fs.existsSync(importDir)) {
+        console.log(`导入目录不存在: ${importDir}`);
+        return;
+      }
+      
+      // 复制配置到 .xx 目录
+      const importPath = path.join(importDir, '.xx-cli');
+      if (fs.existsSync(importPath)) {
+        fs.ensureDirSync(path.dirname(xxDir));
+        fs.copySync(importPath, xxDir, { overwrite: true });
+        console.log(`导入目录: ${importPath}`);
+      }
+      
+      console.log('配置导入完成！');
+    } else if (action === 'list') {
+      // 列出配置
+      console.log('列出所有插件配置文件...\n');
+      
+      if (fs.existsSync(xxDir)) {
+        const items = fs.readdirSync(xxDir).filter(item => !item.startsWith('.'));
+        items.forEach(item => {
+          const itemPath = path.join(xxDir, item);
+          const stat = fs.statSync(itemPath);
+          if (stat.isDirectory()) {
+            console.log(`插件配置目录: ${itemPath}`);
+            const configFiles = fs.readdirSync(itemPath).filter(file => !file.startsWith('.'));
+            configFiles.forEach(file => {
+              console.log(`  - ${file}`);
+            });
+          } else if (stat.isFile()) {
+            console.log(`配置文件: ${itemPath}`);
+          }
+        });
+      } else {
+        console.log('配置目录不存在');
+      }
+      
+      console.log('配置列表完成！');
+    }
+  }
+
+  /**
+   * 列出所有插件
+   */
+  listPlugins(core) {
+    const pluginsInfo = core.getPluginsInfo();
+    console.log('\n可用插件列表:');
+    console.log('=====================================');
+    pluginsInfo.forEach(plugin => {
+      const isDisabled = pluginConfig.isPluginDisabled(plugin.name);
+      const status = isDisabled ? '[已禁用]' : '[已启用]';
+      console.log(`- ${plugin.name} ${status}`);
+    });
+    console.log('=====================================');
+    console.log(`总计: ${pluginsInfo.length} 个插件\n`);
+  }
+
+  /**
+   * 启用插件
+   * @param {string} pluginName - 插件名称
+   */
+  enablePlugin(pluginName) {
+    // 验证插件名称
+    if (!validator.validateCommandParam(pluginName)) {
+      console.error('错误: 插件名称包含无效字符');
+      return;
+    }
+    
+    // 启用插件
+    pluginConfig.enablePlugin(pluginName);
+    console.log(`已启用插件: ${pluginName}`);
+    console.log('提示: 请重新运行命令以应用更改');
+  }
+
+  /**
+   * 禁用插件
+   * @param {string} pluginName - 插件名称
+   */
+  disablePlugin(pluginName) {
+    // 验证插件名称
+    if (!validator.validateCommandParam(pluginName)) {
+      console.error('错误: 插件名称包含无效字符');
+      return;
+    }
+    
+    // 禁用插件
+    pluginConfig.disablePlugin(pluginName);
+    console.log(`已禁用插件: ${pluginName}`);
+    console.log('提示: 请重新运行命令以应用更改');
+  }
+
+  /**
+   * 删除插件
+   * @param {string} pluginName - 插件名称
+   */
+  removePlugin(pluginName) {
+    // 验证插件名称
+    if (!validator.validateCommandParam(pluginName)) {
+      console.error('错误: 插件名称包含无效字符');
+      return;
+    }
+    
+    const fs = require('fs');
+    const path = require('path');
+    
+    // 插件目录路径
+    const pluginsDir = path.join(__dirname, '../plugins');
+    
+    // 构建插件文件路径
+    const pluginFileName = `${pluginName}.js`;
+    const pluginPath = path.join(pluginsDir, pluginFileName);
+    
+    // 检查插件文件是否存在
+    if (!fs.existsSync(pluginPath)) {
+      console.error(`错误: 插件文件不存在: ${pluginPath}`);
+      return;
+    }
+    
+    try {
+      // 删除插件文件
+      fs.unlinkSync(pluginPath);
+      
+      // 从配置中移除插件的禁用状态
+      pluginConfig.removePluginFromConfig(pluginName);
+      
+      console.log(`已成功删除插件: ${pluginName}`);
+      console.log('提示: 请重新运行命令以应用更改');
+    } catch (error) {
+      console.error(`删除插件失败: ${error.message}`);
+    }
+  }
+
+  /**
+   * 管理插件配置
+   * @param {string} pluginName - 插件名称
+   * @param {string} key - 配置键
+   * @param {string} value - 配置值
+   */
+  managePluginConfig(pluginName, key, value) {
+    // 验证插件名称
+    if (!validator.validateCommandParam(pluginName)) {
+      console.error('错误: 插件名称包含无效字符');
+      return;
+    }
+    
+    const homeDir = process.env.HOME || process.env.USERPROFILE;
+    const xxDir = path.join(homeDir, '.xx-cli');
+    const pluginConfigDir = path.join(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) {
+      // 显示所有配置
+      console.log(`插件 ${pluginName} 的配置:`);
+      console.log('=====================================');
+      if (Object.keys(config).length > 0) {
+        Object.entries(config).forEach(([k, v]) => {
+          console.log(`${k}: ${v}`);
+        });
+      } else {
+        console.log('无配置项');
+      }
+      console.log('=====================================');
+    } else if (!value) {
+      // 显示指定配置
+      console.log(`插件 ${pluginName} 的配置 ${key}:`);
+      console.log('=====================================');
+      if (config.hasOwnProperty(key)) {
+        console.log(`${key}: ${config[key]}`);
+      } else {
+        console.log(`配置项 ${key} 不存在`);
+      }
+      console.log('=====================================');
+    } else {
+      // 设置配置
+      config[key] = value;
+      fs.writeFileSync(configFile, JSON.stringify(config, null, 2));
+      console.log(`已设置插件 ${pluginName} 的配置 ${key} = ${value}`);
+    }
+  }
+
+  /**
+   * 添加外部插件
+   * @param {string} url - 插件 URL
+   */
+  async addExternalPlugin(url) {
+    try {
+      const fs = require('fs');
+      const path = require('path');
+      const https = require('https');
+      const http = require('http');
+      
+      // 插件目录路径
+      const pluginsDir = path.join(__dirname, '../plugins');
+      
+      // 确保插件目录存在
+      fs.ensureDirSync(pluginsDir);
+      
+      // 提取插件名称
+      const pluginFileName = path.basename(url);
+      const pluginPath = path.join(pluginsDir, pluginFileName);
+      
+      // 检查插件是否已存在
+      if (fs.existsSync(pluginPath)) {
+        console.log(`插件 ${pluginFileName} 已存在，是否覆盖？`);
+        // 这里可以添加交互式确认
+        console.log('已覆盖现有插件');
+      }
+      
+      // 下载或复制插件
+      if (url.startsWith('http://') || url.startsWith('https://')) {
+        // 是 URL，下载插件
+        console.log(`正在从 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(''); // 换行
+                console.log(`插件已成功下载到: ${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')) {
+        // 是本地文件，拷贝插件
+        console.log(`正在从本地文件拷贝插件: ${url}`);
+        
+        // 提取文件名
+        const pluginFileName = path.basename(url);
+        const pluginPath = path.join(pluginsDir, pluginFileName);
+        
+        // 拷贝文件
+        await fs.copy(url, pluginPath);
+        
+        console.log(`插件已成功拷贝到: ${pluginPath}`);
+      } else {
+        console.error('错误: 无效的插件URL或本地文件路径');
+        return;
+      }
+    } catch (error) {
+      console.error('添加插件失败:', error.message);
+    }
+  }
+}
+
+module.exports = new CoreCommands();

package/lib/core/index.js

@@ -9,6 +9,7 @@ const logger = require('../utils/logger');
 const pkg = require('../../package.json');
 const validator = require('../utils/validator');
 const pluginConfig = require('../utils/plugin-config');
+const coreCommands = require('./commands');
 
 class Core {
   constructor() {
@@ -44,7 +45,6 @@ class Core {
       this.pluginFiles = pluginFiles.filter(file => file.endsWith('.js'));
     }
   }
-
   /**
    * 加载单个插件
    * @param {string} pluginFile - 插件文件名
@@ -81,7 +81,6 @@ class Core {
       return null;
     }
   }
-
   /**
    * 获取所有插件信息
    * @returns {Array} 插件信息数组
@@ -335,6 +334,33 @@ class Core {
       .option('-s, --search <keyword>', '搜索命令历史记录')
       .action((options) => this.showHistory(options));
 
+    // 创建插件命令
+    program
+      .command('create-plugin <name>')
+      .alias('crp')
+      .description('创建指定名称的插件模板')
+      .action(async (name, options) => this.createPlugin(name, options));
+
+    // 配置管理命令
+    const configCommand = program.command('config-manager')
+      .alias('conf')
+      .description('管理所有插件的配置文件');
+
+    // 导出配置命令
+    configCommand.command('export [target]')
+      .description('导出所有插件配置到指定目录，默认导出到当前目录的 config-backup 文件夹')
+      .action((target) => this.configManager('export', target));
+
+    // 导入配置命令
+    configCommand.command('import [source]')
+      .description('从指定目录导入配置并覆盖，默认从当前目录的 config-backup 文件夹导入')
+      .action((source) => this.configManager('import', source));
+
+    // 列出配置命令
+    configCommand.command('list')
+      .description('列出所有插件的配置文件位置和状态')
+      .action(() => this.configManager('list'));
+
     // 插件管理命令
     const pluginCommand = program.command('plugin')
       .alias('p')
@@ -375,20 +401,29 @@ class Core {
       .action((plugin, key, value) => this.managePluginConfig(plugin, key, value));
   }
 
+  /**
+   * 创建插件
+   * @param {string} name - 插件名称
+   * @param {Object} options - 选项
+   */
+  async createPlugin(name, options) {
+    await coreCommands.createPlugin(name, options);
+  }
+
+  /**
+   * 配置管理
+   * @param {string} action - 操作类型
+   * @param {string} target - 目标路径
+   */
+  configManager(action, target) {
+    coreCommands.configManager(action, target);
+  }
+
   /**
    * 列出所有插件
    */
   listPlugins() {
-    const pluginsInfo = this.getPluginsInfo();
-    console.log('\n可用插件列表:');
-    console.log('=====================================');
-    pluginsInfo.forEach(plugin => {
-      const isDisabled = pluginConfig.isPluginDisabled(plugin.name);
-      const status = isDisabled ? '[已禁用]' : '[已启用]';
-      console.log(`- ${plugin.name} ${status}`);
-    });
-    console.log('=====================================');
-    console.log(`总计: ${pluginsInfo.length} 个插件\n`);
+    coreCommands.listPlugins(this);
   }
 
   /**
@@ -396,16 +431,7 @@ class Core {
    * @param {string} pluginName - 插件名称
    */
   enablePlugin(pluginName) {
-    // 验证插件名称
-    if (!validator.validateCommandParam(pluginName)) {
-      console.error('错误: 插件名称包含无效字符');
-      return;
-    }
-    
-    // 启用插件
-    pluginConfig.enablePlugin(pluginName);
-    console.log(`已启用插件: ${pluginName}`);
-    console.log('提示: 请重新运行命令以应用更改');
+    coreCommands.enablePlugin(pluginName);
   }
 
   /**
@@ -413,16 +439,7 @@ class Core {
    * @param {string} pluginName - 插件名称
    */
   disablePlugin(pluginName) {
-    // 验证插件名称
-    if (!validator.validateCommandParam(pluginName)) {
-      console.error('错误: 插件名称包含无效字符');
-      return;
-    }
-    
-    // 禁用插件
-    pluginConfig.disablePlugin(pluginName);
-    console.log(`已禁用插件: ${pluginName}`);
-    console.log('提示: 请重新运行命令以应用更改');
+    coreCommands.disablePlugin(pluginName);
   }
 
   /**
@@ -430,40 +447,7 @@ class Core {
    * @param {string} pluginName - 插件名称
    */
   removePlugin(pluginName) {
-    // 验证插件名称
-    if (!validator.validateCommandParam(pluginName)) {
-      console.error('错误: 插件名称包含无效字符');
-      return;
-    }
-    
-    const fs = require('fs');
-    const path = require('path');
-    
-    // 插件目录路径
-    const pluginsDir = path.join(__dirname, '../plugins');
-    
-    // 构建插件文件路径
-    const pluginFileName = `${pluginName}.js`;
-    const pluginPath = path.join(pluginsDir, pluginFileName);
-    
-    // 检查插件文件是否存在
-    if (!fs.existsSync(pluginPath)) {
-      console.error(`错误: 插件文件不存在: ${pluginPath}`);
-      return;
-    }
-    
-    try {
-      // 删除插件文件
-      fs.unlinkSync(pluginPath);
-      
-      // 从配置中移除插件的禁用状态
-      pluginConfig.removePluginFromConfig(pluginName);
-      
-      console.log(`已成功删除插件: ${pluginName}`);
-      console.log('提示: 请重新运行命令以应用更改');
-    } catch (error) {
-      console.error(`删除插件失败: ${error.message}`);
-    }
+    coreCommands.removePlugin(pluginName);
   }
 
   /**
@@ -473,40 +457,7 @@ class Core {
    * @param {string} value - 配置值
    */
   managePluginConfig(pluginName, key, value) {
-    // 验证插件名称
-    if (!validator.validateCommandParam(pluginName)) {
-      console.error('错误: 插件名称包含无效字符');
-      return;
-    }
-    
-    const config = require('../utils/plugin-config');
-    
-    if (key && value) {
-      // 设置插件配置
-      config.setPluginConfig(pluginName, key, value);
-      console.log(`已设置插件 ${pluginName} 的配置: ${key} = ${value}`);
-    } else if (key) {
-      // 查看插件特定配置
-      const pluginConfigValue = config.getPluginConfig(pluginName, key);
-      if (pluginConfigValue !== undefined) {
-        console.log(`插件 ${pluginName} 的配置 ${key}: ${pluginConfigValue}`);
-      } else {
-        console.log(`插件 ${pluginName} 未设置配置 ${key}`);
-      }
-    } else {
-      // 查看插件所有配置
-      const pluginConfigs = config.getPluginConfigs(pluginName);
-      if (Object.keys(pluginConfigs).length > 0) {
-        console.log(`插件 ${pluginName} 的配置:`);
-        console.log('=====================================');
-        Object.entries(pluginConfigs).forEach(([k, v]) => {
-          console.log(`${k}: ${v}`);
-        });
-        console.log('=====================================');
-      } else {
-        console.log(`插件 ${pluginName} 暂无配置`);
-      }
-    }
+    coreCommands.managePluginConfig(pluginName, key, value);
   }
 
   /**
@@ -514,68 +465,7 @@ class Core {
    * @param {string} url - 插件URL或本地文件路径
    */
   async addExternalPlugin(url) {
-    const fs = require('fs-extra');
-    const path = require('path');
-    const axios = require('axios');
-    
-    // 插件目录路径
-    const pluginsDir = path.join(__dirname, '../plugins');
-    
-    try {
-      // 检查是URL还是本地文件
-      if (validator.validateUrl(url)) {
-        // 是URL，下载插件
-        console.log(`正在从URL下载插件: ${url}`);
-        
-        // 从URL中提取插件文件名
-        const urlParts = url.split('/');
-        const pluginFileName = urlParts[urlParts.length - 1];
-        const pluginPath = path.join(pluginsDir, pluginFileName);
-        
-        // 下载文件
-        const response = await axios.get(url, { 
-          responseType: 'stream',
-          onDownloadProgress: (progressEvent) => {
-            const total = progressEvent.total;
-            const current = progressEvent.loaded;
-            if (total) {
-              const percentage = Math.round((current / total) * 100);
-              process.stdout.clearLine();
-              process.stdout.cursorTo(0);
-              process.stdout.write(`下载进度: ${percentage}%`);
-            }
-          }
-        });
-        const writer = fs.createWriteStream(pluginPath);
-        
-        response.data.pipe(writer);
-        
-        await new Promise((resolve, reject) => {
-          writer.on('finish', resolve);
-          writer.on('error', reject);
-        });
-        
-        console.log(''); // 换行
-        console.log(`插件已成功下载到: ${pluginPath}`);
-      } else if (fs.existsSync(url) && url.endsWith('.js')) {
-        // 是本地文件，拷贝插件
-        console.log(`正在从本地文件拷贝插件: ${url}`);
-        
-        // 提取文件名
-        const pluginFileName = path.basename(url);
-        const pluginPath = path.join(pluginsDir, pluginFileName);
-        
-        // 拷贝文件
-        await fs.copy(url, pluginPath);
-        
-        console.log(`插件已成功拷贝到: ${pluginPath}`);
-      } else {
-        console.error('错误: 无效的插件URL或本地文件路径');
-        return;
-      }
-    } catch (error) {
-      console.error('添加插件失败:', error.message);
-    }
+    await coreCommands.addExternalPlugin(url);
   }
 }
 

package/lib/utils/config-manager.js

@@ -16,7 +16,7 @@ class ConfigManager {
    */
   constructor(pluginName, options = {}) {
     this.homeDir = process.env.HOME || process.env.USERPROFILE;
-    this.globalConfigDir = path.join(this.homeDir, '.xx', pluginName);
+    this.globalConfigDir = path.join(this.homeDir, '.xx-cli', pluginName);
     this.localConfigPath = options.localConfigPath || `.${pluginName}Config`;
     this.ensureConfigDir();
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xubill/xx-cli",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "个人工具集",
   "main": "lib/core/index.js",
   "bin": {

package/readme.md

@@ -1,10 +1,436 @@
 # xx-cli
 
 个人开发工具集，支持插件系统，提供常用开发工具功能。
-```
-全局安装 xx-cli
+
+## 安装与使用
+
+```bash
+# 全局安装 xx-cli
 npm i @xubill/xx-cli
 
-添加插件
+# 添加插件
 xx p add xxxx.js
+
+# 使用命令
+xx <command> [options]
+```
+
+## 版本记录
+
+### v1.0.0
+- 初始化项目，搭建基本框架
+- 实现插件系统核心功能
+- 添加基础命令（help, version, history）
+
+
+### v1.0.1
+- 文档更新
+
+### v1.0.2
+- 创建插件和配置管理插件移动壳功能
+- 完善文档
+
+## 框架自带命令
+
+xx-cli 框架自带以下核心命令（位于 core 模块中）：
+
+### 基础命令
+
+| 命令 | 别名 | 描述 |
+|------|------|------|
+| `help` | - | 显示帮助信息 |
+| `version` | `v` | 显示版本信息 |
+| `history` | `h` | 查看命令历史记录 |
+
+### 插件管理命令
+
+| 命令 | 别名 | 描述 |
+|------|------|------|
+| `create-plugin <name>` | `crp <name>` | 创建指定名称的插件模板 |
+| `plugin list` | `p ls` | 列出所有插件 |
+| `plugin enable <plugin>` | `p en <plugin>` | 启用插件 |
+| `plugin disable <plugin>` | `p dis <plugin>` | 禁用插件 |
+| `plugin add <url>` | `p add <url>` | 添加外部自定义插件 |
+| `plugin remove <plugin>` | `p rm <plugin>` | 删除指定插件 |
+| `plugin config <plugin> [key] [value]` | `p c <plugin> [key] [value]` | 查看和设置插件配置 |
+
+### 配置管理命令
+
+| 命令 | 别名 | 描述 |
+|------|------|------|
+| `config-manager export [target]` | `conf export [target]` | 导出所有插件配置到指定目录 |
+| `config-manager import [source]` | `conf import [source]` | 从指定目录导入配置并覆盖 |
+| `config-manager list` | `conf list` | 列出所有插件的配置文件位置和状态 |
+
+## 插件开发
+
+本部分将详细介绍如何在 xx-cli 中创建、开发和部署插件。
+
+### 创建插件
+
+#### 使用 create-plugin 命令
+
+xx-cli 提供了 `create-plugin` 命令，可以快速生成插件模板。这是推荐的创建插件的方式。
+
+##### 基本用法
+
+```bash
+# 创建插件到插件目录
+xx create-plugin <plugin-name>
+
+# 或者使用别名
+xx crp <plugin-name>
+```
+
+##### 示例
+
+```bash
+# 创建一个名为 `hello-world` 的插件
+xx create-plugin hello-world
+
+# 输出：
+# 创建插件模板...
+# 插件模板已成功创建到：/Users/hthj/xx-cli/lib/plugins/hello-world.js
+# 提示：请编辑插件文件，实现具体功能
+# 测试方法：运行 "node bin/cli.js <插件命令>"
+```
+
+#### 手动创建插件
+
+如果需要更灵活地控制插件结构，也可以手动创建插件文件。
+
+1. 在 `lib/plugins` 目录下创建一个新的 JavaScript 文件，例如 `my-plugin.js`
+2. 实现插件类，包含必要的方法
+
+### 插件结构
+
+#### 基本插件结构
+
+使用 `create-plugin` 命令生成的插件模板包含以下结构：
+
+```javascript
+/**
+ * hello-world 插件
+ * 用于实现 hello-world 相关功能
+ * 
+ * 命令说明：
+ * - helloWorld [options]：hello-world 相关功能
+ *   - 示例：helloWorld
+ * 
+ * 功能说明：
+ * - 实现 hello-world 相关功能
+ * 
+ * 用户体验：
+ * - 使用标准化的用户提示
+ * - 提供清晰的错误提示
+ * - 支持命令行参数
+ */
+
+const BasePlugin = require('../core/base-plugin');
+
+class HelloWorldPlugin extends BasePlugin {
+  constructor(options = {}) {
+    super(options);
+    this.pluginName = 'hello-world';
+  }
+
+  /**
+   * 注册命令
+   * @param {Object} program - Commander.js 实例
+   */
+  registerCommands(program) {
+    program.command('helloWorld')
+      .description('hello-world 相关功能')
+      .option('-v, --verbose', '显示详细信息')
+      .option('-h, --help', '显示帮助信息')
+      .action((options) => this.helloWorldCommand(options));
+  }
+
+  /**
+   * hello-world 命令
+   * @param {Object} options - 命令选项
+   */
+  helloWorldCommand(options) {
+    console.log('hello-world 命令执行成功！');
+    if (options && options.verbose) {
+      console.log('详细信息:');
+      console.log('- 命令名称:', 'helloWorld');
+      console.log('- 执行时间:', new Date().toLocaleString());
+    }
+  }
+}
+
+module.exports = HelloWorldPlugin;
+```
+
+#### 命令注册
+
+插件必须实现 `registerCommands` 方法，用于向 Commander.js 注册命令。
+
+##### 基本命令注册
+
+```javascript
+registerCommands(program) {
+  program.command('helloWorld')
+    .description('hello-world 相关功能')
+    .action(() => this.helloWorldCommand());
+}
+```
+
+##### 带选项的命令注册
+
+```javascript
+registerCommands(program) {
+  program.command('helloWorld [alias]')
+    .alias('hw')
+    .description('hello-world 相关功能')
+    .option('-v, --verbose', '显示详细信息')
+    .option('-n, --name <name>', '指定名称')
+    .action((alias, options) => this.helloWorldCommand(alias, options));
+}
+```
+
+#### 命令选项
+
+可以为命令添加各种选项，以增强命令的灵活性。
+
+##### 常用选项类型
+
+- **布尔选项**：不需要参数的选项
+  ```javascript
+  .option('-v, --verbose', '显示详细信息')
+  ```
+
+- **值选项**：需要参数的选项
+  ```javascript
+  .option('-n, --name <name>', '指定名称')
+  ```
+
+- **数组选项**：可以接收多个值的选项
+  ```javascript
+  .option('-a, --array <items...>', '指定数组参数')
+  ```
+
+- **带默认值的选项**：
+  ```javascript
+  .option('-p, --port <port>', '指定端口', '3000')
+  ```
+
+- **带验证器的选项**：
+  ```javascript
+  .option('-p, --port <port>', '指定端口', parseInt)
+  ```
+
+### 插件配置
+
+插件可以使用配置文件来存储和管理配置信息。
+
+#### 配置文件结构
+
+配置文件通常存储在用户主目录的 `.xx` 文件夹中，例如：
+
+```
+~/.xx/
+  └── hello-world/
+      └── config.json
+```
+
+#### 读取配置
+
+```javascript
+const fs = require('fs');
+const path = require('path');
+
+// 获取用户主目录
+const homeDir = process.env.HOME || process.env.USERPROFILE;
+const xxDir = path.join(homeDir, '.xx-cli');
+const pluginConfigDir = path.join(xxDir, this.pluginName);
+const configFile = path.join(pluginConfigDir, 'config.json');
+
+// 读取配置
+let config = {};
+if (fs.existsSync(configFile)) {
+  config = JSON.parse(fs.readFileSync(configFile, 'utf8'));
+}
+```
+
+#### 写入配置
+
+```javascript
+const fs = require('fs');
+const path = require('path');
+
+// 确保配置目录存在
+fs.ensureDirSync(pluginConfigDir);
+
+// 写入配置
+fs.writeFileSync(configFile, JSON.stringify(config, null, 2));
+```
+
+### 基础插件类
+
+xx-cli 提供了 `BasePlugin` 基类，所有插件都应该继承此类以确保一致性和获得通用功能支持。
+
+#### 基础插件类路径
+
+`BasePlugin` 类位于 `/Users/hthj/xx-cli/lib/core/base-plugin.js`，插件可以通过以下方式导入：
+
+```javascript
+const BasePlugin = require('../core/base-plugin');
+```
+
+#### 核心功能
+
+`BasePlugin` 类提供了以下核心功能：
+
+##### 1. 命令注册
+
+- **`registerCommands(program)`**：注册命令到 Commander.js 实例，子类必须实现此方法
+
+##### 2. 插件初始化
+
+- **`init()`**：插件初始化逻辑，子类可以覆盖
+- **`getInfo()`**：获取插件信息
+
+##### 3. 用户界面
+
+- **`startLoading(text)`**：显示加载状态
+- **`stopLoading(text)`**：停止加载状态
+- **`showError(text)`**：显示错误信息
+- **`startProgressBar(text, total)`**：启动进度条
+- **`updateProgressBar(current, text)`**：更新进度条
+- **`stopProgressBar(text)`**：停止进度条
+- **`showSuccess(text)`**：显示成功信息
+- **`showWarning(text)`**：显示警告信息
+- **`showInfo(text)`**：显示信息
+
+##### 4. 配置管理
+
+- **`loadConfig(configName, cliOptions)`**：加载配置
+- **`saveConfig(config, configName, isGlobal)`**：保存配置
+
+##### 5. 错误处理
+
+- **`handleError(error, message)`**：处理错误
+
+##### 6. 异步操作
+
+- **`executeAsync(fn, loadingText, successText, errorText)`**：执行异步操作并显示加载状态
+
+##### 7. 钩子系统
+
+- **`registerHook(event, callback)`**：注册钩子
+- **`triggerHook(event, data)`**：触发钩子
+- **`hasHook(event)`**：检查是否注册了指定钩子
+
+##### 8. 剪贴板操作
+
+- **`copyToClipboard(text, successMessage)`**：复制文本到剪贴板
+
+#### 使用示例
+
+```javascript
+const BasePlugin = require('../core/base-plugin');
+
+class MyPlugin extends BasePlugin {
+  constructor(options = {}) {
+    super(options);
+    this.pluginName = 'my-plugin';
+  }
+
+  registerCommands(program) {
+    program.command('mycommand')
+      .description('My plugin command')
+      .action(() => this.myCommand());
+  }
+
+  async myCommand() {
+    try {
+      await this.executeAsync(
+        async () => {
+          // 执行异步操作
+          await new Promise(resolve => setTimeout(resolve, 1000));
+          return '操作结果';
+        },
+        '执行操作...',
+        '操作成功',
+        '操作失败'
+      );
+    } catch (error) {
+      this.handleError(error, '执行命令失败');
+    }
+  }
+}
+
+module.exports = MyPlugin;
+```
+
+### 插件生命周期
+
+插件的生命周期包括：
+
+1. **初始化**：插件被加载时
+2. **命令注册**：调用 `registerCommands` 方法
+3. **命令执行**：用户运行插件命令时
+4. **清理**：命令执行完成后
+
+### 测试插件
+
+#### 本地测试
+
+1. 创建插件：
+   ```bash
+   xx create-plugin <plugin-name>
+   ```
+
+2. 编辑插件文件，实现具体功能
+
+3. 运行插件命令：
+   ```bash
+   # 直接运行
+   node bin/cli.js <plugin-command>
+   
+   # 或者使用 xx 命令（如果已全局安装）
+   xx <plugin-command>
+   ```
+
+#### 测试命令选项
+
+```bash
+# 测试布尔选项
+xx <plugin-command> --verbose
+
+# 测试值选项
+xx <plugin-command> --name John
+
+# 测试组合选项
+xx <plugin-command> --verbose --name John
+```
+
+### 部署插件
+
+#### 发布到插件目录
+
+1. 确保插件文件位于 `lib/plugins` 目录
+2. 运行 `xx plugin list` 命令，确认插件已被识别
+3. 插件会自动加载并注册到命令系统中
+
+#### 分享插件
+
+如果要与他人分享插件，可以：
+
+1. 将插件文件发送给他人
+2. 他人将插件文件放入其 `lib/plugins` 目录
+3. 运行 `xx plugin list` 命令，确认插件已被识别
+
+#### 从外部添加插件
+
+可以使用 `plugin add` 命令从 URL 或本地文件添加插件：
+
+```bash
+# 从 URL 添加插件
+xx plugin add https://example.com/my-plugin.js
+
+# 从本地文件添加插件
+xx plugin add /path/to/my-plugin.js
 ```