rl-rockcli 0.0.8 → 0.0.10

package/help/middleware.js

@@ -0,0 +1,71 @@
+/**
+ * Yargs middleware，拦截 --help 请求
+ * 使用自定义渲染器输出 gh 风格的帮助信息
+ */
+
+const { renderHelp } = require('./renderer');
+const { gracefulExit } = require('../utils/execution_logger');
+
+// 标记是否已显示帮助信息
+let helpShown = false;
+
+/**
+ * 构建完整的命令路径
+ * 处理位置参数（如 sandbox [action]）被 yargs 解析到 argv.action 的情况
+ *
+ * @param {object} argv - yargs 解析后的参数
+ * @returns {string[]} 命令路径数组
+ */
+function buildCommandPath(argv) {
+  const commandPath = [...(argv._ || [])];
+
+  // 处理 sandbox/log 命令的 action 位置参数
+  if (argv.action && typeof argv.action === 'string') {
+    commandPath.push(argv.action);
+  }
+
+  // 处理 sandbox session/ray 的 subaction 位置参数
+  if (argv.subaction && typeof argv.subaction === 'string') {
+    commandPath.push(argv.subaction);
+  }
+
+  return commandPath;
+}
+
+/**
+ * 帮助中间件
+ * 在命令执行前检查是否请求帮助，如果是则输出帮助信息并退出
+ *
+ * @param {object} argv - yargs 解析后的参数
+ */
+function helpMiddleware(argv) {
+  // 检查是否请求帮助
+  if (argv.help || argv.h) {
+    helpShown = true;
+    const commandPath = buildCommandPath(argv);
+    const helpText = renderHelp(commandPath);
+    console.log(helpText);
+
+    // 直接使用 gracefulExit 并立即退出
+    // 虽然这会导致进程在 AES 上报完成前退出，但测试已验证日志会被记录
+    // 而且帮助信息本身是成功的操作，不需要等待上报
+    gracefulExit(0);
+
+    // 立即退出，避免 yargs 继续执行并报错
+    // 注意：这里用 process.exit(0) 而不是等待 gracefulExit 的 setTimeout
+    process.exit(0);
+  }
+}
+
+/**
+ * 检查是否已显示帮助信息
+ */
+function isHelpShown() {
+  return helpShown;
+}
+
+module.exports = {
+  helpMiddleware,
+  buildCommandPath,
+  isHelpShown
+};