rl-rockcli 0.0.4 → 0.0.6

package/utils/firstTimeTip.js

@@ -0,0 +1,44 @@
+/**
+ * 首次使用提示工具
+ * 用于在用户首次使用时显示 rc 别名的提示信息
+ */
+
+const fs = require('fs-extra');
+const path = require('path');
+const { showAsciiArt } = require('./asciiArt');
+
+/**
+ * 获取配置目录和标记文件路径
+ */
+function getPaths() {
+    const CONFIG_DIR = path.join(process.env.HOME || process.env.USERPROFILE, '.rock');
+    const FLAG_FILE = path.join(CONFIG_DIR, 'first_time_tip_shown');
+    return { CONFIG_DIR, FLAG_FILE };
+}
+
+/**
+ * 检查并显示首次使用提示
+ * @returns {string|null} 如果是首次使用返回提示信息，否则返回null
+ */
+function checkAndShowFirstTimeTip() {
+    const { CONFIG_DIR, FLAG_FILE } = getPaths();
+
+    // 如果标记文件已存在，说明不是首次使用
+    if (fs.existsSync(FLAG_FILE)) {
+        return null;
+    }
+
+    // 确保配置目录存在
+    fs.ensureDirSync(CONFIG_DIR);
+
+    // 创建标记文件
+    fs.writeFileSync(FLAG_FILE, new Date().toISOString());
+
+    // 返回提示信息 + ASCII 艺术字
+    return showAsciiArt() + '\n💡 提示：您可以使用 rc 命令代替 rockcli 命令，更加简洁高效！\n';
+}
+
+module.exports = {
+    checkAndShowFirstTimeTip,
+    getPaths
+};

package/utils/hook-manager.js

@@ -0,0 +1,125 @@
+const logger = require('./logger');
+const { createPluginContext } = require('../lib/plugin-context');
+
+/**
+ * 钩子管理器
+ * 用于注册、排序和执行钩子
+ */
+class HookManager {
+  constructor() {
+    this._hooks = new Map(); // Map<hookName, Array<hookDef>>
+  }
+
+  /**
+   * 注册钩子
+   * @param {string} hookName - 钩子名称
+   * @param {Object} hookDef - 钩子定义
+   * @param {number} priority - 优先级
+   * @param {string} pluginName - 插件名称
+   */
+  registerHook(hookName, hookDef, priority = 0, pluginName = 'unknown') {
+    if (!this._hooks.has(hookName)) {
+      this._hooks.set(hookName, []);
+    }
+
+    this._hooks.get(hookName).push({
+      ...hookDef,
+      priority,
+      pluginName,
+      _loadOrder: this._hooks.get(hookName).length // 用于保持加载顺序
+    });
+  }
+
+  /**
+   * 获取指定钩子的所有处理函数
+   * @param {string} hookName - 钩子名称
+   * @returns {Array} - 排序后的钩子数组
+   */
+  getHooks(hookName) {
+    const hooks = this._hooks.get(hookName) || [];
+
+    // 按优先级排序，相同优先级按加载顺序排序
+    return [...hooks].sort((a, b) => {
+      if (a.priority !== b.priority) {
+        return a.priority - b.priority; // 优先级升序
+      }
+      return a._loadOrder - b._loadOrder; // 加载顺序
+    });
+  }
+
+  /**
+   * 执行钩子
+   * @param {string} hookName - 钩子名称
+   * @param {Object} baseContext - 基础上下文
+   * @returns {Promise<{prevented: boolean, message?: string}>}
+   */
+  async executeHooks(hookName, baseContext = {}) {
+    const hooks = this.getHooks(hookName);
+
+    if (hooks.length === 0) {
+      return { prevented: false };
+    }
+
+    // 创建 context 对象
+    const context = createPluginContext(baseContext);
+
+    for (const hook of hooks) {
+      try {
+        await hook.handler(context);
+
+        // 检查是否阻止
+        if (context.isPrevented) {
+          return {
+            prevented: true,
+            message: context.preventMessage
+          };
+        }
+      } catch (error) {
+        logger.error(`Hook execution failed: ${hookName} (plugin: ${hook.pluginName})`);
+        logger.error(error);
+        throw error;
+      }
+    }
+
+    return { prevented: false };
+  }
+
+  /**
+   * 获取所有钩子信息
+   * @returns {Object} - 钩子信息对象
+   */
+  getHooksInfo() {
+    const info = {};
+    for (const [hookName, hooks] of this._hooks.entries()) {
+      info[hookName] = hooks.map(h => ({
+        priority: h.priority,
+        pluginName: h.pluginName
+      }));
+    }
+    return info;
+  }
+}
+
+// 单例实例
+HookManager._instance = null;
+
+/**
+ * 获取单例实例
+ * @static
+ */
+HookManager.getInstance = function() {
+  if (!HookManager._instance) {
+    HookManager._instance = new HookManager();
+  }
+  return HookManager._instance;
+};
+
+/**
+ * 设置单例实例
+ * @static
+ */
+HookManager.setInstance = function(instance) {
+  HookManager._instance = instance;
+};
+
+module.exports = HookManager;

package/utils/http-logger.js

@@ -0,0 +1,264 @@
+/**
+ * HTTP Logger - Event emitter for HTTP request/response logging
+ *
+ * Log format: [HH:mm:ss.SSS] [LEVEL] [ACTION] [traceId] msg
+ *
+ * This module provides a centralized way to log HTTP requests and responses.
+ * InkREPL's console can subscribe to these events to display them.
+ */
+
+const EventEmitter = require('events');
+
+// Action types
+const ACTION = {
+  SESSION: 'SESSION',
+  HTTP_REQ: 'HTTP_REQ',
+  HTTP_RES: 'HTTP_RES',
+  HTTP_ERR: 'HTTP_ERR',
+  CMD: 'CMD',
+};
+
+// Log levels
+const LEVEL = {
+  DEBUG: 'DEBUG',
+  INFO: 'INFO',
+  WARN: 'WARN',
+  ERROR: 'ERROR',
+};
+
+class HttpLogger extends EventEmitter {
+  constructor() {
+    super();
+    this.enabled = false;
+  }
+
+  /**
+   * Enable HTTP logging
+   */
+  enable() {
+    this.enabled = true;
+  }
+
+  /**
+   * Disable HTTP logging
+   */
+  disable() {
+    this.enabled = false;
+  }
+
+  /**
+   * Format timestamp with milliseconds
+   */
+  _formatTime(date) {
+    const pad = (n, len = 2) => String(n).padStart(len, '0');
+    return `${pad(date.getHours())}:${pad(date.getMinutes())}:${pad(date.getSeconds())}.${pad(date.getMilliseconds(), 3)}`;
+  }
+
+  /**
+   * Format log message
+   * Format: [HH:mm:ss.SSS] [LEVEL] [ACTION] [traceId] msg
+   */
+  _formatMessage(level, action, traceId, msg) {
+    const time = this._formatTime(new Date());
+    const tid = traceId || '-';
+    return `[${time}] [${level.padEnd(5)}] [${action.padEnd(8)}] [${tid}] ${msg}`;
+  }
+
+  /**
+   * Truncate and format JSON for logging
+   */
+  _formatBody(data, maxLen = 200) {
+    if (!data) return null;
+
+    try {
+      let json = JSON.stringify(data);
+      if (json.length > maxLen) {
+        json = json.slice(0, maxLen) + '...';
+      }
+      return json;
+    } catch {
+      return String(data).slice(0, maxLen);
+    }
+  }
+
+  /**
+   * Log an HTTP request
+   * @param {string} method - HTTP method (GET, POST, etc.)
+   * @param {string} url - Request URL
+   * @param {Object} data - Request body (optional)
+   */
+  logRequest(method, url, data = null) {
+    if (!this.enabled) return;
+
+    const urlPath = this._extractPath(url);
+    const msg = `${method} ${urlPath}`;
+    const message = this._formatMessage(LEVEL.DEBUG, ACTION.HTTP_REQ, null, msg);
+
+    const event = {
+      type: 'request',
+      level: LEVEL.DEBUG,
+      action: ACTION.HTTP_REQ,
+      method,
+      url: urlPath,
+      data,
+      message,
+      timestamp: new Date(),
+    };
+
+    this.emit('request', event);
+
+    // Log request body as separate debug entry
+    if (data) {
+      const bodyJson = this._formatBody(data);
+      const fullBody = this._formatBody(data, Infinity); // Full body for copying
+      if (bodyJson) {
+        const bodyMsg = this._formatMessage(LEVEL.DEBUG, ACTION.HTTP_REQ, null, `body: ${bodyJson}`);
+        this.emit('request', {
+          ...event,
+          message: bodyMsg,
+          fullMessage: `body: ${fullBody}`, // Store full message for copying
+          isBody: true,
+        });
+      }
+    }
+  }
+
+  /**
+   * Log an HTTP response
+   * @param {string} method - HTTP method
+   * @param {string} url - Request URL
+   * @param {number} status - HTTP status code
+   * @param {number} duration - Request duration in ms
+   * @param {Object} data - Response data (optional)
+   * @param {string} traceId - Trace ID from response headers (optional)
+   */
+  logResponse(method, url, status, duration, data = null, traceId = null) {
+    if (!this.enabled) return;
+
+    const urlPath = this._extractPath(url);
+    const statusText = status >= 200 && status < 300 ? 'OK' : 'FAIL';
+    const level = status >= 400 ? LEVEL.WARN : LEVEL.INFO;
+
+    const msg = `${method} ${urlPath} ${status} ${statusText} ${duration}ms`;
+    const message = this._formatMessage(level, ACTION.HTTP_RES, traceId, msg);
+
+    const event = {
+      type: 'response',
+      level,
+      action: ACTION.HTTP_RES,
+      method,
+      url: urlPath,
+      status,
+      duration,
+      data,
+      traceId,
+      message,
+      timestamp: new Date(),
+    };
+
+    this.emit('response', event);
+
+    // Log response body as separate debug entry
+    if (data) {
+      const bodyJson = this._formatBody(data);
+      const fullBody = this._formatBody(data, Infinity); // Full body for copying
+      if (bodyJson) {
+        const bodyMsg = this._formatMessage(LEVEL.DEBUG, ACTION.HTTP_RES, traceId, `body: ${bodyJson}`);
+        this.emit('response', {
+          ...event,
+          level: LEVEL.DEBUG,
+          message: bodyMsg,
+          fullMessage: `body: ${fullBody}`, // Store full message for copying
+          isBody: true,
+        });
+      }
+    }
+  }
+
+  /**
+   * Log an HTTP error
+   * @param {string} method - HTTP method
+   * @param {string} url - Request URL
+   * @param {Error} error - Error object
+   * @param {number} duration - Request duration in ms
+   * @param {string} traceId - Trace ID from response headers (optional)
+   */
+  logError(method, url, error, duration, traceId = null) {
+    if (!this.enabled) return;
+
+    const urlPath = this._extractPath(url);
+    // Safely extract error message - handle non-Error objects
+    let errorMessage;
+    if (error === null) {
+      errorMessage = 'null';
+    } else if (error === undefined) {
+      errorMessage = 'undefined';
+    } else if (error instanceof Error) {
+      errorMessage = error.message;
+    } else if (typeof error === 'object' && error.message) {
+      errorMessage = error.message;
+    } else {
+      errorMessage = String(error);
+    }
+    const msg = `${method} ${urlPath} ERROR: ${errorMessage} ${duration}ms`;
+    const message = this._formatMessage(LEVEL.ERROR, ACTION.HTTP_ERR, traceId, msg);
+
+    this.emit('error', {
+      type: 'error',
+      level: LEVEL.ERROR,
+      action: ACTION.HTTP_ERR,
+      method,
+      url: urlPath,
+      error: errorMessage,
+      duration,
+      traceId,
+      message,
+      timestamp: new Date(),
+    });
+  }
+
+  /**
+   * Log a generic message (for session, cmd, etc.)
+   * @param {string} level - Log level
+   * @param {string} action - Action type
+   * @param {string} msg - Message
+   * @param {string} traceId - Trace ID (optional)
+   */
+  log(level, action, msg, traceId = null) {
+    if (!this.enabled) return;
+
+    const message = this._formatMessage(level, action, traceId, msg);
+
+    this.emit('log', {
+      type: 'log',
+      level,
+      action,
+      traceId,
+      message,
+      timestamp: new Date(),
+    });
+  }
+
+  /**
+   * Extract path from full URL
+   */
+  _extractPath(url) {
+    try {
+      const urlObj = new URL(url);
+      return urlObj.pathname;
+    } catch {
+      // If URL parsing fails, try to extract path manually
+      const match = url.match(/\/apis\/.*$/);
+      return match ? match[0] : url;
+    }
+  }
+}
+
+// Export constants
+HttpLogger.ACTION = ACTION;
+HttpLogger.LEVEL = LEVEL;
+
+// Singleton instance
+const httpLogger = new HttpLogger();
+
+module.exports = { httpLogger, HttpLogger };

package/utils/i18n.js

@@ -0,0 +1,139 @@
+/**
+ * Internationalization (i18n) utilities
+ */
+
+/**
+ * Detect system language
+ * @returns {string} Language code ('zh' for Chinese, 'en' for English)
+ */
+function detectLanguage() {
+  const lang = (
+    process.env.LC_ALL ||
+    process.env.LANG ||
+    process.env.LC_MESSAGES ||
+    'en'
+  ).toLowerCase();
+
+  // Check for Chinese locale
+  if (lang.startsWith('zh')) {
+    return 'zh';
+  }
+
+  // Default to English
+  return 'en';
+}
+
+/**
+ * Translations
+ */
+const translations = {
+  zh: {
+    // WelcomeBanner TIPS
+    'welcome.tip.commands': '使用 / 查看内置命令',
+    'welcome.tip.execute': '输入 shell 指令即可在远端执行',
+    'welcome.tip.console': '按 F12 打开调试控制台',
+    'welcome.tip.exit': '双按 Ctrl+C 退出',
+
+    // ConnectingScreen
+    'connecting.message': '🔄 正在连接沙箱...',
+    'connecting.attempt': '尝试 ${attempt}/${maxAttempts} 次...',
+
+    // replState welcome output
+    'welcome.connected': '已连接。准备就绪。',
+
+    // repl.js exit banner
+    'exit.session.duration': '✷ 会话持续时间',
+    'exit.new.session': '新建会话：',
+    'exit.resume.session': '恢复会话：',
+
+    // image mirror exit summary
+    'image.task.completed': '任务完成！',
+    'image.task.interrupted': '任务已中断。',
+    'image.task.exited': '任务已退出。',
+    'image.task.ended': '任务已结束。',
+    'image.task.error': '任务出错：',
+    'image.task.summary': '共处理 ${total} 个镜像，成功 ${completed} 个，跳过 ${skipped} 个，失败 ${failed} 个。',
+    'image.task.partial': '已完成 ${completed}/${total} 个镜像',
+    'image.task.failedCount': '（${failed} 个失败）',
+    'image.task.skippedCount': '（${skipped} 个跳过）',
+    'image.resume.command': '恢复命令:',
+    'image.log.saved': '日志已保存到: ${logDir}',
+    'image.password.placeholder': '<请填写密码>',
+  },
+  en: {
+    // WelcomeBanner TIPS
+    'welcome.tip.commands': 'Type / for available commands',
+    'welcome.tip.execute': 'Run shell commands remotely',
+    'welcome.tip.console': 'Press F12 to open Console',
+    'welcome.tip.exit': 'Double Ctrl+C to exit',
+  
+    // ConnectingScreen
+    'connecting.message': '🔄 Connecting to sandbox...',
+    'connecting.attempt': 'Attempt ${attempt}/${maxAttempts}...',
+  
+    // replState welcome output
+    'welcome.connected': 'Connected. Ready.',
+  
+    // repl.js exit banner
+    'exit.session.duration': '✷ Session lasted',
+    'exit.new.session': 'New session:',
+    'exit.resume.session': 'Resume session:',
+
+    // image mirror exit summary
+    'image.task.completed': 'Task completed!',
+    'image.task.interrupted': 'Task interrupted.',
+    'image.task.exited': 'Task exited.',
+    'image.task.ended': 'Task ended.',
+    'image.task.error': 'Task error:',
+    'image.task.summary': 'Processed ${total} images: ${completed} succeeded, ${skipped} skipped, ${failed} failed.',
+    'image.task.partial': 'Completed ${completed}/${total} images',
+    'image.task.failedCount': ' (${failed} failed)',
+    'image.task.skippedCount': ' (${skipped} skipped)',
+    'image.resume.command': 'Resume command:',
+    'image.log.saved': 'Logs saved to: ${logDir}',
+    'image.password.placeholder': '<enter password>',
+  },
+};
+
+/**
+ * Get translation for a key
+ * @param {string} key - Translation key
+ * @param {string} [language] - Language code (optional, auto-detected if not provided)
+ * @param {Object} [vars] - Variables for interpolation (e.g., { total: 10, completed: 5 })
+ * @returns {string} Translated string with variables replaced
+ */
+function t(key, language = null, vars = null) {
+  const lang = language || detectLanguage();
+  const langTranslations = translations[lang] || translations.en;
+  let text = langTranslations[key] || translations.en[key] || key;
+  
+  // Replace variables like ${varName}
+  if (vars && typeof vars === 'object') {
+    for (const [varName, value] of Object.entries(vars)) {
+      text = text.replace(new RegExp(`\\$\\{${varName}\\}`, 'g'), String(value));
+    }
+  }
+  
+  return text;
+}
+
+/**
+ * Get current language
+ * @returns {string} Current language code
+ */
+function getCurrentLanguage() {
+  return detectLanguage();
+}
+
+// Export for both CommonJS and ES Module compatibility
+const i18nExports = {
+  detectLanguage,
+  t,
+  getCurrentLanguage,
+};
+
+// CommonJS export
+module.exports = i18nExports;
+
+// ES Module default export (for Ink components)
+module.exports.default = i18nExports;