opencode-prompt-recorder 1.0.0

package/README.md

@@ -0,0 +1,116 @@
+# opencode-prompt-recorder
+
+一个用于记录用户提示词的 OpenCode 插件。自动将用户消息保存到本地文件系统，并按目录结构组织。
+
+## 功能特性
+
+- ✨ 自动捕获聊天对话中的用户提示词
+- 📁 有组织的文件存储：`.agent/prompts/yyyy/MM/dd/` 目录结构
+- 🏷️ 基于会话的组织：每个对话会话单独跟踪
+- 📝 丰富的元数据：包含时间戳、会话 ID 和提示词主题
+- 🔄 会话持久化：追加到现有文件以继续对话
+- 🛡️ 安全的文件名处理：清理文件名以防止文件系统错误
+
+## 安装
+
+```bash
+npm install -g opencode-prompt-recorder
+# 或
+bun add -g opencode-prompt-recorder
+```
+
+## 使用方法
+
+将插件添加到你的 `opencode.json`：
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["opencode-prompt-recorder"],
+}
+```
+
+## 工作原理
+
+1. 插件监听 OpenCode 聊天事件（`chat.message`）
+2. 每次用户消息时，提取提示词文本和会话 ID
+3. 提示词保存到 `.agent/prompts/` 目录，按日期组织
+4. 每个提示词保存为带有时间戳和会话信息的 markdown 文件
+
+## 文件结构
+
+插件创建有组织的目录结构：
+
+```
+.agent/
+└── prompts/
+    └── 2026/
+        └── 02/
+            └── 22/
+                ├── 1005-abc123-什么是AI.md
+                ├── 1050-def456-如何编程.md
+                └── 1120-ghi789-复制README.md
+```
+
+## 文件格式
+
+每个提示词文件遵循以下格式：
+
+```markdown
+============ 10:05 ============
+
+什么是 AI？
+
+---
+
+============ 10:50 ============
+
+如何编写 hello world 程序？
+```
+
+## 配置
+
+无需额外配置。插件将自动：
+
+- 保存到项目根目录的 `.agent/prompts/` 目录
+- 使用当前工作目录作为基础路径
+- 根据需要创建目录
+
+## 会话管理
+
+- 每个唯一的 `sessionId` 获得自己的文件
+- 相同的会话 ID 追加到现有文件
+- 不同的会话 ID 创建新文件
+- 会话 ID 来自 `chat.message` 事件输入
+
+## 使用场景
+
+- ✅ LLM 交互的审计跟踪
+- ✅ 训练数据收集和标注
+- ✅ 会话历史和对话回放
+- ✅ 质量保证和监控
+- ✅ 研发洞察
+
+## 依赖要求
+
+- OpenCode v0.15.0 或更高版本
+- Node.js 或 Bun 运行时
+- 项目目录的文件系统写入权限
+
+## 故障排除
+
+### 提示词未被记录
+
+- 确保插件已列入 `opencode.json` 配置
+- 检查项目目录的写入权限
+- 验证 `.agent/prompts/` 目录正在创建
+
+### 文件名包含特殊字符
+
+- 插件会自动清理文件名，移除非法字符
+- 文件名截断至最多 50 个字符
+- 如果提示词过长，文件名只使用前 50 个字符
+
+## 许可证
+
+MIT

package/dist/index.js

@@ -0,0 +1,72 @@
+// index.ts
+import { mkdir, appendFile, readdir } from "fs/promises";
+import { join } from "path";
+function sanitizeFilename(str) {
+  return str.replace(/[<>:"/\\|?*\x00-\x1f]/g, "").substring(0, 50).trim();
+}
+function formatDate(date) {
+  const yyyy = date.getFullYear().toString();
+  const MM = String(date.getMonth() + 1).padStart(2, "0");
+  const dd = String(date.getDate()).padStart(2, "0");
+  const HH = String(date.getHours()).padStart(2, "0");
+  const mm = String(date.getMinutes()).padStart(2, "0");
+  return { yyyy, MM, dd, HH, mm };
+}
+function formatTime(date) {
+  return `${date.getHours().toString().padStart(2, "0")}:${date.getMinutes().toString().padStart(2, "0")}`;
+}
+async function findExistingFile(promptDir, sessionId) {
+  if (!sessionId)
+    return null;
+  const files = await readdir(promptDir);
+  for (const file of files) {
+    if (file.includes(`-${sessionId}-`)) {
+      return join(promptDir, file);
+    }
+  }
+  return null;
+}
+var OpenCodePromptRecorder = async ({ directory, client }) => {
+  let lastUserMessage = "";
+  return {
+    "chat.message": async (input, output) => {
+      if (output.message.role === "user") {
+        const text = output.parts.map((p) => p.type === "text" ? p.text : "").join("");
+        const sessionId = input.sessionID;
+        if (!sessionId) {
+          return;
+        }
+        if (text && text !== lastUserMessage) {
+          const { yyyy, MM, dd, HH, mm } = formatDate(new Date);
+          const topic = sanitizeFilename(text);
+          const promptDir = join(directory, ".agent", "prompts", yyyy, MM, dd);
+          await mkdir(promptDir, { recursive: true });
+          const existingFile = await findExistingFile(promptDir, sessionId);
+          const time = formatTime(new Date);
+          const timeTitle = `============ ${time} ============`;
+          const content = existingFile ? `
+---
+
+${timeTitle}
+
+${text}` : `${timeTitle}
+
+${text}`;
+          if (existingFile) {
+            await appendFile(existingFile, content);
+          } else {
+            const filename = `${HH}${mm}-${sessionId}-${topic}.md`;
+            const filepath = join(promptDir, filename);
+            await appendFile(filepath, content);
+          }
+          lastUserMessage = text;
+        }
+      }
+    }
+  };
+};
+var opencode_prompt_recorder_default = OpenCodePromptRecorder;
+export {
+  opencode_prompt_recorder_default as default,
+  OpenCodePromptRecorder
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "opencode-prompt-recorder",
+  "version": "1.0.0",
+  "description": "OpenCode plugin for recording user prompts. Automatically saves user messages to a local file system with organized directory structure.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bun build index.ts --outdir dist --target node",
+    "prepublishOnly": "bun run build",
+    "test": "bun test"
+  },
+  "keywords": [
+    "opencode",
+    "prompt",
+    "recording",
+    "logging",
+    "plugin",
+    "llm",
+    "ai",
+    "audit"
+  ],
+  "author": "anarckk",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anarckk/opencode-prompt-recorder.git"
+  },
+  "bugs": {
+    "url": "https://github.com/anarckk/opencode-prompt-recorder/issues"
+  },
+  "homepage": "https://github.com/anarckk/opencode-prompt-recorder#readme",
+  "peerDependencies": {
+    "@opencode-ai/plugin": ">=0.15.0",
+    "typescript": ">=5.0.0"
+  },
+  "devDependencies": {
+    "@opencode-ai/plugin": "^0.15.0",
+    "@types/bun": "^1.3.1",
+    "typescript": "^5.9.3"
+  }
+}