opencode-diff-viewer 1.0.6 → 1.0.8

package/README.md

@@ -3,39 +3,38 @@
 [![npm version](https://img.shields.io/npm/v/opencode-diff-viewer.svg)](https://www.npmjs.com/package/opencode-diff-viewer)
 [![npm downloads](https://img.shields.io/npm/dm/opencode-diff-viewer.svg)](https://www.npmjs.com/package/opencode-diff-viewer)
 
-一个 OpenCode 插件，使用 [delta](https://github.com/dandavison/delta) 提供语法高亮的 git diff 查看功能。
+一个 OpenCode 插件，使用 [lumen](https://github.com/jnsahaj/lumen) + [tmux](https://github.com/tmux/tmux) 提供美观的 TUI diff 查看功能。
 
 ## 功能特性
 
-- ✨ **自动安装 delta** - 插件会自动检测并安装 delta 依赖
+- ✨ **自动安装 tmux 和 lumen** - 插件会自动检测并安装依赖
 - 🚀 **一键查看 diff** - 使用 `/diff` 命令快速查看代码变更
-- 🎨 **语法高亮** - 支持多种编程语言的语法高亮
+- 🔧 **tmux 集成** - 在后台 tmux 会话中运行 lumen
 - 🤖 **LLM 工具集成** - LLM 可自动调用 `view_diff` 工具
 
 ## 前置条件
 
-### 1. 安装 delta
+### 自动安装
 
-插件会自动尝试安装 delta，如果自动安装失败，需要手动安装：
+插件会在启动时自动检查并安装以下依赖：
 
-**macOS / Linux (Homebrew)**:
-```bash
-brew install dandavison/delta/delta
-```
+1. **tmux** - 终端复用器
+2. **lumen** - TUI diff 查看器
+
+### 手动安装（如果自动安装失败）
 
-**Cargo (Rust)**:
+**tmux**:
 ```bash
-cargo install delta
+brew install tmux
+# or
+apt install tmux
 ```
 
-**Windows**:
-下载 [delta releases](https://github.com/dandavison/delta/releases) 并添加到 PATH
-
-### 2. Git 仓库
-
-确保项目是 git 仓库，并且有修改的文件：
+**lumen**:
 ```bash
-git status  # 查看修改的文件
+brew install jnsahaj/lumen/lumen
+# or
+cargo install lumen
 ```
 
 ## 安装（全局配置）
@@ -63,8 +62,8 @@ cat > ~/.config/opencode/opencode.json << 'EOF'
 {
   "command": {
     "diff": {
-      "template": "View git diff with syntax highlighting.",
-      "description": "Show git diff with syntax highlighting"
+      "template": "View git diff using lumen in tmux.",
+      "description": "View diff of modified files using lumen TUI"
     }
   },
   "plugin": ["opencode-diff-viewer"]
@@ -91,27 +90,46 @@ EOF
 
 LLM 可以自动调用 `view_diff` 工具来展示代码变更。无需手动操作，LLM 会根据对话上下文智能判断何时需要展示 diff。
 
-## delta 快捷键
+### 查看 lumen
+
+执行 `/diff` 后，lumen 会在 tmux 会话中运行。要查看 lumen：
 
-在 diff 输出中：
+```bash
+tmux attach -t opencode-diff-viewer
+```
+
+**tmux 快捷键**:
+- `Ctrl+B` 然后 `D` - 分离会话（回到 OpenCode）
+- `Ctrl+B` 然后 `?` - 查看所有快捷键
 
+**lumen 快捷键**:
 | 快捷键 | 功能 |
 |--------|------|
-| `n` / `p` | 下/上一个变更 |
-| `N` / `P` | 下/上一个文件 |
-| `q` | 退出（如果启用 pager） |
+| `j` / `k` 或 `↑` / `↓` | 上/下移动 |
+| `{` / `}` | 跳转到上/下一个变更块 |
+| `Tab` | 切换侧边栏 |
+| `e` | 在编辑器中打开文件 |
+| `q` | 退出 |
 
 ## 故障排除
 
-### 1. delta 未安装
+### 1. tmux 未安装
+
+```
+❌ tmux is not installed
+```
+
+**解决方案**: 手动安装 tmux（见上方手动安装）
+
+### 2. lumen 未安装
 
 ```
-❌ delta is not installed
+❌ lumen is not installed
 ```
 
-**解决方案**: 手动安装 delta（见上方前置条件）
+**解决方案**: 手动安装 lumen（见上方手动安装）
 
-### 2. 没有修改的文件
+### 3. 没有修改的文件
 
 ```
 📝 No modified files
@@ -122,31 +140,19 @@ LLM 可以自动调用 `view_diff` 工具来展示代码变更。无需手动操
 git add .
 ```
 
-### 3. 插件未加载
+### 4. 插件未加载
 
 检查全局配置文件是否正确：
 ```bash
 cat ~/.config/opencode/opencode.json
 ```
 
-确保配置正确：
-```json
-{
-  "command": {
-    "diff": {
-      "template": "View git diff with syntax highlighting.",
-      "description": "Show git diff with syntax highlighting"
-    }
-  },
-  "plugin": ["opencode-diff-viewer"]
-}
-```
-
 ## 工作原理
 
-1. **检测修改文件** - 插件使用 `git diff` 获取已暂存和未暂存的修改
-2. **格式化输出** - 通过 `delta` 管道输出，带语法高亮
-3. **自动安装** - 插件启动时检查 delta，未安装则自动安装
+1. **检测依赖** - 插件启动时检查 tmux 和 lumen
+2. **自动安装** - 如果未安装，自动通过 brew 或 cargo 安装
+3. **创建 tmux 会话** - 执行 `/diff` 时创建后台 tmux 会话
+4. **运行 lumen** - 在 tmux 会话中运行 lumen diff
 
 ## 项目结构
 
@@ -171,18 +177,11 @@ cd opencode-diff-viewer
 
 # 安装依赖
 npm install
-# 或
-pnpm install
-# 或
-bun install
 
 # 构建
 npm run build
 
 # 链接本地包
-npm link
-
-# 在全局使用
 npm link -g opencode-diff-viewer
 ```
 
@@ -200,7 +199,8 @@ npm publish
 
 ## 依赖
 
-- [delta](https://github.com/dandavison/delta) - 语法高亮的 git diff 查看器
+- [tmux](https://github.com/tmux/tmux) - 终端复用器
+- [lumen](https://github.com/jnsahaj/lumen) - TUI Diff 查看器
 - [@opencode-ai/plugin](https://www.npmjs.com/package/@opencode-ai/plugin) - OpenCode 插件 SDK
 
 ## License

package/dist/index.js

@@ -1,8 +1,17 @@
 import { tool } from "@opencode-ai/plugin";
 export const DiffViewerPlugin = async ({ project, client, $, directory, worktree }) => {
-    const isDeltaInstalled = async () => {
+    const isLumenInstalled = async () => {
         try {
-            await $ `which delta`;
+            await $ `which lumen`;
+            return true;
+        }
+        catch {
+            return false;
+        }
+    };
+    const isTmuxInstalled = async () => {
+        try {
+            await $ `which tmux`;
             return true;
         }
         catch {
@@ -27,10 +36,10 @@ export const DiffViewerPlugin = async ({ project, client, $, directory, worktree
             return false;
         }
     };
-    const installDelta = async () => {
+    const installLumen = async () => {
         if (await isBrewInstalled()) {
             try {
-                await $ `brew install delta`;
+                await $ `brew install jnsahaj/lumen/lumen`;
                 return { success: true, method: "brew" };
             }
             catch (e) {
@@ -39,7 +48,7 @@ export const DiffViewerPlugin = async ({ project, client, $, directory, worktree
         }
         if (await isCargoInstalled()) {
             try {
-                await $ `cargo install delta`;
+                await $ `cargo install lumen`;
                 return { success: true, method: "cargo" };
             }
             catch (e) {
@@ -48,20 +57,53 @@ export const DiffViewerPlugin = async ({ project, client, $, directory, worktree
         }
         return {
             success: false,
-            error: "Neither brew nor cargo available. Please install delta manually:\n  brew install dandavison/delta/delta\n  # or\n  cargo install delta"
+            error: "Neither brew nor cargo available. Please install lumen manually:\n  brew install jnsahaj/lumen/lumen\n  # or\n  cargo install lumen"
+        };
+    };
+    const installTmux = async () => {
+        if (await isBrewInstalled()) {
+            try {
+                await $ `brew install tmux`;
+                return { success: true, method: "brew" };
+            }
+            catch (e) {
+                console.warn(`brew install tmux failed: ${e}`);
+            }
+        }
+        return {
+            success: false,
+            error: "Please install tmux manually:\n  brew install tmux\n  # or\n  apt install tmux"
         };
     };
-    const ensureDeltaInstalled = async () => {
-        if (await isDeltaInstalled()) {
+    const ensureLumenInstalled = async () => {
+        if (await isLumenInstalled()) {
             return { installed: true };
         }
-        const result = await installDelta();
+        const result = await installLumen();
         if (result.success) {
-            return { installed: true, message: `✅ delta installed via ${result.method}` };
+            return { installed: true, message: `✅ lumen installed via ${result.method}` };
         }
         return { installed: false, message: `❌ ${result.error}` };
     };
-    await ensureDeltaInstalled();
+    const ensureTmuxInstalled = async () => {
+        if (await isTmuxInstalled()) {
+            return { installed: true };
+        }
+        const result = await installTmux();
+        if (result.success) {
+            return { installed: true, message: `✅ tmux installed via ${result.method}` };
+        }
+        return { installed: false, message: `❌ ${result.error}` };
+    };
+    // Check and install dependencies on startup
+    const tmuxCheck = await ensureTmuxInstalled();
+    if (!tmuxCheck.installed) {
+        console.warn(tmuxCheck.message);
+    }
+    const lumenCheck = await ensureLumenInstalled();
+    if (!lumenCheck.installed) {
+        console.warn(lumenCheck.message);
+    }
     const getModifiedFiles = async () => {
         try {
             const unstaged = await $ `git diff --name-only`.text();
@@ -76,14 +118,26 @@ export const DiffViewerPlugin = async ({ project, client, $, directory, worktree
             return [];
         }
     };
-    const showDiff = async (files) => {
-        if (!await isDeltaInstalled()) {
-            return `❌ delta is not installed.
+    const launchDiffViewer = async (files) => {
+        // Check tmux
+        if (!await isTmuxInstalled()) {
+            return `❌ tmux is not installed.
 
 To install:
-  brew install dandavison/delta/delta
+  brew install tmux
   # or
-  cargo install delta
+  apt install tmux
+
+Then restart OpenCode.`;
+        }
+        // Check lumen
+        if (!await isLumenInstalled()) {
+            return `❌ lumen is not installed.
+
+To install:
+  brew install jnsahaj/lumen/lumen
+  # or
+  cargo install lumen
 
 Then restart OpenCode.`;
         }
@@ -91,30 +145,28 @@ Then restart OpenCode.`;
         if (modifiedFiles.length === 0) {
             return "📝 No modified files.\n\nRun \`git add .\` to stage changes first.";
         }
+        const fileList = modifiedFiles.map(f => `  • ${f}`).join('\n');
+        const fileArgs = modifiedFiles.map(f => `"${f}"`).join(' ');
+        const sessionName = "opencode-diff-viewer";
+        const cmd = `cd "${directory}" && lumen diff ${fileArgs}`;
         try {
-            // Get diff output with delta
-            let diffOutput = "";
-            // Show staged diff
-            const stagedDiff = await $ `cd "${directory}" && git diff --staged`.text();
-            if (stagedDiff.trim()) {
-                diffOutput += "=== STAGED CHANGES ===\n\n";
-                diffOutput += await $ `cd "${directory}" && git diff --staged | delta --pager=never`.text();
-            }
-            // Show unstaged diff
-            const unstagedDiff = await $ `cd "${directory}" && git diff`.text();
-            if (unstagedDiff.trim()) {
-                if (diffOutput)
-                    diffOutput += "\n=== UNSTAGED CHANGES ===\n\n";
-                diffOutput += await $ `cd "${directory}" && git diff | delta --pager=never`.text();
-            }
-            if (!diffOutput.trim()) {
-                return "📝 No changes to show.";
-            }
-            const fileList = modifiedFiles.map(f => `  • ${f}`).join('\n');
-            return `✅ Modified files (${modifiedFiles.length}):\n${fileList}\n\n${diffOutput}`;
+            // Kill existing session if it exists
+            await $ `tmux kill-session -t "${sessionName}" 2>/dev/null || true`;
+            // Create new tmux session
+            await $ `tmux new-session -d -s "${sessionName}" "${cmd}"`;
+            return `✅ Opened lumen in tmux session "${sessionName}":\n${fileList}\n\nTo use lumen:
+  1. Run: tmux attach -t "${sessionName}"
+  2. Navigate: j/k or arrows, {/} for hunks
+  3. Detach: Ctrl+B then D
+
+Keybindings:
+  j/k or ↑/↓: Navigate    {/}: Jump hunks
+  tab: Sidebar           e: Edit file
+  q: Quit`;
         }
         catch (e) {
-            return `❌ Error showing diff: ${e.message || e}`;
+            return `❌ Failed to launch tmux session: ${e.message || e}\n\nTry manually:
+  tmux new-session -s "${sessionName}" "${cmd}"`;
         }
     };
     return {
@@ -122,7 +174,7 @@ Then restart OpenCode.`;
             if (input.command === "diff") {
                 const files = input.args?.trim() ? [input.args.trim()] : undefined;
                 output.handled = true;
-                output.result = await showDiff(files);
+                output.result = await launchDiffViewer(files);
             }
         },
         "file.edited": async ({ event }) => {
@@ -130,12 +182,12 @@ Then restart OpenCode.`;
         },
         tool: {
             view_diff: tool({
-                description: "Show git diff with syntax highlighting using delta.",
+                description: "Open the lumen diff viewer in a tmux session.",
                 args: {
                     file: tool.schema.string().optional().describe("Optional: specific file path"),
                 },
                 async execute(args, ctx) {
-                    return await showDiff(args.file ? [args.file] : undefined);
+                    return await launchDiffViewer(args.file ? [args.file] : undefined);
                 },
             }),
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-diff-viewer",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "OpenCode plugin for viewing git diffs using lumen TUI",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",