opencode-diff-viewer 1.0.0

package/README.md

@@ -0,0 +1,97 @@
+# OpenCode Diff Viewer Plugin
+
+一个 OpenCode 插件，使用 [lumen](https://github.com/jnsahaj/lumen) 提供美观的 TUI diff 查看功能。
+
+## 功能
+
+- `/diff` 命令查看所有修改的文件
+- `/diff <file>` 命令查看指定文件的 diff
+- LLM 可调用的 `view_diff` 工具
+- 自动安装 lumen（如果未安装）
+- 自动在新终端窗口中打开
+
+## 安装
+
+### 方式一：npm 安装（推荐）
+
+```bash
+npm install opencode-diff-viewer
+# 或
+pnpm add opencode-diff-viewer
+# 或
+yarn add opencode-diff-viewer
+```
+
+然后在 `opencode.json` 中添加插件：
+
+```json
+{
+  "plugin": ["opencode-diff-viewer"]
+}
+```
+
+### 方式二：本地开发
+
+将插件复制到你的项目：
+
+```bash
+# 复制插件文件
+cp -r node_modules/opencode-diff-viewer/dist .opencode/plugin/diff-viewer
+cp node_modules/opencode-diff-viewer/command-diff.md .opencode/command/diff.md
+
+# 或使用 npm link
+npm link opencode-diff-viewer
+```
+
+## 前置条件
+
+插件会自动安装 lumen。如果自动安装失败，需要手动安装：
+
+```bash
+# macOS / Linux (Homebrew)
+brew install jnsahaj/lumen/lumen
+
+# 或使用 Cargo (Rust)
+cargo install lumen
+```
+
+## 使用方法
+
+### 通过 / 命令
+
+在 OpenCode TUI 中输入：
+
+```
+/diff          # 查看所有修改文件的 diff
+/diff src/app.ts   # 查看指定文件的 diff
+```
+
+### 通过 LLM 工具调用
+
+LLM 可以自动调用 `view_diff` 工具来展示代码变更。
+
+## lumen 快捷键
+
+在 lumen diff 查看器中：
+
+| 快捷键 | 功能 |
+|--------|------|
+| `j/k` 或 `↑/↓` | 导航 |
+| `{` / `}` | 跳转到上/下一个 hunk |
+| `Tab` | 切换侧边栏 |
+| `e` | 在编辑器中打开文件 |
+| `q` | 退出 |
+
+## 发布到 npm
+
+```bash
+# 登录 npm
+npm login
+
+# 发布包
+npm publish
+
+# 发布新版本
+npm version patch|minor|major
+npm publish
+```

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import type { Plugin } from "@opencode-ai/plugin";
+/**
+ * OpenCode Diff Viewer Plugin
+ * Uses lumen (https://github.com/jnsahaj/lumen) for visual git diffs.
+ * Automatically installs lumen if not present.
+ */
+export declare const DiffViewerPlugin: Plugin;

package/dist/index.js

@@ -0,0 +1,153 @@
+import { tool } from "@opencode-ai/plugin";
+/**
+ * OpenCode Diff Viewer Plugin
+ * Uses lumen (https://github.com/jnsahaj/lumen) for visual git diffs.
+ * Automatically installs lumen if not present.
+ */
+export const DiffViewerPlugin = async ({ project, client, $, directory, worktree }) => {
+    const isLumenInstalled = async () => {
+        try {
+            await $ `which lumen`;
+            return true;
+        }
+        catch {
+            return false;
+        }
+    };
+    const isBrewInstalled = async () => {
+        try {
+            await $ `which brew`;
+            return true;
+        }
+        catch {
+            return false;
+        }
+    };
+    const isCargoInstalled = async () => {
+        try {
+            await $ `which cargo`;
+            return true;
+        }
+        catch {
+            return false;
+        }
+    };
+    const installLumen = async () => {
+        if (await isBrewInstalled()) {
+            try {
+                await $ `brew install jnsahaj/lumen/lumen`;
+                return { success: true, method: "brew" };
+            }
+            catch (e) {
+                console.warn(`brew install failed: ${e}`);
+            }
+        }
+        if (await isCargoInstalled()) {
+            try {
+                await $ `cargo install lumen`;
+                return { success: true, method: "cargo" };
+            }
+            catch (e) {
+                console.warn(`cargo install failed: ${e}`);
+            }
+        }
+        return {
+            success: false,
+            error: "Neither brew nor cargo available. Please install lumen manually:\n  brew install jnsahaj/lumen/lumen\n  # or\n  cargo install lumen"
+        };
+    };
+    const ensureLumenInstalled = async () => {
+        if (await isLumenInstalled()) {
+            return { installed: true };
+        }
+        const result = await installLumen();
+        if (result.success) {
+            return { installed: true, message: `✅ lumen installed via ${result.method}` };
+        }
+        return { installed: false, message: `❌ ${result.error}` };
+    };
+    const initResult = await ensureLumenInstalled();
+    const getModifiedFiles = async () => {
+        try {
+            const unstaged = await $ `git diff --name-only`.text();
+            const staged = await $ `git diff --staged --name-only`.text();
+            const files = new Set([
+                ...unstaged.trim().split('\n').filter(Boolean),
+                ...staged.trim().split('\n').filter(Boolean)
+            ]);
+            return Array.from(files);
+        }
+        catch {
+            return [];
+        }
+    };
+    const openDiffInNewTerminal = async (fileArgs) => {
+        const platform = process.platform;
+        if (platform === 'darwin') {
+            await $ `osascript -e 'tell application "Terminal" to do script "cd ${directory} && lumen diff ${fileArgs}; exit"'`;
+            return;
+        }
+        if (platform === 'linux') {
+            try {
+                await $ `which gnome-terminal && gnome-terminal -- bash -c "cd ${directory} && lumen diff ${fileArgs}; read -p 'Press Enter to close...'"`;
+                return;
+            }
+            catch {
+                try {
+                    await $ `which xterm && xterm -e "cd ${directory} && lumen diff ${fileArgs}; read -p 'Press Enter to close...'"`;
+                    return;
+                }
+                catch { }
+            }
+        }
+        await $ `lumen diff ${fileArgs}`;
+    };
+    const launchDiffViewer = async (files) => {
+        const lumenCheck = await ensureLumenInstalled();
+        if (!lumenCheck.installed) {
+            return lumenCheck.message || "❌ lumen is not installed and auto-install failed.";
+        }
+        const modifiedFiles = files && files.length > 0 ? files : await getModifiedFiles();
+        if (modifiedFiles.length === 0) {
+            return "📝 No modified files to show diff for.";
+        }
+        try {
+            const fileArgs = modifiedFiles.map(f => `--file "${f}"`).join(' ');
+            await openDiffInNewTerminal(fileArgs);
+            const prefix = lumenCheck.message ? `${lumenCheck.message}\n\n` : "";
+            return `${prefix}✅ Opened lumen diff viewer for ${modifiedFiles.length} file(s):
+${modifiedFiles.map(f => `  • ${f}`).join('\n')}
+
+Keybindings:
+  j/k or ↑/↓: Navigate    {/}: Jump between hunks
+  tab: Toggle sidebar     e: Open in editor
+  q: Quit`;
+        }
+        catch (error) {
+            return `❌ Failed to launch diff viewer: ${error}`;
+        }
+    };
+    return {
+        "tui.command.execute": async (input, output) => {
+            if (input.command === "diff") {
+                const files = input.args?.trim() ? [input.args.trim()] : undefined;
+                output.handled = true;
+                output.result = await launchDiffViewer(files);
+            }
+        },
+        "file.edited": async ({ event }) => {
+            console.log(`File edited: ${event.path}`);
+        },
+        tool: {
+            view_diff: tool({
+                description: "Open the lumen diff viewer to show git diff for modified files. Use this when the user wants to see visual diffs of their changes.",
+                args: {
+                    file: tool.schema.string().optional().describe("Optional: specific file path to show diff for. If not provided, shows all modified files."),
+                },
+                async execute(args, ctx) {
+                    return await launchDiffViewer(args.file ? [args.file] : undefined);
+                },
+            }),
+        },
+    };
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "opencode-diff-viewer",
+  "version": "1.0.0",
+  "description": "OpenCode plugin for viewing git diffs using lumen TUI",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/",
+    "command-diff.md"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "diff",
+    "lumen",
+    "git"
+  ],
+  "author": "",
+  "license": "MIT",
+  "peerDependencies": {
+    "@opencode-ai/plugin": "^1.0.0"
+  },
+  "devDependencies": {
+    "@opencode-ai/plugin": "^1.0.0",
+    "@types/node": "^25.0.3",
+    "typescript": "^5.0.0"
+  }
+}