opencode-diff-viewer 1.0.1 → 1.0.4

package/README.md

@@ -12,26 +12,69 @@
 - 🔧 **智能终端适配** - 自动检测操作系统，打开新终端窗口展示 diff
 - 🤖 **LLM 工具集成** - LLM 可自动调用 `view_diff` 工具
 
-## 安装
+## 前置条件
+
+### 1. 安装 lumen
+
+插件会自动尝试安装 lumen，如果自动安装失败，需要手动安装：
+
+**macOS / Linux (Homebrew)**:
+```bash
+brew install jnsahaj/lumen/lumen
+```
+
+**macOS / Linux (Bun)**:
+```bash
+bun install jnsahaj/lumen/lumen
+```
+
+**Cargo (Rust)**:
+```bash
+cargo install lumen
+```
+
+**Windows**:
+下载 [lumen releases](https://github.com/jnsahaj/lumen/releases) 并添加到 PATH
+
+### 2. Git 仓库
+
+确保项目是 git 仓库，并且有修改的文件：
+```bash
+git status  # 查看修改的文件
+```
+
+## 安装（全局配置）
 
 ### 1. 安装 npm 包
 
 ```bash
-npm install opencode-diff-viewer
-# 或
-pnpm add opencode-diff-viewer
-# 或
-yarn add opencode-diff-viewer
+# npm
+npm install -g opencode-diff-viewer
+
+# pnpm
+pnpm add -g opencode-diff-viewer
+
+# bun
+bun add -g opencode-diff-viewer
 ```
 
-### 2. 配置 opencode.json
+### 2. 配置全局 opencode.json
 
-在项目的 `opencode.json` 中添加插件：
+创建或编辑 `~/.config/opencode/opencode.json`：
 
-```json
+```bash
+mkdir -p ~/.config/opencode
+cat > ~/.config/opencode/opencode.json << 'EOF'
 {
+  "command": {
+    "diff": {
+      "template": "View git diff using lumen TUI.",
+      "description": "View diff of modified files using lumen TUI"
+    }
+  },
   "plugin": ["opencode-diff-viewer"]
 }
+EOF
 ```
 
 ### 3. 重启 OpenCode
@@ -47,7 +90,6 @@ yarn add opencode-diff-viewer
 ```bash
 /diff              # 查看所有修改文件的 diff
 /diff src/app.ts   # 查看指定文件的 diff
-/diff src/         # 查看目录下所有文件的 diff
 ```
 
 ### 通过 LLM
@@ -66,32 +108,6 @@ LLM 可以自动调用 `view_diff` 工具来展示代码变更。无需手动操
 | `e` | 在编辑器中打开文件 |
 | `q` | 退出 |
 
-## 前置条件
-
-### lumen 安装
-
-插件会自动尝试安装 lumen，如果自动安装失败，需要手动安装：
-
-**macOS / Linux (Homebrew)**:
-```bash
-brew install jnsahaj/lumen/lumen
-```
-
-**Cargo (Rust)**:
-```bash
-cargo install lumen
-```
-
-**Windows**:
-下载 [lumen releases](https://github.com/jnsahaj/lumen/releases) 并添加到 PATH
-
-### Git 仓库
-
-确保项目是 git 仓库，并且有修改的文件：
-```bash
-git status  # 查看修改的文件
-```
-
 ## 故障排除
 
 ### 1. lumen 未安装
@@ -119,6 +135,26 @@ git add .
 - macOS: Terminal.app
 - Linux: gnome-terminal 或 xterm
 
+### 4. 插件未加载
+
+检查全局配置文件是否正确：
+```bash
+cat ~/.config/opencode/opencode.json
+```
+
+确保配置正确，包含 `command` 和 `plugin` 两部分：
+```json
+{
+  "command": {
+    "diff": {
+      "template": "View git diff using lumen TUI.",
+      "description": "View diff of modified files using lumen TUI"
+    }
+  },
+  "plugin": ["opencode-diff-viewer"]
+}
+```
+
 ## 工作原理
 
 1. **检测修改文件** - 插件使用 `git diff` 获取已暂存和未暂存的修改
@@ -132,7 +168,7 @@ opencode-diff-viewer/
 ├── src/
 │   ├── index.ts           # 插件主逻辑
 │   └── command-diff.md    # /diff 命令定义
-├── dist/                  # 编译输出
+├── dist/                  # 编译输出（发布用）
 ├── package.json           # npm 配置
 └── tsconfig.json          # TypeScript 配置
 ```
@@ -148,6 +184,10 @@ cd opencode-diff-viewer
 
 # 安装依赖
 npm install
+# 或
+pnpm install
+# 或
+bun install
 
 # 构建
 npm run build
@@ -155,8 +195,8 @@ npm run build
 # 链接本地包
 npm link
 
-# 在测试项目中
-npm link opencode-diff-viewer
+# 在全局使用
+npm link -g opencode-diff-viewer
 ```
 
 ### 发布新版本

package/dist/index.js

@@ -66,7 +66,7 @@ export const DiffViewerPlugin = async ({ project, client, $, directory, worktree
         }
         return { installed: false, message: `❌ ${result.error}` };
     };
-    const initResult = await ensureLumenInstalled();
+    await ensureLumenInstalled();
     const getModifiedFiles = async () => {
         try {
             const unstaged = await $ `git diff --name-only`.text();
@@ -81,41 +81,38 @@ export const DiffViewerPlugin = async ({ project, client, $, directory, worktree
             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.";
+        if (!await isLumenInstalled()) {
+            return "❌ lumen is not installed.\n\nTo install:\n  brew install jnsahaj/lumen/lumen\n  # or\n  cargo install lumen";
         }
         const modifiedFiles = files && files.length > 0 ? files : await getModifiedFiles();
         if (modifiedFiles.length === 0) {
-            return "📝 No modified files to show diff for.";
+            return "📝 No modified files to show diff for.\n\nRun `git add .` to stage changes first.";
         }
+        const platform = process.platform;
+        const fileArgs = modifiedFiles.map(f => `"${f}"`).join(' ');
+        const cmd = `cd "${directory}" && lumen diff ${fileArgs}`;
         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):
+            if (platform === 'darwin') {
+                await $ `osascript -e 'tell application "Terminal" to do script "${cmd}; exit"'`;
+            }
+            else if (platform === 'linux') {
+                try {
+                    await $ `which gnome-terminal && gnome-terminal -- bash -c "${cmd}; read -p 'Press Enter to close...'" `;
+                }
+                catch {
+                    try {
+                        await $ `which xterm && xterm -e "bash -c '${cmd}; read -p Press Enter to close...'" `;
+                    }
+                    catch {
+                        return `❌ No terminal emulator found (gnome-terminal/xterm).\n\nPlease run manually:\n  ${cmd}`;
+                    }
+                }
+            }
+            else {
+                await $ `${cmd}`;
+            }
+            return `✅ Opened lumen diff viewer for ${modifiedFiles.length} file(s):
 ${modifiedFiles.map(f => `  • ${f}`).join('\n')}
 
 Keybindings:
@@ -124,7 +121,7 @@ Keybindings:
   q: Quit`;
         }
         catch (error) {
-            return `❌ Failed to launch diff viewer: ${error}`;
+            return `❌ Failed to launch diff viewer: ${error}\n\nTry running manually:\n  ${cmd}`;
         }
     };
     return {

package/package.json

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